NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Shopify

shopify

Shopify is an e-commerce platform enabling merchants to create online stores, manage products, and process payments with themes, apps, and integrated marketing tools

EcommerceWeb del proveedor
Acciones
28
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (28)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add product to custom collectionSHOPIFY_ADD_PRODUCT_TO_COLLECTIONAcción

Adds a product to an existing *custom collection*, optionally specifying its `position` if the collection is manually sorted.

Parámetros de entrada

  • positioninteger

    Optional 1-based position if the custom collection is manually sorted; product is added to the end if unspecified or collection isn't manually sorted.

  • product_idintegerObligatorio

    Identifier of the product to add.

  • collection_idintegerObligatorio

    Identifier of the *custom collection*.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Count product imagesSHOPIFY_COUNT_PRODUCT_IMAGESAcción

Retrieves the total count of images for a shopify product, useful for inventory management or display logic; the provided `product id` must exist in the store.

Parámetros de entrada

  • product_idstringObligatorio

    The unique identifier for the Shopify product whose images are to be counted.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a custom collectionSHOPIFY_CREATE_CUSTOM_COLLECTIONAcción

Creates a new custom collection in a shopify store, requiring a unique title for manually curated product groupings (e.g., 'new arrivals', 'seasonal specials').

Parámetros de entrada

  • titlestringObligatorio

    Unique title for the custom collection, visible to customers and used for product organization.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CustomerSHOPIFY_CREATE_CUSTOMERAcción

Tool to create a new customer in shopify. use when you need to add a new customer record to the store.

Parámetros de entrada

  • notestring

    An optional note about the customer.

  • tagsstring

    A comma-separated string of tags to associate with the customer.

  • emailstringObligatorioemail

    The customer's unique email address.

  • phonestring

    The customer's phone number (E.164 format recommended).

  • passwordstring

    The customer's password. If provided, password_confirmation is also required.

  • addressesobject[]

    A list of addresses for the customer.

  • last_namestring

    The customer's last name.

  • first_namestring

    The customer's first name.

  • verified_emailboolean

    Whether the customer has verified their email address.

  • send_email_inviteboolean

    If true, sends the customer an email invite to create an account.

  • send_email_welcomeboolean

    Whether to send the customer a welcome email. Defaults to true. If send_email_invite is true, this can be set to false.

  • password_confirmationstring

    Confirmation of the customer's password. Required if password is provided.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create an orderSHOPIFY_CREATE_ORDERAcción

Creates a new order in shopify, typically requiring line items; if `customer id` is provided, it must correspond to an existing customer.

Parámetros de entrada

  • currencystring

    The three-letter ISO 4217 currency code for the amounts in the order (e.g., USD, CAD, EUR).

  • total_taxnumber

    The total amount of tax for the order. This should be a numeric value representing the sum of all taxes.

  • line_itemsobject[]Obligatorio

    A list of line item objects, each representing an item in the order. Each object should specify at least a `variant_id` (or `product_id`) and `quantity`. Other common fields include `price` and `title`. At least one line item is required.

  • customer_idstring

    The unique identifier of the customer associated with this order. If provided, the order will be linked to this customer. This field is optional.

  • transactionsobject[]

    A list of transaction objects associated with the order, typically representing payment information. Each object usually includes `kind` (e.g., 'sale', 'authorization'), `amount`, `status`, and `gateway`.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a productSHOPIFY_CREATE_PRODUCTAcción

Creates a new product in a shopify store; a product title is generally required.

Parámetros de entrada

  • titlestring

    The title of the product, typically required by Shopify.

  • vendorstring

    The name of the product's vendor or manufacturer.

  • variantsobject[]

    Product variants. Common keys include 'price', 'sku', 'option1', 'option2', 'inventory_quantity'. At least one variant is typically required; if not provided, Shopify might create a default one.

  • body_htmlstring

    A detailed description of the product, which can include HTML formatting for rich text.

  • product_typestring

    A category for the product, used for filtering and organizing products in Shopify.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Product ImageSHOPIFY_CREATE_PRODUCT_IMAGEAcción

