Ergonode PIM

https://docs.ergonode.com
Admin
Ergonode is a Product Information Management (PIM) system designed to help users integrate, extend,...
Tokens:102,974
Snippets:1,289
Trust Score:8.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### HTTP GET Request for Documentation Query

Source: https://docs.ergonode.com/graphql/overview/schema/mutations

This example demonstrates how to query the documentation dynamically using an HTTP GET request with the `ask` query parameter. This is useful for retrieving information not explicitly present on the current page.

```http
GET https://docs.ergonode.com/graphql/overview/schema/mutations.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.ergonode.com/graphql/query-examples/list-of-active-languages

To get more information not present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.ergonode.com/graphql/query-examples/list-of-active-languages.md?ask=<question>
```

--------------------------------

### Example GET /configuration Response

Source: https://docs.ergonode.com/apps2/detailed-reference/configuration

Illustrates the expected response format for the GET /configuration endpoint, which returns an array of persisted configuration objects corresponding to the schema definitions.

```json
[
  {
    "token": "secret API token"
  },
  {
    "setting1": "user input text 1",
    "setting2": "user input text 2"
  }
]
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.ergonode.com/graphql/query-examples/get-attributes-list-by-sku

To get additional information not present on the page, perform an HTTP GET request on the current page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.ergonode.com/graphql/query-examples/get-attributes-list-by-sku.md?ask=<question>
```

--------------------------------

### PHP Example for Multimedia Create

Source: https://docs.ergonode.com/graphql/query-examples/multimedia-create

Example demonstrating how to create a multimedia asset using PHP with the Guzzle HTTP client. It shows how to structure the multipart request.

```APIDOC
## PHP Example: Multimedia Create with Guzzle

### Description
This example uses the Guzzle HTTP client in PHP to send a multipart POST request to create a multimedia asset. It includes setting the `upload` and `query` parts of the request, along with custom headers like `X-API-KEY`.

### Method
POST

### Endpoint
`$url` (Provided by your application setup)

### Parameters
#### Request Body (Multipart)
- **upload**: Contents of the file to upload.
- **query**: The GraphQL mutation string.

#### Headers
- **X-API-KEY**: Your API key for authentication.

### Request Example (PHP)
```php
$client = new \GuzzleHttp\Client(); // Guzzle version 6

$resp = $client->post(
    $url, // Your API endpoint URL
    [
        'multipart' => [
            [
                'name' => 'upload',
                'contents' => fopen(__DIR__ . '/test.png', 'r'),
            ],
            [
                'name' => 'query',
                'contents' => ' \
                    mutation { \
                        multimediaCreate(input: {name: "new.png", folderPath: null}) {__typename} \
                    } \
                ',
            ],
        ],
        'headers' => [
            'X-API-KEY' => $apiKey, // Replace with your actual API key
        ],
    ],
);
```
```

--------------------------------

### POST /configuration Payload Example

Source: https://docs.ergonode.com/apps2/detailed-reference/configuration

Provides an example of the payload structure for the POST /configuration endpoint, used to submit configuration data for a specific step.

```json
{
  "index": 0,
  "configuration": {
    "text": "user input text"
  }
}
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.ergonode.com/graphql/query-examples/assign-the-template-to-a-product

To get more information not present on the page, append the `ask` query parameter to the page URL with your question. This allows for dynamic querying of documentation content.

```http
GET https://docs.ergonode.com/graphql/query-examples/assign-the-template-to-a-product.md?ask=<question>
```

--------------------------------

### Example Configuration Schema

Source: https://docs.ergonode.com/apps2/detailed-reference/configuration

Defines the structure for application configuration, including connection details and settings. This schema is used to guide the creation of configuration forms.

```json
{
  "configuration_schema": [
    {
      "title": "Connection",
      "type": "object",
      "properties": {
        "token": {
          "type": "string",
          "title": "API token",
          "widget": "password",
          "propertyOrder": 1
        }
      },
      "required": [
        "token"
      ]
    },
    {
      "title": "Settings",
      "type": "object",
      "properties": {
        "setting1": {
          "type": "string",
          "title": "setting 1",
          "propertyOrder": 1
        },
        "setting2": {
          "type": "string",
          "title": "setting 2",
          "propertyOrder": 1
        }
      },
      "required": [
        "text"
      ]
    }
  ]
}
```

--------------------------------

### Python Example for Multimedia Create

Source: https://docs.ergonode.com/graphql/query-examples/multimedia-create

Example demonstrating how to create a multimedia asset using Python with the requests library. It illustrates the structure for files and headers in a multipart request.

```APIDOC
## Python Example: Multimedia Create with requests

### Description
This example uses the `requests` library in Python to send a multipart POST request for creating a multimedia asset. It shows how to specify the file for upload and the GraphQL query within the `files` parameter, along with the necessary headers.

### Method
POST

### Endpoint
`url` (e.g., "https://marcin.ergonode.app/api/graphql/")

