IdoSell API

https://idosell.readme.io/
Admin
IdoSell API is a comprehensive SaaS platform API that enables merchants to integrate programs and...
Tokens:532,336
Snippets:1,440
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Installation Done Endpoint

Source: https://idosell.readme.io/docs/api-endpoints-for-isf

This endpoint is called after an online application has been successfully installed, providing necessary credentials for courier services.

```APIDOC
## POST https://apps.idosell.com/api/application/installation/done

### Description
Confirms the installation of an online application and provides courier service credentials.

### Method
POST

### Endpoint
https://apps.idosell.com/api/application/installation/done

### Request Body
- **api_license** (string) - Required - license number
- **application_id** (int) - Required - application id
- **developer** (string) - Required - developer login
- **sign** (string) - Required - communication signature
- **isf_login** (string) - Required - login for courier services
- **isf_password** (string) - Required - password for courier services

### Response
#### Success Response (200)
- **status** (enum['ok', 'error']) - status
- **sign** (string) - communication signature
```

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

### GET /promotions/settings/get

Source: https://idosell.readme.io/reference/promotionssettingsgetget

Retrieves the promotion module configuration settings.

```APIDOC
## GET /promotions/settings/get

### Description
Get promotion module configuration.

### Method
GET

### Endpoint
/promotions/settings/get

### Response
#### Success Response (200)
- **data** (PromotionSettings) - The promotion settings object.
- **isError** (boolean) - Indicates if the request resulted in an error.
- **errors** (array) - A list of error objects if applicable.

#### Error Responses
- **401** - Authorization error
- **403** - Access denied
- **404** - Not found
- **422** - Invalid data format
- **429** - Too many requests
- **500** - Internal server error
```

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

### Sender XML Configuration

Source: https://idosell.readme.io/docs/example-sender

Example XML structure for defining sender information, including contact details and notification email addresses. Ensure all required fields are present for proper sender setup.

```xml
<sender>
  <address>
    <name>John Smith</name>
    <company>Very Good Shop</company>
    <country>PL</country>
    <subdivision>PL-ZP</subdivision>
    <postcode>71-043</postcode>
    <city>Szczecin</city>
    <address>Piastow 4d / Warehouse 1 / Section G</address>
    <telephone>48 91 43 33 881</telephone>
    <type>business</type>
  </address>
  <notifications>
    <email address="office1@test.pl" type="create"/>
    <email address="office2@test.pl" type="delivery"/>
    <email address="office3@test.pl" type="exception"/>
    <bounce address=" office@verygoodshop.pl" />
  </notifications>
</sender>
```

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

### Notify IdoSell Apps of installation completion

Source: https://idosell.readme.io/docs/how-to-prepare-the-application

Send this request to the specified endpoint once the application installation process is finished.

```Text
Request:
POST: https://apps.idosell.com/api/application/installation/done
{
    api_license: (string) //license number
    application_id: (int) // application id
    developer: (string) // developer login
    sign: (string) // communication signature
}

Response:
{
    status: ok | error // status  
    sign: (string) // communication signature  
}
```

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

### GET /system/config

Source: https://idosell.readme.io/reference/systemconfigget

Retrieves information about a shop and its most important configuration settings.

```APIDOC
## GET /system/config

### Description
Method is used for extracting information about a shop and its most important configuration settings.

### Method
GET

### Endpoint
/system/config

### Response
#### Success Response (200)
- **client_id** (integer) - Shop client ID.
- **dedicated_server** (boolean) - Dedicated server status.
- **shop_owner_data** (object) - Shop owner details including company name, NIP, address, and VAT registration status.
- **languages** (array) - List of languages configured in the administration panel.
```

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

### GET /system/shops/data

Source: https://idosell.readme.io/reference/systemshopsdataget

Retrieves the configuration and owner data for the system shops.