Tool to create a new product image for a given product. use when you need to add an image to a product by providing the image source url or attachment.

Parámetros de entrada

  • imageobjectObligatorio

    An object containing the image details.

  • product_idstringObligatorio

    The ID of the product to associate the image with.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete custom collectionSHOPIFY_DELETE_CUSTOM_COLLECTIONAcción

Permanently deletes a custom collection from a shopify store using its `collection id`; this action is irreversible and requires a valid, existing `collection id`.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier for the custom collection that needs to be deleted. This ID is a numerical string assigned by Shopify when the collection is created.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete a productSHOPIFY_DELETE_PRODUCTAcción

Deletes a specific, existing product from a shopify store using its unique product id; this action is irreversible.

Parámetros de entrada

  • idstring

    The unique identifier of the Shopify product to be deleted. This ID is essential for targeting the correct product for removal.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete product imageSHOPIFY_DELETE_PRODUCT_IMAGEAcción

Deletes a specific image from a product in shopify, requiring the `product id` of an existing product and the `image id` of an image currently associated with that product.

Parámetros de entrada

  • image_idstringObligatorio

    The unique identifier of the specific product image to be deleted.

  • product_idstringObligatorio

    The unique identifier of the product from which the image is to be deleted.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All CustomersSHOPIFY_GET_ALL_CUSTOMERSAcción

Retrieves customer records from a shopify store, with options for filtering, selecting specific fields, and paginating through the results.

Parámetros de entrada

  • idsstring[]

    A list of specific customer IDs to retrieve. If empty, all customers (matching other filters) will be retrieved.

  • limitinteger

    The maximum number of customers to retrieve. Defaults to 50, with a maximum value of 250.

  • fieldsstring

    A comma-separated list of customer fields to include in the response (e.g., 'id,email,first_name'). By default, all fields are returned.

  • since_idstring

    Retrieve only customers with an ID greater than this specified ID. This is used for paginating through results.

  • created_at_maxstring

    Filter customers created before or on this date. Format: YYYY-MM-DD or ISO 8601 datetime string (e.g., '2023-10-26T10:00:00-05:00').

  • created_at_minstring

    Filter customers created after or on this date. Format: YYYY-MM-DD or ISO 8601 datetime string (e.g., '2023-10-26T10:00:00-05:00').

  • updated_at_maxstring

    Filter customers last updated before or on this date. Format: YYYY-MM-DD or ISO 8601 datetime string.

  • updated_at_minstring

    Filter customers last updated after or on this date. Format: YYYY-MM-DD or ISO 8601 datetime string.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get collection by IDSHOPIFY_GET_COLLECTION_BY_IDAcción

Retrieves a specific shopify collection by its `collection id`, optionally filtering returned data to specified `fields`.

Parámetros de entrada

  • fieldsstring

    Comma-separated list of fields to retrieve; if omitted, all fields are returned. E.g., 'id,title,handle'.

  • collection_idstringObligatorio

    The unique identifier of the Shopify collection to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get collectsSHOPIFY_GET_COLLECTSAcción

Retrieves a list of collects from a shopify store, where a collect links a product to a custom collection.

Parámetros de entrada

  • limitinteger

    Maximum number of collects to retrieve (1-250).

  • fieldsstring

    Comma-separated list of fields to retrieve (e.g., `id,collection_id,product_id`); if unspecified, all fields are returned.

  • since_idinteger

    Retrieve only collects created after this ID, for pagination.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get collects countSHOPIFY_GET_COLLECTS_COUNTAcción

Retrieves the total count of collects (product-to-collection associations) in a shopify store.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get custom collectionsSHOPIFY_GET_CUSTOM_COLLECTIONSAcción

Retrieves a list of custom collections from a shopify store, optionally filtered by ids, product id, or handle.