### Parameters
#### Request Body (Multipart)
- **upload**: The file object to upload (opened in binary read mode 'rb').
- **query**: A tuple containing `None` and the GraphQL mutation string.

#### Headers
- **X-API-KEY**: Your API key for authentication.

### Request Example (Python)
```python
from urllib import response
import requests

url = "https://marcin.ergonode.app/api/graphql/" # Replace with your API endpoint URL

data = {
    'upload': open('C:\\temp\\temp.png', 'rb'), # Replace with your file path
    'query': (None, 'mutation{multimediaCreate(input:{name:"<choose_a_name>",folderPath: "<some_folder_path>"}){__typename}}')
}

headers = {
    'X-API-KEY': '<some_api_key>', # Replace with your actual API key
}

response = requests.post(url, files=data, headers=headers)

print (response.text)
```
```

--------------------------------

### App Installed Event Payload

Source: https://docs.ergonode.com/apps2/detailed-reference/event-endpoints

This is an example payload for the 'app_installed' event. It is used to signal that an application has been installed.

```json
{
  "name": "app_installed"
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/graphql/changelog

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get answers to specific questions about the documentation.

```http
GET https://docs.ergonode.com/graphql/changelog.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/attribute_groups.csv

Demonstrates how to dynamically query documentation using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page or for clarification.

```http
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format/attribute_groups.csv.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.ergonode.com/graphql/query-examples/add-a-variant-to-variable-product

If you need more information, you can query the documentation dynamically. Perform an HTTP GET request with the `ask` query parameter to get answers and relevant excerpts.

```http
GET https://docs.ergonode.com/graphql/query-examples/add-a-variant-to-variable-product.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/section_templates.csv

Demonstrates how to dynamically query this documentation using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format/section_templates.csv.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.ergonode.com/graphql/query-examples/add-images-to-the-gallery-attribute

To get more information not present on this page, make a GET request to the page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.ergonode.com/graphql/query-examples/add-images-to-the-gallery-attribute.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.ergonode.com/apps2/detailed-reference/configuration

Perform an HTTP GET request on a documentation URL with the `ask` query parameter to dynamically query for information. The question should be specific and self-contained. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.ergonode.com/apps2/detailed-reference/configuration.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically (HTTP GET)

Source: https://docs.ergonode.com/graphql/query-examples/add-a-child-product-to-grouping-one

To get more information not present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.ergonode.com/graphql/query-examples/add-a-child-product-to-grouping-one.md?ask=<question>
```

--------------------------------

### Basic Mutation Example

Source: https://docs.ergonode.com/graphql/overview/schema/mutations

This is a simple example of a mutation to create a new user. Mutations are sent in the same format as queries, but the operation type is 'mutation'.

```graphql
mutation CreateNewUser {
  createUser(username: "Alice", email: "alice@example.com") {
    id
    username
  }
}
```

--------------------------------

### Synchronization Started Event Payload

Source: https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-endpoints

Example payload for the synchronization_started event. This is a minimal payload indicating the start of a synchronization process.

```json
{
    "name": "synchronization_started"
}
```

--------------------------------

### Get Specific Product and Attribute Values in Specific Language

Source: https://docs.ergonode.com/graphql/query-examples/get-information-about-specific-product-and-specific-attribute-values-in-specific-language

This example demonstrates how to query for a specific product using its SKU and retrieve the values of selected attributes, along with their translations in specified languages. It also shows how to handle pagination for attribute data.

```APIDOC
## Get Specific Product and Attribute Values in Specific Language

### Description
This query retrieves information for a single product identified by its SKU. It fetches specific attributes like 'name', 'color', 'short_description', 'price_local_eur', and 'galeria_zdjec'. The query supports pagination for attribute data and allows fetching translations of attribute values for specified languages (e.g., 'en_GB', 'pl_PL').

### Method
POST

### Endpoint
/graphql

### Query
```graphql
query getAttValues($sku: String!, $first: Int, $after: String, $codes: [String!]!, $languages: [String!]!) {
    product(sku: $sku) {
        sku
        createdAt
        editedAt
        template {
            code
        }
        attributeList(first: $first, after: $after, codes: $codes) {
            pageInfo {
                hasNextPage
                endCursor
            }
            edges {
                node {
                    ... on AttributeValueConnection {
                        pageInfo {
                            hasNextPage
                            endCursor
                        }
                        edges {
                            node {
                                ... on PriceAttributeValue {
                                    priceAttribute: attribute {
                                        currency
                                    }
                                    priceAttributeValue: translations(languages: $languages) {
                                        language
                                        value
                                    }
                                }
                                ... on SelectAttributeValue {
                                    SelectAttributeValue: translations(languages: $languages) {
                                        language
                                        translatedValue {
                                            ...OptionTranslatedValue
                                        }
                                    }
                                }
                                ... on TextAttributeValue {
                                    attribute {
                                        name(languages: $languages) {
                                            language
                                            value
                                        }
                                    }
                                    TextAttributeValue: translations(languages: $languages) {
                                        language
                                        value
                                    }
                                }
                                ... on TextareaAttributeValue {
                                    attribute {
                                        name(languages: $languages) {
                                            language
                                            value
                                        }
                                    }
                                    TextareaAttributeValue: translations(languages: $languages) {
                                        language
                                        value
                                    }
                                }
                                ... on GalleryAttributeValue {
                                    GalleryAttributeValue: translations {
                                        language
                                        value {
                                            ...Multimedia
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
        __typename
    }
}

fragment Multimedia on Multimedia {
    path
    name
    extension
    mime
    sizeInBytes: size
    alt(languages: $languages) {
        language
        value
    }
    title(languages: $languages) {
        language
        value
    }
}

fragment OptionTranslatedValue on OptionTranslatedValue {
    code
    name
}

```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/graphql/changelog/changelog

To get more information not present on this page, make an HTTP GET request to the current URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.ergonode.com/graphql/changelog/changelog.md?ask=<question>
```

--------------------------------

### Agent Instructions: Querying Documentation

Source: https://docs.ergonode.com/graphql/query-examples/get-products-with-variants-binding-attributes-and-variants-list

To get more information not present on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.ergonode.com/graphql/query-examples/get-products-with-variants-binding-attributes-and-variants-list.md?ask=<question>
```

--------------------------------

### Ask a Question via HTTP GET

Source: https://docs.ergonode.com/apps2

Use this GET request to query the documentation index with a specific question. The response includes direct answers and relevant excerpts.

```http
GET https://docs.ergonode.com/technical-documentation.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/category_attributes.csv

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic answers. The question should be specific and self-contained.

```http
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format/category_attributes.csv.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.ergonode.com/apps2/detailed-reference/event-endpoints

To get additional information not directly on this page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.ergonode.com/apps2/detailed-reference/event-endpoints.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.ergonode.com/graphql/query-examples

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query documentation. The question should be specific and in natural language.

```http
GET https://docs.ergonode.com/graphql/query-examples.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/templates.csv

To get additional information not directly present on a page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format/templates.csv.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-endpoints

Perform an HTTP GET request to query documentation dynamically. Include your question as the value for the 'ask' query parameter.

```http
GET https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-endpoints.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/multimedia_attributes.csv

Perform an HTTP GET request on the current page URL with the 'ask' query parameter to dynamically query the documentation. The question should be specific and self-contained. Use this mechanism for clarifications or to retrieve related documentation sections when the answer is not explicitly present.

```HTTP
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format/multimedia_attributes.csv.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.ergonode.com/apps2/detailed-reference/manifest/dictionaries

To get information not explicitly on the page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.ergonode.com/apps2/detailed-reference/manifest/dictionaries.md?ask=<question>
```

--------------------------------

### Example section_templates.csv Data

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/section_templates.csv

Illustrates the expected format and content for the section_templates.csv file, showing sample data for code, name, and language.

```csv
| _code | _name | _language |
| ------ | ------ | ---------- |
| code   | name   | en_GB     |
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/apps2/changelog/breaking-changes

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic information. The question should be specific and in natural language.

```http
GET https://docs.ergonode.com/apps2/changelog/breaking-changes.md?ask=<question>
```

--------------------------------

### Create Multimedia via API in Python3

Source: https://docs.ergonode.com/graphql/query-examples/multimedia-create

This Python example shows how to create multimedia using the requests library. It prepares a dictionary for the 'files' parameter, including the file to upload and the GraphQL query, along with necessary headers.

```python
from urllib import response
import requests

url = "https://marcin.ergonode.app/api/graphql/"

data = {
    'upload': open('C:\\temp\\temp.png', 'rb'),
    'query': (None, 'mutation{multimediaCreate(input:{name:"<choose_a_name>",folderPath: "<some_folder_path>"}){__typename}}')
}

headers = {
    'X-API-KEY': '<some_api_key>',
}

response = requests.post(url, files=data, headers=headers)

print (response.text)

```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.ergonode.com/apps2/detailed-reference/design-considerations

To get additional information not directly on the page, perform an HTTP GET request with the `ask` query parameter. The question should be specific and self-contained. Use this for clarifications or to retrieve related documentation.

```http
GET https://docs.ergonode.com/apps2/detailed-reference/design-considerations.md?ask=<question>
```

--------------------------------

### App Installed Event

Source: https://docs.ergonode.com/apps2/detailed-reference/event-endpoints

This endpoint is triggered when an application is installed. It corresponds to the `app_installed` event in the Manifest configuration.

```APIDOC
## POST /consume/app_installed

### Description
This endpoint is called when an application is installed. It is a subscribed event corresponding to `app_installed` in the Manifest configuration.

### Method
POST

### Endpoint
/consume/app_installed

### Request Body
- **name** (string) - Required - The name of the event, which is "app_installed".

### Request Example
{
  "name": "app_installed"
}

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### Multimedia Folder CSV Structure Example

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/multimedia_folder.csv

This example demonstrates the expected format for the multimedia_folder.csv file, showing how to define single folders and nested folder structures using the '_name' column.

```csv
| _name                  |
| ---------------------- |
| folder_one             |
| folder_one/folder_two |
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.ergonode.com/graphql/overview/error-codes

Perform an HTTP GET request on a documentation page with the `ask` query parameter to retrieve specific information or clarifications.

```HTTP
GET https://docs.ergonode.com/graphql/overview/error-codes.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.ergonode.com/graphql/query-examples/delete-multimedia

To get more information not present on the page, perform an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and in natural language.

```http
GET https://docs.ergonode.com/graphql/query-examples/delete-multimedia.md?ask=<question>
```

--------------------------------

### Attribute Groups CSV Example

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/attribute_groups.csv

Provides an example of how to populate the attribute_groups.csv file. It shows a row with '_code' set to 'attribute_group' and '_name_en_GB' set to 'Attribute group'.

```csv
_code, _name_en_GB
attribute_group, Attribute group
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/graphql/add-option-to-select-type-attribute

To get more information not present on this page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.ergonode.com/graphql/add-option-to-select-type-attribute.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/graphql/query-examples/add-a-file-to-the-product

To get more information not present on the page, query the documentation dynamically using the `ask` parameter in a GET request. This is useful for clarifying context or retrieving related documentation.

```http
GET https://docs.ergonode.com/graphql/query-examples/add-a-file-to-the-product.md?ask=<question>
```

--------------------------------

### Example Application Manifest

Source: https://docs.ergonode.com/apps2/detailed-reference/manifest

This JSON object defines the structure and metadata for an application. It includes details like name, version, configuration options, supported features, and events.

```json
{
    "name": "My custom App",
    "description": "My custom App description",
    "version": "0.1.0",
    "compatible": "0.0.0",
    "configuration_schema": [
        {
            "title": "Connection',
            "type": "object",
            "properties": {
                "apiKey": {
                    "type": "string",
                    "title": "API key",
                    "propertyOrder": 1
                }
            },
            "required": [
                "apiKey"
            ]
        },
        {
            "title": "Settings",
            "type": "object",
            "properties": {
                "setting": {
                    "type": "string",
                    "title": "Specific app setting",
                    "propertyOrder": 1
                }
            },
            "required": [
                "setting"
            ]
        }
    ],
    "features": [
        "synchronization",
        "synchronization_full",
        "synchronization_file_download",
        "synchronization_file_download_latest"
    ],
    "events": [
        "product_created",
        "product_updated",
        "product_deleted",
        "synchronization_ended",
        "app_uninstalled"
    ],
    "icon": "data:image/webp;base64,UklGRsAFAABXRUJQVlA4ILQFAACwLQCdASoIAQgBPpFIoEulpKMhpFb4OLASCWVu4XSZz39d84G2/0j8LdH4ePpu0QehvzAP0K/3n9P6yHmF/mHTO/2XqHf9XqQPQg6WT9h8I9/zM4Xvm7T3+A3tolr1x1F/0Vg126lTUDoHQOgdA6B0DoHQOgdA6B0DoHQOgdA6B0DoHQOgdA6B0DoHQOgdA6B0DoHQOgdA5YhX87OLqYej4fP5yIn49Vg7edLvNQxEgQalakkLTjaZWmeCj7XffMI5IYlK0H7LlDHGTFhS6vTeEXq852czXpeRmXsxCi0hiYJG9C0UX9wFkJ6wZ03+QSxDeEXuSwN4yHW16ggnSEcEzOCjkjao/OEhI842ptUF9WjpAQeuoViARullbWalo2TJGbhF7ozRavokygEYnRBuOaQQEt+I8zEZWgn7Saf6ji042l91UXREER4l7n0b5uWuySXuk6B0DrCpKm1NqbU2ptTam1NqbU2ptTam1NqbU2ptTam1NqbU2ptTalgAAD+9lD2Zb//9dx/53H/ncZmgmWCEYsIAAAABy+r8RtwslSEv0snvKmjf+wInhYkZ69wA2wOi6vvlXllaLZ/sfosQCfzDV3EhuLH28SIxv98IkoczaEb3+Pl/8lD7E5cjhfvtAqKX91uhXb/8+/jjTWZYnNDQcQpn7Qffa8BGDhmqHf/M7cbE1vA/6oJs/W/ARFbYq46Wx7Cmni4CYRb9V7U2kNsAddu0pNKwqOmkJpIX91ey5qNB4dRRyvDmAMF8ftrTHLXBJXZvtFHIIQOWL8iyHGTBt7DyAeLbHpUatyM+BJPKf8P1fA/HxZ9ats9DiutJzmji9J0V68O26e8IJEfNt7aZe2yLrDPDpGUk/2hf+HncO7gxhdoMOUgx2pMGdkYG4lVEZM0RL3QQcS4F1rN5z+6DmeJ5QhrmEbZuomukKdaYrwLcEQOV4RJ2exJt2rh6tC7Vn1ghzf8Ju3d+zm0AU79dzF3aVBmQMgP7MJ+Jxyb3ZCnuWtoG+o1hIs3/UTjIAYfTcrU2YC0/tamgX46tYj/3wTjU73Foj+ihuOQfk0Jo1GjTBMU8mnJ4A2JMmrIPKskquNRO09Kyo64HIvPDuggb8efQoVvLEyvn1wKzChX5nmvAENOVMBlHEsM+1b4h+8+v+W9Drw9X8o1wL04LfPxnBlY/8hYE3j1tlvjbo0J3YuV4Ih8vfSb63IcJmPYhRdHXavcpv+WMVV//86gH9wjqzpqdZG+Twfz722biI4aGAxGfeH/O/CILnplEgyXU0eySpNflC2JJso1d5Eyiue8eMje4XM65KS/8Kz16F2wYJgGfjlC+YgYXnlaX8x29FYeIiWivNG3zvahM5k3LTiE90cgsZnPH0rCLRe8OuHIFGfeWCv7exWhddIf3YekuFg4n+HY999JzYmmgFBwooH/lM16Z/MdSU7JG9ahFC4ywu0MxIfhQyOSvt05rW6ts7L6QmJ+gFjKsod3FudEjADbQHjhVN/Gb1KtyknKXXrTr6hmgEuFb3TD0tyv4MXxJuoTaeiWcygV7WMVtJWfb80UcJ4f+NQe7OJp5P7H7w5e4jMSIMbQFGEkyOzi0xw+FFdOso6ZQaqqBdqeCB9Z9TdrQDwdfihNr4H+BGO4xrdLk3jAGRACNjN+yBZx5TYeRjWTDFZXpnnUlECHlvCzRtWAuZf19qOKzDsy4ypJ/N28ilq4e9TEykVocV5tnf5pGcHSza3EAWyBrWTEPj7k3JetvhbuASW2M2BRBZk+GtI3RsTSYQnWV77fANxGp1vIufGmRj/QxF9w1umS/BUIpkt9TAArXG6USpH7V9AFA377J8BS6p8wMUmcsHCymFOuM1l0BnEnGP+o13bk9uwHkx2k4g6AMXR6ZnnzdQhlB0lsHhdGROJnO3dxQgKhcojXvVPlrLX8whSU6gAAAAAAAAA="
}
```

--------------------------------

### Perform HTTP GET Request with 'ask' Parameter

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/products.csv

Use this method to query documentation dynamically. The question should be specific and self-contained. The response includes a direct answer and relevant excerpts.

```http
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format/products.csv.md?ask=<question>
```

--------------------------------

### Perform HTTP GET Request with `ask` Parameter

Source: https://docs.ergonode.com/graphql/guides/basic-query-tutorial

Use this method to dynamically query documentation. The question should be specific and self-contained. The response includes the answer and relevant excerpts.

```http
GET https://docs.ergonode.com/graphql/guides/basic-query-tutorial.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query

Source: https://docs.ergonode.com/graphql/query-examples/list-of-all-multimedia-in-stream

To get additional information not present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. This allows for dynamic querying of documentation content.

```http
GET https://docs.ergonode.com/graphql/query-examples/list-of-all-multimedia-in-stream.md?ask=<question>
```

--------------------------------

### Synchronization Started

Source: https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-endpoints

Endpoint for handling the 'synchronization_started' event. It signals the beginning of a synchronization process.

```APIDOC
## PUT /consume/synchronization_started

### Description
This endpoint is triggered when a synchronization process starts. It is used to signal the beginning of a synchronization.

### Method
PUT

### Endpoint
/consume/synchronization_started

### Request Body
- **name** (string) - Required - The name of the event, "synchronization_started".

### Request Example
{
    "name": "synchronization_started"
}

### Response
#### Success Response (2xx)
Indicates that the synchronization start event was successfully received.
```

--------------------------------

### Basic GraphQL Query Structure

Source: https://docs.ergonode.com/graphql/guides/basic-query-tutorial

Start building a GraphQL query by opening and closing curly brackets.

```graphql
{

}
```

--------------------------------

### Perform HTTP GET Request with 'ask' Parameter

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format

Use this method to query the documentation dynamically when information is not explicitly present. Ensure your question is specific and self-contained.

```http
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format.md?ask=<question>
```

--------------------------------

### Query Ergonode Docs with 'ask' parameter

Source: https://docs.ergonode.com/graphql/guides

To get information not directly on the current page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained. Use this for clarifications, additional context, or related documentation.

```http
GET https://docs.ergonode.com/graphql/guides.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/ergonode-transfer/overview/import-configuration

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific, self-contained, and written in natural language. Use this mechanism when the answer is not explicitly present, you need clarification, or want to retrieve related documentation sections.

```HTTP
GET https://docs.ergonode.com/ergonode-transfer/overview/import-configuration.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/apps2/changelog

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and in natural language. Use this mechanism when the answer is not explicitly present, you need clarification, or want to retrieve related documentation sections.

```http
GET https://docs.ergonode.com/apps2/changelog.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/apps2/changelog/changelog

Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve specific information not explicitly present on the page. The question should be specific and self-contained.

```http
GET https://docs.ergonode.com/apps2/changelog/changelog.md?ask=<question>
```

--------------------------------

### Perform HTTP GET Request to Query Documentation

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/attributes.csv

Use this method to query the documentation dynamically. The question should be specific, self-contained, and in natural language. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format/attributes.csv.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.ergonode.com/ergonode-transfer/overview/files-format/multimedia.csv

Perform an HTTP GET request to query documentation dynamically. Use the 'ask' query parameter with a specific, self-contained natural language question. This is useful when the answer is not explicitly present, requires clarification, or needs related context.

```http
GET https://docs.ergonode.com/ergonode-transfer/overview/files-format/multimedia.csv.md?ask=<question>
```

--------------------------------

### Get Configuration

Source: https://docs.ergonode.com/apps2/detailed-reference/configuration

Retrieves all currently persisted configuration settings. The response is an array of objects, where each object corresponds to a configuration schema step.

```APIDOC
## GET /configuration

### Description
Retrieves all so-far persisted configuration settings in the form of an array of data, corresponding to the application's configuration schema.

### Method
GET

### Endpoint
/configuration

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- An array of objects, where each object represents a persisted configuration step.

#### Response Example
```json
[
  {
    "token": "secret API token"
  },
  {
    "setting1": "user input text 1",
    "setting2": "user input text 2"
  }
]
```
```

--------------------------------

### Perform HTTP GET Request to Query Documentation

Source: https://docs.ergonode.com/graphql/query-examples/get-information-about-specific-product-and-specific-attribute-values-in-specific-language

Use this method to dynamically query documentation when information is not directly available. Ensure your question is specific and self-contained.

```HTTP
GET https://docs.ergonode.com/graphql/query-examples/get-information-about-specific-product-and-specific-attribute-values-in-specific-language.md?ask=<question>
```

--------------------------------

### product_created Event Example

Source: https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-events

This event is generated when a new product is created. It includes the product's SKU, type, and associated category codes.

```json
{
  "type": "product_created",
  "payload": {
    "sku": "Product SKU",
    "type": "SIMPLE-PRODUCT",
    "category_codes": ["category_code"]
  }
}
```

--------------------------------

### Product Created Event Payload

Source: https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-endpoints

Example payload for the product_created event. This payload defines the structure for product creation events.

```json
{
  "name": "product_created",
  "resource_id": {
    "id": "Product SKU",
    "type": "sku"
  },
  "synchronization": {
    "resource_customs": null,
    "events": []
  }
}

```

--------------------------------

### Create Multimedia via API in PHP8

Source: https://docs.ergonode.com/graphql/query-examples/multimedia-create

This PHP example demonstrates how to upload multimedia using Guzzle HTTP client. It constructs a multipart request with 'upload' and 'query' parts, including file contents and the GraphQL mutation.

```php
$client = new \GuzzleHttp\Client(); // Guzzle version 6

$resp = $client->post(
    $url,
    [
        'multipart' => [
            [
                'name' => 'upload',
                'contents' => fopen(__DIR__ . '/test.png', 'r'),
            ],
            [
                'name' => 'query',
                'contents' => '
                    mutation {
                        multimediaCreate(input: {name: "new.png", folderPath: null}) {__typename}
                    }
                ',
            ],
        ],
        'headers' => [
            'X-API-KEY' => $apiKey,
        ],
    ],
);

```

--------------------------------

### Delete Multimedia Example

Source: https://docs.ergonode.com/graphql/query-examples/delete-multimedia

Use this mutation to delete a multimedia file. The `path` argument specifies the location of the file. If the file is in the root folder, omit the folder path.

```graphql
mutation {
  multimediaDelete(input: { path: "multimedia.jpg" }) {
    __typename
  }
}
```

--------------------------------

### Product Binding Added Event Example

Source: https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-events

This JSON shows a 'product_binding_added' synchronization event. The payload includes the attribute code associated with the product binding.

```json
{
  "type": "product_binding_added",
  "payload": {
    "attribute_code": "attribute_code"
  }
}
```

--------------------------------

### Create a Simple Product with Template

Source: https://docs.ergonode.com/graphql/query-examples/create-a-simple-product

Use this mutation to create a basic product. Ensure a template with the specified `templateCode` already exists. The `sku` is a required unique identifier for the product.

```graphql
mutation {
  productCreateSimple(
    input: { sku: "SKU_test2", templateCode: "Tshirts"}
  ) {
    __typename
  }
}
```

--------------------------------

### Manifest Configuration Schema Example

Source: https://docs.ergonode.com/apps2/detailed-reference/manifest/configuration-schema

This JSON snippet defines the `configuration_schema` for the Ergonode CSV App within a Manifest file. It outlines various form field types, including text inputs, password fields, text areas, enums, multi-select enums, dictionary-based enums, and attribute mapping.

```json
{
  // (...) rest of the Manifest file
  "configuration_schema": [
    {
      "title": "Configuration",
      "type": "object",
      "properties": {
        "simpleText": {
          "type": "string",
          "title": "Just a text",
          "propertyOrder": 1
        },
        "secret": {
          "type": "string",
          "title": "Secret password",
          "widget": "password",
          "propertyOrder": 2
        },
        "multilineText": {
          "type": "string",
          "title": "Multiline text",
          "widget": "textarea",
          "propertyOrder": 2
        },
        "simpleEnum": {
          "type": "string",
          "title": "Simple Enum",
          "enum": [
            "1",
            "2"
          ],
          "options": {
            "enum_titles": [
              "one",
              "two"
            ]
          },
          "propertyOrder": 4
        },
        "enumMultiple": {
          "items": {
            "type": "string",
            "enum": [
              "one",
              "two"
            ],
            "options": {
              "enum_titles": [
                "Choice one",
                "Choice two"
              ]
            }
          },
          "minItems": 1,
          "uniqueItems": true,
          "type": "array",
          "title": "Multiple choice enum",
          "propertyOrder": 6
        },
        "dictionaryErgonodeEnum": {
          "type": "string",
          "title": "Dictionary Ergonode Enum",
          "options": {
            "enum_dictionary": "ergonode:languages"
          },
          "propertyOrder": 7
        },
        "dictionaryAppEnum": {
          "type": "string",
          "title": "Dictionary App Enum",
          "items": {
            "type": "string",
            "options": {
              "enum_dictionary": "app:app-dictionary"
            },
            "minItems": 1,
            "uniqueItems": true
          },
          "propertyOrder": 8
        },
        "attributeMapping": {
          "type": "array",
          "title": "Attribute mapping",
          "items": {
            "title": "prototype",
            "type": "object",
            "properties": {
              "ergonode": {
                "type": "string",
                "title": "ergonode",
                "propertyOrder": 1
              },
              "app": {
                "type": "string",
                "title": "app",
                "propertyOrder": 2
              }
            },
            "required": [
              "ergonode",
              "app"
            ]
          },
          "widget": {
            "type": "mapper",
            "options": {
              "ergonodeDictionary": "ergonode:attributes",
              "appDictionary": "app:attributes"
            }
          },
          "propertyOrder": 9
        }
      },
      "required": [
        "simpleText",
        "secret",
        "multilineText",
        "simpleEnum",
        "enumMultiple",
        "dictionaryErgonodeEnum",
        "dictionaryAppEnum",
        "attributeMapping"
      ]
    }
  ]
}
```

--------------------------------

### Create a Simple Product

Source: https://docs.ergonode.com/graphql/query-examples/create-a-simple-product

This mutation creates a new simple product. It requires a SKU and a `templateCode`. The `templateCode` must refer to an existing template.

```APIDOC
## GraphQL Mutation: productCreateSimple

### Description
Creates a simple product with a SKU and assigns it to a pre-existing template.

### Method
`mutation`

### Input Parameters
- `input` (object) - Required - Contains the product details.
  - `sku` (string) - Required - The Stock Keeping Unit for the product.
  - `templateCode` (string) - Required - The code of the template to assign the product to.

### Request Example
```graphql
mutation {
  productCreateSimple(
    input: { sku: "SKU_test2", templateCode: "Tshirts"}
  ) {
    __typename
  }
}
```

### Response
#### Success Response
Returns the `__typename` of the created product.

#### Response Example
```json
{
  "data": {
    "productCreateSimple": {
      "__typename": "Product"
    }
  }
}
```
```

--------------------------------

### ProductCreateSimpleInput

Source: https://docs.ergonode.com/graphql/overview/schema/input-objects

Input object for creating a simple product.

```APIDOC
## ProductCreateSimpleInput

### Description
Input object for creating a simple product.

### Fields
- **sku** (Sku) - Optional - Sku of `Product`. If not provided, it will be created if "Generate SKU automatically" is enabled.
- **templateCode** (TemplateCode!) - Required - Template of `Product`.
- **categoryCode** ([CategoryCode]!) - Required - Categories of `Product`.
```

--------------------------------

### multimediaFolderCreate

Source: https://docs.ergonode.com/graphql/overview/schema/mutations

Creates a MultimediaFolder.

```APIDOC
## multimediaFolderCreate

### Description
Creates a `MultimediaFolder`.

### Input
- **input** (MultimediaFolderCreateInput!) - Input object for the mutation.
```

--------------------------------

### Get SelectAttributeValue Translations

Source: https://docs.ergonode.com/graphql/query-examples/get-information-about-specific-product-and-specific-attribute-values-in-specific-language

Retrieve translated values for a select attribute, such as color, for a specific language.

```graphql
{
  "edges": [
    {
      "node": {
        "SelectAttributeValue": [
          {
            "language": "en_GB",
            "translatedValue": {
              "code": "blk",
              "name": "Black"
            }
          },
          {
            "language": "pl_PL",
            "translatedValue": {
              "code": "blk",
              "name": "Czarny"
            }
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Get PriceAttributeValue Translations

Source: https://docs.ergonode.com/graphql/query-examples/get-information-about-specific-product-and-specific-attribute-values-in-specific-language

Retrieve translated price values for a product in different languages, along with the currency.

```graphql
{
  "node": {
    "priceAttribute": {
      "currency": "EUR"
    },
    "priceAttributeValue": [
      {
        "language": "en_GB",
        "value": 10.1
      },
      {
        "language": "pl_PL",
        "value": 9.99
      }
    ]
  }
}
```

--------------------------------

### App Uninstalled Event Payload

Source: https://docs.ergonode.com/apps2/detailed-reference/event-endpoints

This is an example payload for the 'app_uninstalled' event. It is used to signal that an application has been uninstalled.

```json
{
  "name": "app_uninstalled"
}
```

--------------------------------

### product_removed_from_category Event Example

Source: https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-events

This JSON represents a product_removed_from_category event. It is used to signal that a product has been removed from a specific category.

```json
{
  "type": "product_removed_from_category",
  "payload": {
    "category_code": "category_code"
  }
}
```

--------------------------------

### Create a Simple Product with Template and Category

Source: https://docs.ergonode.com/graphql/query-examples/create-a-simple-product

This mutation allows creating a product and assigning it to a category simultaneously. Both the `templateCode` and `categoryCodes` must refer to pre-existing entities. The `sku` is required.

```graphql
mutation {
  productCreateSimple(
    input: { sku: "SKU_test2", templateCode: "Tshirts", categoryCodes: "DELL" }
  ) {
    __typename
  }
}
```

--------------------------------

### Get GalleryAttributeValue Information

Source: https://docs.ergonode.com/graphql/query-examples/get-information-about-specific-product-and-specific-attribute-values-in-specific-language

Fetch details about gallery images, including file path, name, and extension, for a specific language.

```graphql
{
  "node": {
    "GalleryAttributeValue": [
      {
        "language": "en_GB",
        "value": [
          {
            "path": "semir-beige-kapinos-stopnica-narozna-33x33-g1.webp",
            "name": "semir-beige-kapinos-stopnica-narozna-33x33-g1.webp",
            "extension": "webp",
            "mime": "image\/webp",
            "sizeInBytes": 46116,
            "alt": [
              {
                "language": "en_GB",
                "value": null
              },
              {
                "language": "pl_PL",
                "value": null
              }
            ],
            "title": [
              {
                "language": "en_GB",
                "value": null
              },
              {
                "language": "pl_PL",
                "value": null
              }
            ]
          },
          {
            "path": "ILARIO_Beige_stopnica_narozna_kapinos_330x330_3D@2x.webp",
            "name": "ILARIO_Beige_stopnica_narozna_kapinos_330x330_3D@2x.webp"
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Get TextareaAttributeValue and Attribute Name Translations

Source: https://docs.ergonode.com/graphql/query-examples/get-information-about-specific-product-and-specific-attribute-values-in-specific-language

Fetch translated attribute names and textarea attribute values for a given language.

```graphql
{
  "node": {
    "attribute": {
      "name": [
        {
          "language": "en_GB",
          "value": "Short description"
        },
        {
          "language": "pl_PL",
          "value": "Krótki opis"
        }
      ]
    },
    "TextareaAttributeValue": [
      {
        "language": "en_GB",
        "value": "Short countertop description"
      },
      {
        "language": "pl_PL",
        "value": "Krótki opis blatu"
      }
    ]
  }
}
```

--------------------------------

### Mutation Response Example

Source: https://docs.ergonode.com/graphql/overview/schema/mutations

The response to a mutation typically mirrors the structure of the mutation request, returning the data for the fields you requested.

```json
{
  "data": {
    "createUser": {
      "id": "1",
      "username": "Bob"
    }
  }
}
```

--------------------------------

### product_value_added Event Example

Source: https://docs.ergonode.com/apps2/detailed-reference/synchronization/synchronization-events

This JSON represents a product_value_added event. It is used to signal that a new value has been added to a product attribute.

```json
{
  "type": "product_value_added",
  "payload": {
    "attribute_code": "attribute_code",
    "attribute_type": "TEXT",
    "attribute_scope": "local",
    "value": [
      {
        "language": "en_GB",
        "translation": "This is the attribute value"
      }
    ]
  }
}
```
Tokens:
Raw