```APIDOC
## GET /system/shops/data

### Description
Retrieves detailed information about the shop, including owner company details, configured languages, and base currency settings.

### Method
GET

### Response
#### Success Response (207)
- **client_id** (integer) - Customer ID.
- **dedicated_server** (boolean) - Dedicated server status.
- **shop_owner_data** (object) - Shop owner company information.
  - **company_name** (string) - Full company name.
  - **company_short_name** (string) - Company short name.
  - **nip** (string) - NIP [TIN].
  - **regon** (string) - CRN.
  - **krs** (string) - no of entry to NCR.
  - **address** (string) - Address.
  - **zipcode** (string) - ZIP / Post code.
  - **city** (string) - Town / City.
  - **country** (string) - region.
  - **VATRegistered** (boolean) - VAT registered status.
- **languages** (array) - List of languages configured in the administration panel.
  - **lang_id** (string) - Language code (ISO-639-3).
  - **lang_name** (string) - Language name.
- **panel_lang_id_default** (string) - Code of default panel language (ISO-639-3).
- **panel_basecurrency_id** (string) - Panel base currency ID.
- **shop_contact** (array) - Shop contact data.
  - **shop_id** (integer) - shop ID
```

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

### GET /products

Source: https://idosell.readme.io/reference/productsproductsget

Retrieves product details including deposit information, stock levels, and responsible person codes.

```APIDOC
## GET /products

### Description
Retrieves product information. The response includes details such as producer, responsible person, deposit information, and minimum stock levels.

### Method
GET

### Endpoint
/products

### Response
#### Success Response (200)
- **producerName** (string) - Producer name
- **responsiblePersonCode** (string) - Responsible person code
- **depositType** (integer) - Deposit type
- **depositProductId** (integer) - Product deposit id
- **depositCount** (integer) - Product deposit count
- **minStockLevel** (integer) - Minimum stock level

#### Error Handling
- **faultCode** (integer) - Error code. Possible values: 2 (Product search: empty result), 3 (Product search: no parameters), 4 (Product search: unknown currency), 5 (Shop blocked due to overdue invoices).
- **faultString** (string) - Error description.
```

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

### GET /products/products

Source: https://idosell.readme.io/reference/productsproductsget

Retrieves information about non-deleted products available in the administration panel.

```APIDOC
## GET /products/products

### Description
Method that enables extracting information about non-deleted products available in the administration panel.

### Method
GET

### Endpoint
/products/products

### Parameters
#### Query Parameters
- **productIds** (array) - Optional - List of the unique, indexed product codes (IAI code / External system code / Producer code). You can transfer a maximum of 100 products IDs in one request.

### Response
#### Success Response (200)
- **resultsLimit** (integer) - Number of results on page. Value from 1 to 100
- **results** (array) - Object contains detailed information on result of operation.
  - **productId** (integer) - Product IAI code
  - **productDisplayedCode** (string) - External product system code.
  - **productIsDeleted** (string) - Status of product deletion.
  - **productNote** (string) - Annotation.
  - **productTaxCode** (string) - PKWiU [PCPandS].
  - **producerId** (integer) - Brand ID
  - **producerName** (string) - Brand name
  - **categoryIdoSellId** (integer) - IdoSell Category ID
```

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

### Retrieve customer balance via cURL

Source: https://idosell.readme.io/reference

Example request to fetch client balance data using the GET method.

```Shell
curl --request GET \
     --url https://clientxxx.idosell.com/api/admin/v8/clients/balance \
     --header 'accept: application/json'
```

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

### POST /promotions/start

Source: https://idosell.readme.io/reference/promotionspromotionsstartpost

Initiates a promotion process.

```APIDOC
## POST /promotions/start

### Description
Starts a promotion.

### Method
POST

### Endpoint
/promotions/start

### Response
#### Success Response (200)
- **isError** (boolean) - Indicates if an error occurred.
- **errors** (array) - List of errors if any occurred.
```

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

### POST https://apps.idosell.com/api/application/installation/done

Source: https://idosell.readme.io/docs/api-endpoints

Notifies IdoSell Apps that the installation process for an application instance is complete.

```APIDOC
## POST https://apps.idosell.com/api/application/installation/done

### Description
Notifies IdoSell Apps that the installation process is complete for a given merchant.

### Method
POST

### Endpoint
https://apps.idosell.com/api/application/installation/done

### Request Body
- **api_license** (string) - Required - License number
- **application_id** (int) - Required - Application ID
- **developer** (string) - Required - Developer login
- **sign** (string) - Required - Communication signature

### Response
#### Success Response (200)
- **status** (enum) - Status ('ok', 'error')
- **errors** (array) - List of errors
- **sign** (string) - Communication signature
```

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

### ISF Application Installation Endpoint

Source: https://idosell.readme.io/docs/api-endpoints-for-isf

This endpoint is used for the installation of online ISF applications. You are required to provide an encrypted login and password for courier services. The response indicates the status of the installation.