Parámetros de entrada

  • idsstring

    A comma-separated string of custom collection IDs to retrieve.

  • limitinteger

    The maximum number of custom collections to return (between 1 and 250).

  • handlestring

    Filter results by the custom collection's unique, human-readable string identifier (e.g., 'summer-specials').

  • product_idinteger

    Filter results to custom collections that contain a specific product ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get custom collections countSHOPIFY_GET_CUSTOM_COLLECTIONS_COUNTAcción

Retrieves the total number of custom collections in a shopify store.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CustomerSHOPIFY_GET_CUSTOMERAcción

Retrieves detailed information for a specific customer from a shopify store, provided their valid and existing `customer id`.

Parámetros de entrada

  • customer_idstringObligatorio

    The unique identifier for the customer in Shopify.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get customer ordersSHOPIFY_GET_CUSTOMER_ORDERSAcción

Retrieves all orders for a specific, existing customer in shopify using their unique customer id.

Parámetros de entrada

  • customer_idstringObligatorio

    Unique identifier for the customer whose orders are to be retrieved.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get order listSHOPIFY_GET_ORDER_LISTAcción

Retrieves a list of orders from shopify using default api settings and filters.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get order by idSHOPIFY_GET_ORDERSBY_IDAcción

Retrieves a specific shopify order by its unique id, which must correspond to an existing order.

Parámetros de entrada

  • fieldsstring

    Comma-separated list of fields to include in the response (e.g., 'id,line_items').

  • order_idstringObligatorio

    The unique identifier of the Shopify order to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get productSHOPIFY_GET_PRODUCTAcción

Retrieves details for an existing shopify product using its unique product id.

Parámetros de entrada

  • product_idstringObligatorio

    The unique identifier of the Shopify product to be retrieved.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get product imageSHOPIFY_GET_PRODUCT_IMAGEAcción

Retrieves detailed information for a specific product image, identified by its id and its associated product id, from a shopify store.

Parámetros de entrada

  • image_idstringObligatorio

    The unique numerical identifier of the image associated with the product.

  • product_idstringObligatorio

    The unique numerical identifier of the Shopify product.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Product ImagesSHOPIFY_GET_PRODUCT_IMAGESAcción

Retrieves all images for a shopify product, specified by its `product id` which must correspond to an existing product.

Parámetros de entrada

  • fieldsstring

    A comma-separated list of fields to include in the response. Available fields include: id, product_id, position, created_at, updated_at, alt, width, height, src.

  • since_idstring

    Restricts the results to product images created after the specified image ID. Useful for pagination.

  • product_idstringObligatorio

    The unique identifier of the Shopify product for which to retrieve images.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get productsSHOPIFY_GET_PRODUCTSAcción

Retrieves a list of products from a shopify store.

Parámetros de entrada

  • idsstring

    A comma-separated string of product IDs to retrieve. If this field is not provided (i.e., defaults to `None`), all products will be fetched.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get products countSHOPIFY_GET_PRODUCTS_COUNTAcción

Retrieves the total, unfiltered count of all products in a shopify store.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get products in collectionSHOPIFY_GET_PRODUCTS_IN_COLLECTIONAcción

Retrieves all products within a specified shopify collection, requiring a valid `collection id`.

Parámetros de entrada

  • limitinteger

    Maximum number of products to retrieve.

  • collection_idstringObligatorio

    Identifier for the Shopify collection. Often found in the collection's Shopify admin URL.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Shop DetailsSHOPIFY_GET_SHOP_DETAILSAcción

Retrieves comprehensive administrative information about the authenticated shopify store, as defined by the shopify api.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update OrderSHOPIFY_UPDATE_ORDERAcción

Updates the phone number for an existing shopify order, identified by its id; pass `phone=none` to remove the current phone number.

Parámetros de entrada

  • idintegerObligatorio

    The unique identifier of the Shopify order whose phone number is to be updated.

  • phonestring

    The new phone number for the order. E.164 format (e.g., '+15551234567') is recommended for international numbers. An empty string `''` may also be used to clear it, depending on Shopify API behavior.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not