### Start Promotion Source: https://idosell.readme.io/reference/promotionspromotionsstartpost Initiates a promotion. This endpoint is used to start a new promotion or resume a paused one. ```APIDOC ## POST /promotions/start ### Description Starts a promotion. ### Method POST ### Endpoint /promotions/start ### Response #### Success Response (200) - **promotionId** (string) - The ID of the started promotion. - **status** (string) - The status of the promotion (e.g., "active"). #### Response Example { "promotionId": "promo_12345", "status": "active" } #### Error Response (400) - **isError** (boolean) - Indicates if an error occurred. - **errors** (array) - A list of errors. - **code** (string) - Error code. - **message** (string) - Error message. #### Response Example { "isError": true, "errors": [ { "code": "INVALID_PROMOTION_ID", "message": "The provided promotion ID is invalid." } ] } #### Error Response (429) - **description**: Too many requests #### Error Response (500) - **description**: Internal server error ``` -------------------------------- ### Confirmation of Installation Source: https://idosell.readme.io/docs/api-endpoints Notify IdoSell Apps that the online application installation process is complete by sending a webhook with license and application information. ```APIDOC ## POST https://apps.idosell.com/api/application/installation/done ### Description For 'online' applications, when the installation is complete, notify IdoSell Apps by sending a webhook with information about the license and the application to which the installation applies. ### Method POST ### Endpoint https://apps.idosell.com/api/application/installation/done ### Parameters #### 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['ok', 'error']) - Status of the operation - **errors** (array[string]) - Optional - List of errors - **sign** (string) - Communication signature ### Request Example ```json { "api_license": "LICENSE-12345", "application_id": 123, "developer": "developer_login", "sign": "your_signature" } ``` ### Response Example ```json { "status": "ok", "sign": "response_signature" } ``` ``` -------------------------------- ### cURL PUT Request Example Source: https://idosell.readme.io/reference/packagespackagesput This example demonstrates how to construct a cURL request to update package information. Ensure you include the correct authentication headers and content type. ```shell curl --request PUT \ --url https://clientxxx.idosell.com/api/admin/v8/packages/packages \ --header 'accept: application/json' \ --header 'content-type: application/json' ``` -------------------------------- ### 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 ``` -------------------------------- ### OpenAPI Definition for Starting Promotion Source: https://idosell.readme.io/reference/promotionspromotionsstartpost This OpenAPI definition describes the structure for starting a promotion, including request parameters and possible response codes such as 'Too many requests' or 'Internal server error'. ```yaml paths: /promotions/start: post: summary: Starting promotion responses: "200": description: Promotion started successfully content: application/json: schema: type: object properties: isError: type: boolean errors: type: array items: $ref: "#/components/schemas/GeneralError" "429": description: Too many requests "500": description: Internal server error ``` -------------------------------- ### Confirm Application Installation Source: https://idosell.readme.io/docs/api-endpoints Notify IdoSell Apps that an online application installation is complete. This webhook is sent after the initial installation request and triggers the start of the trial period and visibility in the admin panel. ```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 } ``` -------------------------------- ### 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
John Smith Very Good Shop PL PL-ZP 71-043 Szczecin
Piastow 4d / Warehouse 1 / Section G
48 91 43 33 881 business
``` -------------------------------- ### Get Promotion Settings Source: https://idosell.readme.io/reference/promotionssettingsgetget Fetches the promotion module configuration. ```APIDOC ## GET /promotions/settings/get ### Description Get promotion module configuration ### Method GET ### Endpoint /promotions/settings/get ### Responses #### Success Response (200) - **data** (PromotionSettings) - The promotion settings configuration. - **isError** (boolean) - Indicates if an error occurred. - **errors** (array of Error) - A list of errors, if any. #### Error Responses - **207** Multi-Status - **401** Authorization error - **403** Access denied - **404** Not found - **422** Invalid data format - **429** Too many requests - **500** Internal server error ``` -------------------------------- ### OpenAPI Definition Example Source: https://idosell.readme.io/reference/clientsprofitpointspost This is an example of an OpenAPI definition. ```json { "description": "Internal server error" } ``` -------------------------------- ### Webhook for Online Application Installation Completion Source: https://idosell.readme.io/docs/how-to-prepare-the-application This webhook is sent to IdoSell Apps to confirm the successful installation of an online application. It includes license and application details for tracking. ```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 } ``` -------------------------------- ### OpenAPI Definition for Product Descriptions Source: https://idosell.readme.io/reference/productsdescriptionsput This snippet details the structure for product descriptions within the OpenAPI definition, including fields like 'example' and 'faultString'. It specifies data types and provides example values for clarity. ```json { "example": "1" }, "faultString": { "type": "string", "description": "Error description.", "example": "faultString" } } } } } }, "errorsOccurred": { "type": "boolean", "description": "Information about whether any errors occurred." }, "errors": { "type": "object", "description": "Information on error that occurred during gate call.", "properties": { "faultCode": { "type": "integer", "description": "Error code.", "example": "1" }, "faultString": { "type": "string", "description": "Error description.", "example": "faultString" } } } } } } } } }, "401": { "description": "Authorization error" }, "403": { "description": "Access denied" }, "404": { "description": "Not found" }, "422": { "description": "Invalid data format" }, "429": { "description": "Too many requests" }, "500": { "description": "Internal server error" } } } } } ``` -------------------------------- ### Notify IdoSell of Online Application Installation Completion Source: https://idosell.readme.io/docs/how-to-prepare-the-application After successfully installing an online application for a merchant, send this webhook to IdoSell Apps to confirm completion. This initiates the trial period and makes the application visible in the merchant panel. ```APIDOC ## Notify IdoSell of Online Application Installation Completion ### Description This endpoint is used by online applications to notify IdoSell Apps that the installation process for a merchant has been successfully completed. This action triggers the start of the trial period and makes the application available to the merchant. ### Method POST ### Endpoint `https://apps.idosell.com/api/application/installation/done` ### Request Body - **api_license** (string) - Required - The license number of the application. - **application_id** (int) - Required - The unique identifier for the application. - **developer** (string) - Required - The developer's login username. - **sign** (string) - Required - A communication signature for verifying the request. ### Response #### Success Response (200) - **status** (string) - Indicates 'ok' if the installation confirmation was processed successfully. - **sign** (string) - A communication signature for the response. #### Response Example ```json { "status": "ok", "sign": "your_response_signature" } ``` ``` -------------------------------- ### cURL Request Example Source: https://idosell.readme.io/reference/subscriptionslistviewfetchidspost Demonstrates how to make a POST request to the subscriptions/listView/fetchIds endpoint using cURL. Ensure to replace placeholders like {domain} and clientxxx with your actual domain and client identifier. ```shell curl --request POST \ --url https://clientxxx.idosell.com/api/admin/v8/subscriptions/listView/fetchIds \ --header 'content-type: application/json' ``` -------------------------------- ### 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 } ``` -------------------------------- ### Get Product Strikethrough Prices Source: https://idosell.readme.io/reference/productsstrikethroughpricesget Allows for getting information about product strikethrough price settings. ```APIDOC ## GET /products/strikethroughPrices ### Description Allows for getting information about product strikethrough price settings. ### Method GET ### Endpoint /products/strikethroughPrices ### Parameters #### Query Parameters - **identType** (string) - Required - Identifier type. Possible values: "id", "index", "codeExtern", "codeProducer". - **products** (array) - Optional - Products list. Each element should be a product identifier string. ### Response #### Success Response (200) - **products** (array) - Products list. Each item is an object containing: - **ident** (object) - Identifier type. - **type** (string) - Identifier type. Possible values: "id", "index", "codeExtern", "codeProducer". - **value** (string) - Value of the identifier. - **strikethrough_retail_price** (number) - Strikethrough gross retail price. - **strikethrough_wholesale_price** (number) - Strikethrough gross wholesale price. - **shops** (array) - List of shop-specific pricing. - **shop_id** (integer) - Shop Id. - **strikethrough_retail_price** (number) - Strikethrough gross retail price for the shop. ``` -------------------------------- ### Start Promotion Source: https://idosell.readme.io/reference/promotionspromotionsstartpost Initiates a promotion by its ID. This endpoint is part of the PIM (Product Information Management) module. ```APIDOC ## POST /promotions/promotions/start ### Description Starts a promotion using its unique identifier. ### Method POST ### Endpoint /promotions/promotions/start ### Request Body - **promotionId** (integer) - Required - ID of promotion ### Request Example { "promotionId": 12 } ### Response #### Success Response (200) - **data** (integer) - Description of the data returned. - **isError** (boolean) - Indicates if an error occurred. - **errors** (array) - A list of errors, if any. - **code** (string) - Error code. - **field** (string) - Field associated with the error. - **message** (string) - Error description. - **value** (string) - Value associated with the error. - **uid** (string) - Unique identifier of the error (for support). #### Response Example { "data": 1, "isError": false, "errors": [] } #### Error Responses - **207** Multi-Status - **401** Authorization error - **403** Access denied - **404** Not found - **422** Invalid data format ``` -------------------------------- ### Get System Configuration Source: https://idosell.readme.io/reference/systemconfigget Retrieves information about a shop and its most important configuration settings. ```APIDOC ## GET /api/admin/v8/system/config ### Description This endpoint is used for extracting information about a shop and its most important configuration settings. ### Method GET ### Endpoint https://{domain}/api/admin/v8/system/config ### Responses #### Success Response (200) OK #### Multi-Status Response (207) Multi-Status #### Error Responses - **401**: Authorization error - **403**: Access denied - **404**: Not found - **422**: Invalid data format - **429**: Too many requests - **500**: Internal server error ### Request Example ```json { "example": "request body" } ``` ### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Promotion Module Configuration Source: https://idosell.readme.io/reference/promotionssettingsgetget This endpoint retrieves the current configuration settings for the promotion module. ```APIDOC ## GET promotions/settings/get ### Description Retrieves the configuration settings for the promotion module. ### Method GET ### Endpoint /promotions/settings/get ### Response #### Success Response (200) - **configuration** (object) - The promotion module configuration settings. ``` -------------------------------- ### Menu Filter Get API Error Handling Source: https://idosell.readme.io/reference/menufilterget This section details the possible error responses for the Menu Filter Get API. ```APIDOC ## Menu Filter Get API Error Responses ### Description This endpoint may return various HTTP status codes to indicate the outcome of the request. Below are the common error codes and their meanings. ### Error Handling - **401**: Unauthorized - Authentication credentials are missing or invalid. - **403**: Forbidden - The authenticated user does not have permission to access this resource. - **404**: Not Found - The requested resource could not be found. - **422**: Unprocessable Entity - The request was well-formed but contains semantic errors (e.g., invalid data format). - **429**: Too Many Requests - The client has sent too many requests in a given amount of time. - **500**: Internal Server Error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. ### Error Response Body Example ```json { "faultCode": 1, "faultString": "Error description." } ``` #### Response Example (422 Unprocessable Entity) ```json { "errors": { "field_name": [ "Error message for the field." ] } } ``` ``` -------------------------------- ### Get Product Questions Source: https://idosell.readme.io/reference/productsquestionsget This method allows you to download a list of questions related to products available in the IdoSell Shop administration panel. ```APIDOC ## GET /products/questions ### Description Retrieves a list of questions associated with products in the IdoSell Shop. ### Method GET ### Endpoint /products/questions ### Parameters #### Query Parameters * **product_id** (integer) - Optional - The ID of the product to filter questions by. * **category_id** (integer) - Optional - The ID of the category to filter questions by. * **limit** (integer) - Optional - The maximum number of questions to return. * **offset** (integer) - Optional - The number of questions to skip before returning results. ### Response #### Success Response (200) - **questions** (array) - A list of question objects. - **question_id** (integer) - The unique identifier for the question. - **product_id** (integer) - The ID of the product the question is associated with. - **question_text** (string) - The text of the question. - **answer_text** (string) - The text of the answer to the question. - **created_at** (string) - The timestamp when the question was created. - **updated_at** (string) - The timestamp when the question was last updated. #### Response Example ```json { "questions": [ { "question_id": 1, "product_id": 101, "question_text": "What is the warranty period?", "answer_text": "The warranty period is 2 years.", "created_at": "2023-10-27T10:00:00Z", "updated_at": "2023-10-27T10:00:00Z" } ] } ``` ``` -------------------------------- ### Get Orders Auction Details Source: https://idosell.readme.io/reference/ordersauctiondetailsget Retrieves information about external listings assigned to orders. You can filter by order identifiers to get specific auction details. ```APIDOC ## GET /orders/auctionDetails ### Description Method that enables getting information about external listings assigned to orders in the administration panel. ### Method GET ### Endpoint /orders/auctionDetails ### Parameters #### Query Parameters - **identType** (string) - Required - Identifier type. Possible values: `orders_id`, `orders_sn`. - **orders** (array[string]) - Optional - Orders Id values. Each element is an ID value. ### Response #### Success Response (200) - **auctions** (array) - External listings - orders table. - **orderIdent** (object) - Order ID. - **orderIdentType** (string) - Identifier type. Possible values: `orders_id`, `orders_sn`. - **identValue** (string) - ID value. - **auctionsDetails** (array) - The auctions array for the order. - **auctionItemId** (string) - Auction number. - **auctionUrl** (string) - Link to the auction, from which the order came. - **auctionStartDate** (string) - Auction start date. - **auctionEndingDate** (string) - Auction end date. ``` -------------------------------- ### products/idBySizecode GET Source: https://idosell.readme.io/reference/productsidbysizecodeget Fetches product IDs, size IDs, and names using product external system codes. ```APIDOC ## GET /products/idBySizecode ### Description Method that returns information about product IDs, as well as size IDs and names, based on the provided product external system codes. ### Method GET ### Endpoint /products/idBySizecode ### Parameters #### Query Parameters - **codes** (array[string]) - Optional - Search codes. - **type** (string) - Optional - Type of codes. Acceptable values: "external" (default value) - external system code, "producer" - producer code, and "all" - any of the above codes ### Response #### Success Response (200) - **results** (array[object]) - Object contains detailed information on result of operation. - **productSizeCode** (string) - Searching code. - **productId** (integer) - Product IAI code - **sizeId** (string) - Size identifier - **sizePanelName** (string) - Size name - **productWithIndicatedCodeExists** (boolean) - Does the product with the specified code exist. - **productIsDeleted** (boolean) - Element determines whether product is deleted #### Response Example ```json { "results": [ { "productSizeCode": "productSizeCode", "productId": 1, "sizeId": "sizeId", "sizePanelName": "sizePanelName", "productWithIndicatedCodeExists": true, "productIsDeleted": false } ] } ``` #### Multi-Status Response (207) - **results** (array[object]) - Object contains detailed information on result of operation. - **productSizeCode** (string) - Searching code. ``` -------------------------------- ### Products Strikethrough Prices GET Endpoint Source: https://idosell.readme.io/reference/productsstrikethroughpricesget This snippet details the structure of the response for the products strikethrough prices GET request, including success and error scenarios. ```APIDOC ## GET /products/strikethrough-prices ### Description Retrieves a list of products with their strikethrough prices. ### Method GET ### Endpoint /products/strikethrough-prices ### Parameters #### Query Parameters - **ids** (array) - Optional - A list of product IDs to filter the results. - **limit** (integer) - Optional - The maximum number of results to return. - **offset** (integer) - Optional - The number of results to skip. ### Response #### Success Response (200) - **data** (array) - An array of product objects, each containing pricing information. - **id** (integer) - The product ID. - **name** (string) - The product name. - **price** (object) - The current price of the product. - **gross** (number) - The gross price. - **net** (number) - The net price. - **strikethrough_price** (object) - The strikethrough price of the product. - **gross** (number) - The gross strikethrough price. - **net** (number) - The net strikethrough price. #### Error Response - **error** (object) - Information about the error that occurred. - **faultCode** (integer) - The error code. Possible values include: - "0" - Operation was successful. - "1" - Login failure: invalid username or key. - "3" - Shop has been blocked due to number of overdue invoices owed to IAI Company. - "4" - Incorrect product ID sent. - "5" - Wrong size ID sent. - **faultString** (string) - A description of the error. ### Response Example (200 OK) ```json { "data": [ { "id": 123, "name": "Example Product", "price": { "gross": 100.00, "net": 80.00 }, "strikethrough_price": { "gross": 120.00, "net": 96.00 } } ] } ``` ### Response Example (Error) ```json { "error": { "faultCode": 4, "faultString": "Incorrect product ID sent" } } ``` ``` -------------------------------- ### Add Products to Bundle Source: https://idosell.readme.io/reference/productsbundlesproductspost The `products/bundles/products` POST endpoint allows you to add components to existing product sets (bundles) in the administration panel. You can specify how products are added, including which sizes are included or if all sizes should be available to customers. ```APIDOC ## POST /products/bundles/products ### Description Adds components to existing sets in the administration panel. ### Method POST ### Endpoint /products/bundles/v8/products ### Request Body - **params** (array) - Required - Parameters transmitted to the 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) - Required - Size identifier. - **sizePanelName** (string) - Required - Size name. - **addType** (string) - Required - Way of adding a product to a set. Enum: "selectedSizes", "selectedSizesAsSeparateItems", "allSizes", "allSizesWithVariants". ### Request Example { "params": [ { "products": [ { "productIdent": { "productIdentType": "id", "identValue": "12345" }, "productSizes": [ { "size": "S", "sizePanelName": "Small" } ], "addType": "selectedSizes" } ] } ] } ### Response #### Success Response (200) (Response structure not detailed in the source) ``` -------------------------------- ### Orders Profitability GET Endpoint Source: https://idosell.readme.io/reference/ordersprofitabilityget This snippet details the structure of the response for the Orders Profitability GET endpoint, outlining the various cost components and profit metrics available. ```APIDOC ## GET /orders/profitability ### Description Retrieves profitability details for a specific order or a batch of orders. ### Method GET ### Endpoint `/orders/profitability` ### Query Parameters * **orderId** (string) - Required - The ID of the order to retrieve profitability for. ### Response #### Success Response (200) - **shippingShopCosts** (number) - Cost for shop. - **insuranceShopCosts** (number) - Insurance cost borne by the store (net). - **acquisitionCost** (number) - Costs of gaining order (net). - **profitMargin** (number) - Profit margin (gain from order). - **profitMarginPercent** (number) - Percentage margin (gain from order). - **errors** (object) - Information on error that occurred during gate call. - **faultCode** (integer) - Error code. - **faultString** (string) - Error description. #### Response Example ```json { "shippingShopCosts": 20.12, "insuranceShopCosts": 20.12, "acquisitionCost": 20.12, "profitMargin": 20.12, "profitMarginPercent": 20.12, "errors": { "faultCode": 1, "faultString": "faultString" } } ``` #### Error Responses - **401** - Authorization error - **403** - Access denied - **404** - Not found - **422** - Invalid data format - **429** - Too many requests - **500** - Internal server error ``` -------------------------------- ### cURL Request for System Configuration Source: https://idosell.readme.io/reference/systemconfigget Use this cURL command to retrieve shop and configuration settings. Ensure you replace `{domain}` with your actual client domain. ```shell curl --request GET \ --url https://clientxxx.idosell.com/api/admin/v8/system/config \ --header 'accept: application/json' ``` -------------------------------- ### Clients Membership Cards GET Operation Source: https://idosell.readme.io/reference/clientsmembershipcardsget This snippet details the structure of the response for the GET operation related to client membership cards, including success and error scenarios. ```APIDOC ## GET /clients/membershipCards ### Description Retrieves details about client membership cards. ### Method GET ### Endpoint /clients/membershipCards ### Parameters #### Query Parameters - **client_id** (integer) - Required - The ID of the client. - **card_id** (integer) - Optional - The ID of the membership card. ### Response #### Success Response (200) - **data** (object) - Contains membership card details. - **card_number** (string) - The membership card number. - **pin** (integer) - The card PIN. - **expires_date** (string) - The card expiration date. #### Error Response - **errors** (object) - Information on error that occurred during gate call. - **faultCode** (integer) - Error code. Possible values: 2 (Empty result), 3 (No parameters were received), 4 (Shop has been blocked due to number of overdue invoices owed to IAI Company). - **faultString** (string) - Error description. #### Error Codes - **401**: Authorization error - **403**: Access denied - **404**: Not found - **422**: Invalid data format - **429**: Too many requests - **500**: Internal server error ``` -------------------------------- ### Get Products Source: https://idosell.readme.io/reference/productsproductsget Retrieves a list of products with detailed pricing information. This endpoint can optionally include promotional prices if the 'showPromotionsPrices' parameter is specified. ```APIDOC ## GET /products ### Description Retrieves a list of products. The response includes various pricing details such as minimal price, automatic calculation price, suggested price, strikethrough prices, and wholesale prices. Promotional prices can be included if the `showPromotionsPrices` query parameter is set to true. ### Method GET ### Endpoint /products ### Query Parameters - **showPromotionsPrices** (boolean) - Optional - If true, the response will include promotional prices (`productPromoRetailPrice`, `productPromoWholesalePrice`). ### Response #### Success Response (200) - **products** (array) - An array of product objects. - Each product object contains fields like: - **productRetailPrice** (number) - Gross retail price. - **productPromoRetailPrice** (number) - Gross retail price after promotion (if `showPromotionsPrices` is true). - **productWholesalePrice** (number) - Wholesale price. - **productPromoWholesalePrice** (number) - Wholesale price after promotion (if `showPromotionsPrices` is true). - **productMinimalPrice** (number) - Minimal price. - **productAutomaticCalculationPrice** (number) - Price for automatic calculations. - **productSuggestedPrice** (number) - Recommended retail price. - **productStrikethroughRetailPrice** (number) - Strikethrough gross retail price. - **productStrikethroughWholesalePrice** (number) - Strikethrough gross wholesale price. - **productShopPriceComparisonSitesPrices** (array) - Information about prices for price comparison websites dependent on a shop. - Each item in the array contains: - **priceComparisonSiteId** (integer) - price comparison website ID. - **productPriceComparisonSitePercentDiff** (number) - Percentage difference between the price comparison website and the shop. - **productPriceComparisonSitePrice** (number) - Price for a price comparison website in a shop. #### Response Example ```json { "products": [ { "productRetailPrice": 20.12, "productPromoRetailPrice": 18.00, "productWholesalePrice": 15.00, "productPromoWholesalePrice": 13.50, "productMinimalPrice": 14.00, "productAutomaticCalculationPrice": 14.50, "productSuggestedPrice": 22.00, "productStrikethroughRetailPrice": 25.00, "productStrikethroughWholesalePrice": 18.00, "productShopPriceComparisonSitesPrices": [ { "priceComparisonSiteId": 1, "productPriceComparisonSitePercentDiff": 5.0, "productPriceComparisonSitePrice": 21.13 } ] } ] } ``` ``` -------------------------------- ### OpenAPI Definition for Products Opinions Rate Get Source: https://idosell.readme.io/reference/productsopinionsrateget This snippet shows a portion of the OpenAPI definition for the Products Opinions Rate Get endpoint, detailing response structures and error codes. ```json { "description": "Authorization error" }, "403": { "description": "Access denied" }, "404": { "description": "Not found" }, "422": { "description": "Invalid data format" }, "429": { "description": "Too many requests" }, "500": { "description": "Internal server error" } } } } } ``` -------------------------------- ### Get Promotion Settings Source: https://idosell.readme.io/reference/promotionssettingsgetget Retrieves the current promotion settings for the shop. ```APIDOC ## GET /promotion/settings ### Description Retrieves the current promotion settings for the shop. ### Method GET ### Endpoint /promotion/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 #### Response Example { "daysLeftToArchive": 30, "daysLeftToRemove": 30, "showPriceOnProductsList": 0, "automaticallySuggestDefaultStartDate": "off", "automaticallySuggestDefaultEndDate": "off", "defaultStartDate": 0, "defaultEndDate": 0, "defaultStartTime": 0, "defaultEndTime": 0, "daysLeftToClose": 10 } ``` -------------------------------- ### Product Pricing and Configuration Source: https://idosell.readme.io/reference/productsproductsget This section details the various price-related fields available for products, including retail, wholesale, and automatic calculation prices, as well as configuration options for how prices are set. ```APIDOC ## Product Pricing and Configuration Details ### Description Provides detailed information about product pricing strategies and configurations. ### Fields - **productAutomaticCalculationPrice** (number) - Price for automatic calculations. Example: "20.12" - **productPricesConfig** (string) - Price settings. Possible values: "wholesale_equals_retail", "wholesale_notequals_retail", "all_prices_equals_zero", "retail_price_equals_zero", "default_prices", "retail_equals_suggested", "automatically_calculated". Example: "productPricesConfig" - **currencyId** (string) - Currency ID. Example: "currencyId" - **productSuggestedPrice** (number) - Recommended retail price. Example: "20.12" - **productStrikethroughRetailPrice** (number) - Strikethrough gross retail price. Example: "20.12" - **productStrikethroughWholesalePrice** (number) - Strikethrough gross wholesale price. Example: "20.12" - **productConfigPricesDefaultShop** (integer) - Configuration details for setting of parameter prices_config=default_prices. Example: 1 - **productMarginRetailFromAvaragePrices** (number) - Average retail margin against average purchase price. Example: "20.12" - **productMarginWholesaleFromAvaragePrices** (number) - Average wholesale margin against average purchase price. Example: "20.12" - **productPricesConfigAutomatonDetails** (array) - Configuration details for setting of parameter prices_config=automatically_calculated. - **priceAutomatonPriceName** (string) - Price name, one of values: retail, wholsale, minimal. Example: "priceAutomatonPriceName" - **priceAutomatonPriceSettings** (string) - Price setting, one of values: own, last_purchased, avarage_purchased, retail, wholsale, minimal. Example: "priceAutomatonPriceSettings" ``` -------------------------------- ### OpenAPI Definition for Orders Opinions Rate Get Source: https://idosell.readme.io/reference/ordersopinionsrateget This snippet shows the OpenAPI definition for the Orders Opinions Rate Get API, including its paths, parameters, responses, and error codes. ```json { "description": "Authorization error" }, "403": { "description": "Access denied" }, "404": { "description": "Not found" }, "422": { "description": "Invalid data format" }, "429": { "description": "Too many requests" }, "500": { "description": "Internal server error" } } } } } ``` -------------------------------- ### Get Products Source: https://idosell.readme.io/reference/wmsstocksdocumentsproductsget Fetches a list of products available on a warehouse document. ```APIDOC ## GET wms/stocksdocuments/products ### Description Method that enables getting a list of products present on a warehouse document. ### Method GET ### Endpoint /wms/stocksdocuments/products ``` -------------------------------- ### OpenAPI Definition for Products Auctions Get API Source: https://idosell.readme.io/reference/productsauctionsget This OpenAPI definition outlines the structure and possible responses for the Products Auctions Get API. It includes details on success and error status codes. ```yaml openapi: 3.0.0 info: title: Products Auctions Get API version: 1.0.0 paths: /products/auctions/{id}: get: summary: Get auction by ID parameters: - name: id in: path required: true schema: type: integer responses: "200": description: OK "401": description: Access denied "404": description: Not found "422": description: Invalid data format "429": description: Too many requests "500": description: Internal server error components: schemas: ProductAuction: type: object properties: id: type: integer name: type: string description: type: string start_date: type: string format: date-time end_date: type: string format: date-time current_price: type: number seller_id: type: integer winner_id: type: integer ``` -------------------------------- ### Get Order Warehouse Information Source: https://idosell.readme.io/reference/orderswarehouseget Use this GET request to retrieve the warehouse ID and name associated with a given order serial number. Ensure you provide a valid orderSerialNumber as a query parameter. ```json { "openapi": "3.0.0", "info": { "title": "API ADMIN", "description": "API ADMIN", "version": "v8.1" }, "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" } } }, "security": [ { "ApiKeyAuth": [] }, { "bearerAuth": [] } ], "tags": [ { "name": "OMS", "description": "OMS description" } ], "paths": { "/orders/warehouse": { "get": { "tags": [ "OMS" ], "summary": "orders/warehouse", "description": "Method that enables getting information about which warehouse an order is being handled from.", "operationId": "orders/warehouse/get", "parameters": [ { "in": "query", "name": "orderSerialNumber", "style": "form", "explode": false, "required": true, "description": "Order serial number.", "schema": { "type": "integer", "description": "Order serial number.", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "object", "description": "Object contains detailed information on result of operation.", "properties": { "stockId": { "type": "integer", "description": "Stock ID", "example": "1" }, "stockName": { "type": "string", "description": "Stock name.", "example": "stockName" } } } } } } } }, "207": { "description": "Multi-Status", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "object", "description": "Object contains detailed information on result of operation.", "properties": { "stockId": { "type": "integer", "description": "Stock ID", "example": "1" }, "stockName": { "type": "string", "description": "Stock name.", "example": "stockName" } } }, "errors": { "type": "object", "description": "Information on error that occurred during gate call.", "properties": { "faultCode": { "type": "integer", "description": "Error code.", "example": "1" }, "faultString": { "type": "string", "description": "Error description.", "example": "faultString" } } } } } } } }, "401": { "description": "Authorization error" }, "403": { "description": "Access denied" }, "404": { "description": "Not found" }, "422": { "description": "Invalid data format" }, "429": { "description": "Too many requests" }, "500": { "description": "Internal server error" } } } } } } ```