```curl
Request:
POST: https://apps.idosell.com/api/application/installation/done

{
    api_license: (string) //license number 
    application_id: (int) // application id 
    developer: (string) // developer login 
    sign: (string) // communication signature 
    isf_login: (string) // login for courier services 
    isf_password: (string) // password for courier services 

}

Response:
{
    status: ok | error // status  
    sign: (string) // communication signature  
}
```

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

### Confirm Application Installation

Source: https://idosell.readme.io/docs/api-endpoints

Notifies IdoSell Apps that the installation process for an online application is complete.

```Text cURL
Request:
POST: https://apps.idosell.com/api/application/installation/done
{
    api_license: (string) //license number
    application_id: (int) // application id
    developer: (string) // developer login
    sign: (string) // communication signature
}

Response:
{
    status: (enum['ok', 'error']) // status  
    ?errors: [(string)] // list of errors
    sign: (string) // communication signature  
}
```

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

### POST /promotions/promotions/start

Source: https://idosell.readme.io/reference/promotionspromotionsstartpost

Starts a promotion identified by the provided promotion ID.

```APIDOC
## POST /promotions/promotions/start

### Description
Starts a promotion identified by the provided promotion ID.

### Method
POST

### Endpoint
/promotions/promotions/start

### Request Body
- **promotionId** (integer) - Required - ID of promotion

### Request Example
{
  "promotionId": 12
}

### Response
#### Success Response (200)
- **data** (integer) - Result data
- **isError** (boolean) - Indicates if an error occurred
- **errors** (array) - List of error objects

#### Response Example
{
  "data": 1,
  "isError": false,
  "errors": []
}
```

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

### POST /bundles

Source: https://idosell.readme.io/reference/productsbundlesbundlespost

Creates a new product bundle with specified components.

```APIDOC
## POST /bundles

### Description
Creates a new product bundle by defining its components and their respective quantities.

### Method
POST

### Endpoint
/bundles

### Request Body
- **quantity** (number) - Required - Quantity of a component in a set.

### Response
#### Success Response (200)
- **result** (array) - List of results containing bundleId, productIdent, productFaultCode, and productFaultString.

#### Multi-Status Response (207)
- **result** (array) - List of results containing bundleId, productIdent, and productFaultCode.
```

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

### GET /promotions/settings

Source: https://idosell.readme.io/reference/promotionssettingsgetget

Retrieves the current configuration settings for the promotion module.

```APIDOC
## GET /promotions/settings

### Description
Retrieves the current configuration settings for the promotion module, including archiving rules, display preferences, and default date/time suggestions.

### Method
GET

### Endpoint
/promotions/settings

### Response
#### Success Response (200)
- **daysLeftToArchive** (integer) - Days to archive
- **daysLeftToRemove** (integer) - Days to remove from archive
- **showPriceOnProductsList** (integer) - Show promo price on products list
- **automaticallySuggestDefaultStartDate** (string) - Automatically suggest default start date (on/off)
- **automaticallySuggestDefaultEndDate** (string) - Automatically suggest default end date (on/off)
- **defaultStartDate** (integer) - Default start date
- **defaultEndDate** (integer) - Default end date
- **defaultStartTime** (integer) - Default start time
- **defaultEndTime** (integer) - Default end time
- **daysLeftToClose** (integer) - Days to automatically close empty promotions
```

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

### GET /snippets

Source: https://idosell.readme.io/reference/snippetssnippetsget-1

Retrieves a list of all code snippets.

```APIDOC
## GET /snippets

### Description
This call returns all snippets.

### Method
GET

### Endpoint
/snippets
```

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

### GET /returns/statuses

Source: https://idosell.readme.io/reference/returnsstatusesget

Retrieves all configurable return statuses.

```APIDOC
## GET /returns/statuses

### Description
Allows to download all configurable return statuses.

### Method
GET

### Endpoint
/returns/statuses

### Response
#### Success Response (200)
- **statuses** (array) - List of return statuses.
  - **id** (integer) - Status identifier.
  - **description** (string) - Status description.

#### Response Example
{
  "statuses": [
    {
      "id": 1,
      "description": "description"
    }
  ]
}
```

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

### POST /products/bundles/bundles

Source: https://idosell.readme.io/reference/productsbundlesbundlespost

Creates a new product bundle and assigns existing products as components.

```APIDOC
## POST /products/bundles/bundles

### Description
createBundle method allows to create a new product with a type: set and to assign existing products as a set components. Products added via this gate are hidden from the shop customer by default. To change the visibility of created products use the gate setProducts or set it on a product card in the shop administration panel

### Method
POST

### Endpoint
/products/bundles/bundles

### Request Body
- **params** (array) - Required - Parameters transmitted to method
  - **products** (array) - Optional - Products list.
    - **productIdent** (object) - Optional - Stock keeping unit.
      - **productIdentType** (string) - Optional - Identifier type. Enum: ["id", "index", "codeExtern", "codeProducer"]
      - **identValue** (string) - Optional - ID value.
    - **productSizes** (array) - Optional - Sizes available for products data.
      - **size** (string) - Optional - Size identifier
      - **sizePanelName** (string) - Optional - Size name
    - **addType** (string) - Optional - Enum: ["selectedSizes", "selectedSizesAsSeparateItems"]
```

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

### POST /products/bundles/products

Source: https://idosell.readme.io/reference/productsbundlesproductspost

Adds components to existing sets in the administration panel.

```APIDOC
## POST /products/bundles/products

### Description
addProductsToBundle method allows to add components to existing sets in the administration panel.

### Method
POST

### Endpoint
/products/bundles/products

### Request Body
- **params** (array) - Required - Parameters transmitted to method
  - **products** (array) - Required - Products list.
    - **productIdent** (object) - Required - Stock keeping unit.
      - **productIdentType** (string) - Required - Identifier type. Enum: ["id", "index", "codeExtern", "codeProducer"]
      - **identValue** (string) - Required - ID value.
    - **productSizes** (array) - Optional - Sizes available for products data.
      - **size** (string) - Optional - Size identifier
      - **sizePanelName** (string) - Optional - Size name
    - **addType** (string) - Required - Way of adding a product to a set: "selectedSizes", "selectedSizesAsSeparateItems", "allSizes", "allSizesWithVariants"
```

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

### GET /promotions/promotions/get

Source: https://idosell.readme.io/reference/promotionspromotionsgetget

Retrieves the details of a specific promotion.

```APIDOC
## GET /promotions/promotions/get

### Description
Retrieves detailed information for a specific promotion identified by its ID.

### Method
GET

### Endpoint
/promotions/promotions/get

### Parameters
#### Query Parameters
- **promotionId** (integer) - Required - The unique identifier of the promotion to retrieve.

### Response
#### Success Response (200)
- **data** (object) - The promotion details object.
- **isError** (boolean) - Indicates if the request resulted in an error.
- **errors** (array) - A list of error objects if any occurred.
```

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

### GET /orders/statuses

Source: https://idosell.readme.io/reference/ordersstatusesget

Retrieves all configurable order statuses.

```APIDOC
## GET /orders/statuses

### Description
Allows to download all configurable order statuses.

### Method
GET

### Endpoint
/orders/statuses

### Response
#### Success Response (200)
- **statuses** (array) - List of order statuses
  - **id** (integer) - Status identifier
  - **parentId** (string) - Parent status identifier
  - **panelName** (string) - Status name in the panel

#### Response Example
{
  "statuses": [
    {
      "id": 103,
      "parentId": "1",
      "panelName": "Packed by Employee#1"
    }
  ]
}
```

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

### OpenAPI Definition for Promotions Start

Source: https://idosell.readme.io/reference/promotionspromotionsstartpost

The complete OpenAPI specification for the promotions/promotions/start endpoint, including security schemes, error models, and request/response structures.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "API ADMIN",
    "description": "API ADMIN",
    "version": "v8.7"
  },
  "servers": [
    {
      "url": "https://{domain}/api/admin/v8",
      "variables": {
        "domain": {
          "default": "clientXXX.idosell.com",
          "description": "Your shop domain"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY",
        "description": "Provide the API Key"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Provide the OAuth Token"
      }
    },
    "schemas": {
      "Error": {
        "description": "Generic error model.",
        "properties": {
          "code": {
            "description": "Error code.",
            "type": "string"
          },
          "field": {
            "description": "Field associated with the error.",
            "type": "string",
            "nullable": true
          },
          "message": {
            "description": "Error description.",
            "type": "string",
            "nullable": true
          },
          "value": {
            "description": "Value associated with the error.",
            "type": "string",
            "nullable": true
          },
          "uid": {
            "description": "Unique identifier of the error (for support).",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object"
      },
      "GeneralError": {
        "description": "Common errors",
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/InputError"
          },
          {
            "properties": {
              "errorCode": {
                "description": "Possible values: \n  - unexpected_error\n  - invalid_language_code\n  - invalid_language_for_shop\n  - invalid_shop\n  - invalid_date_range\n  - invalid_number_range\n  - collection_is_empty\n  - collection_limit_exceeded\n  - invalid_parameter_for_post_method\n  - invalid_parameter_for_put_method\n  - no_data\n  - connection_error\n  - forbidden\n  - vpn_required\n",
                "type": "string",
                "example": "unexpected_error"
              }
            }
          }
        ]
      },
      "InputError": {
        "description": "Error resulting from incorrect values passed in the request.",
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/Error"
          },
          {
            "properties": {
              "errorCode": {
                "type": "string"
              }
            }
          }
        ]
      },
      "PromotionIdDTO": {
        "required": [
          "promotionId"
        ],
        "properties": {
          "promotionId": {
            "description": "ID of promotion",
            "type": "integer",
            "example": 12
          }
        },
        "type": "object"
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "PIM",
      "description": "PIM description"
    }
  ],
  "paths": {
    "/promotions/promotions/start": {
      "post": {
        "tags": [
          "PIM"
        ],
        "summary": "promotions/promotions/start",
        "operationId": "promotions/promotions/start/post",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PromotionIdDTO"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "type": "integer"
                    },
                    "isError": {
                      "type": "boolean"
                    },
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Error"
                      }
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "207": {
            "description": "Multi-Status"
          },
          "401": {
            "description": "Authorization error"
          },
          "403": {
            "description": "Access denied"
          },
          "404": {
            "description": "Not found"
          },
          "422": {
            "description": "Invalid data format",
            "content": {
              "application/json": {
                "schema": {

```

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

### GET /cpa/campaign

Source: https://idosell.readme.io/reference/cpacampaignget-1

Retrieves a list of all CPA campaigns.

```APIDOC
## GET /cpa/campaign

### Description
Returns all CPA campaigns.

### Method
GET

### Endpoint
/cpa/campaign

### Response
#### Success Response (200)
- **results** (array) - List of CpaCampaign objects.
```

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

### GET /products/sizes

Source: https://idosell.readme.io/reference/productssizesget

Retrieves a list of product sizes and their associated details.

```APIDOC
## GET /products/sizes

### Description
Retrieves a list of product sizes and their associated details.

### Method
GET

### Endpoint
/products/sizes

### Response
#### Success Response (207)
- **results** (array) - Object contains detailed information on result of operation.
  - **productId** (integer) - Product IAI code
  - **sizesResult** (array) - List of sizes
    - **sizeId** (string) - Size identifier
    - **sizePanelName** (string) - Size name
```

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

### GET /couriers

Source: https://idosell.readme.io/reference/courierscouriersget

Retrieves a list of courier companies.

```APIDOC
## GET /couriers

### Description
Retrieves a list of courier companies available in the system.

### Method
GET

### Endpoint
/couriers

### Response
#### Success Response (207)
- **resultsNumberAll** (integer) - Number of all results found
- **resultsNumberPage** (integer) - Number of pages of results found
- **resultsPage** (integer) - Page with results number. Numeration starts from 0
- **resultsLimit** (integer) - Number of results on page. Value from 1 to 100
- **result** (array) - Parameters concerning returned results
  - **courierId** (integer) - Courier ID.
  - **name** (string) - Courier name.
  - **hasPickupPoints** (boolean) - Information if a courier delivers to personal collection points.
  - **companyKey** (string) - Courier company
- **errors** (object) - Error details if applicable
  - **faultCode** (integer) - Error code.
  - **faultString** (string) - Error description.

#### Response Example
{
  "resultsNumberAll": 1,
  "resultsNumberPage": 1,
  "resultsPage": 0,
  "resultsLimit": 100,
  "result": [
    {
      "courierId": 1,
      "name": "name",
      "hasPickupPoints": true,
      "companyKey": "poczta"
    }
  ]
}
```

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

### GET /regulations/history

Source: https://idosell.readme.io/docs/81

Retrieves the change history for regulations.

```APIDOC
## GET /regulations/history

### Description
Retrieve regulation change history.

### Method
GET

### Endpoint
/regulations/history

### Parameters
#### Query Parameters
- **type** (string) - Optional - Type of history
- **shopId** (integer) - Optional - Shop's ID
- **country** (string) - Optional - Country ISO code
- **langId** (string) - Optional - Language ISO code
- **resultsPage** (integer) - Optional - Page number, starts at 0
- **resultsLimit** (integer) - Optional - Results per page (1–100)
```

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

### POST /products/bundles

Source: https://idosell.readme.io/reference/productsbundlesproductspost

Creates a new product bundle by specifying bundle identifiers and component quantities.

```APIDOC
## POST /products/bundles

### Description
Creates a new product bundle. This endpoint allows you to define bundle components and their respective quantities.

### Method
POST

### Endpoint
/products/bundles

### Request Body
- **bundleIdent** (object) - Required - Identifier for the bundle.
  - **productIdentType** (string) - Required - Identifier type (id, index, codeExtern, codeProducer).
  - **identValue** (string) - Required - ID value.

### Response
#### Success Response (200)
- **result** (array) - List of results for the bundle operation.
  - **bundleIdent** (object) - The bundle identifier.
  - **productIdent** (object) - The product identifier.
  - **productFaultCode** (string) - Error code if applicable.
  - **productFaultString** (string) - Error description if applicable.
```

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

### GET /products/sizes

Source: https://idosell.readme.io/reference/productssizesget

Returns information about product sizes configured in the administration panel.

```APIDOC
## GET /products/sizes

### Description
Method that returns information about product sizes configured in the administration panel.

### Method
GET

### Endpoint
/products/sizes

### Parameters
#### Query Parameters
- **result::page** (integer) - Optional - Page with results number. Numeration starts from 0.
- **result::pageNumber** (integer) - Optional - Number of results on page. Value from 1 to 100.

### Response
#### Success Response (200)
- **results** (array) - Object contains detailed information on result of operation.

#### Response Example
{
  "results": [
    {
      "productId": 1,
      "sizesResult": [
        {
          "sizeId": "sizeId",
          "sizePanelName": "sizePanelName",
          "productProducerCode": "productProducerCode",
          "productSizeCodeExternal": "productSizeCodeExternal",
          "productWeight": 1,
          "sites": []
        }
      ]
    }
  ]
}
```

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

### GET /shops/languages

Source: https://idosell.readme.io/reference/shopslanguagesget

Retrieves a list of languages available for the shop.

```APIDOC
## GET /shops/languages

### Description
Retrieves the list of available languages for the shop, including their names, ISO codes, and configuration status.

### Method
GET

### Endpoint
/shops/languages

### Response
#### Success Response (200)
- **shopName** (string) - Shop name
- **inherited** (boolean) - Language setting inherited from another shop
- **languages** (array) - List of available languages
  - **id** (string) - Language id
  - **name** (string) - Language name
  - **isoCode** (string) - Language ISO code
  - **enabled** (boolean) - Whether the language is enabled
  - **isDefault** (boolean) - Whether the language is set as default

#### Error Responses
- **401** - Authorization error
- **403** - Access denied
- **404** - Not found
- **422** - Invalid data format
- **429** - Too many requests
- **500** - Internal server error
```

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

### POST /promotions/promotions/add

Source: https://idosell.readme.io/reference/promotionspromotionsaddpost

Creates a new promotion by sending the required promotion data.

```APIDOC
## POST /promotions/promotions/add

### Description
Creates a new promotion in the system.

### Method
POST

### Endpoint
/promotions/promotions/add

### Request Body
- **request** (object) - Required - The promotion data object containing details like newPriceValue and activeInShops.

### Response
#### Success Response (200)
- **data** (integer) - The ID of the created promotion.
- **isError** (boolean) - Indicates if the operation resulted in an error.
```

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

### GET /rma/statuses

Source: https://idosell.readme.io/reference/rmastatusesget

Retrieves a list of all possible complaint statuses.

```APIDOC
## GET /rma/statuses

### Description
Allows to download all possible complaint statuses.

### Method
GET

### Endpoint
/rma/statuses

### Response
#### Success Response (200)
- **statuses** (array) - List of complaint statuses
  - **id** (integer) - Status identifier
  - **description** (string) - Status description

#### Response Example
{
  "statuses": [
    {
      "id": 1,
      "description": "description"
    }
  ]
}
```
Tokens:
Raw