### GET /restapi/products/normal and GET /restapi/products/extended Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves the complete product catalog. Use 'normal' for basic details and 'extended' for detailed descriptions and more information. Requires authentication. ```APIDOC ## GET /restapi/products/normal and GET /restapi/products/extended ### Description Retrieves the complete product catalog. The `/normal` endpoint provides basic product information, while the `/extended` endpoint offers more detailed descriptions, images, and additional data. ### Method GET ### Endpoint `/restapi/products/normal` or `/restapi/products/extended` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```bash # For basic product catalog curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/products/normal" # For extended product catalog curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/products/extended" ``` ### Response #### Success Response (200) - **PRODUCTS** (object) - Contains the product catalog. - **PRODUCT** (array) - List of products, each with detailed fields like CATEGORY, MASTER, MODEL, EAN, NAME, PRICE, DESCRIPTION, etc. #### Response Example ```json { "PRODUCTS": { "PRODUCT": [ { "CATEGORY": "Liquids > Shortfills > Twelve Monkeys", "MASTER": "12M100L10-BG", "MODEL": "12M100L10-BG-0", "EAN": "0827152053568", "NAME": "Twelve Monkeys - Bonogurt - 50ml - 0mg/ml", "PARENT_NAME": "Twelve Monkeys - Bonogurt - 50ml - 0mg/ml", "PRODUCTS_PRICE": "7,52", "PRODUCTS_PRICE_RECOMMENDED": "16,95", "PRODUCTS_IMAGE": "https://www.innocigs.com/media/b5/45/6d/1618387425/Bonogurt-60mL-Bottle.png", "PRODUCTS_IMAGE_ADDITIONAL": [], "MANUFACTURER": "Twelve Monkeys", "DESCRIPTION": "Das Shake & Vape Liquid Bonogurt von Twelve Monkeys...", "COMPOSITION": "Pflanzliches Glycerin, Propylenglykol, Natürliche und künstliche Aromastoffe", "PRODUCTS_ATTRIBUTES": { "Packung": "1er Packung" }, "VPE": { "CONTENT": "50", "UNIT": "ml" }, "GRADUATED_PRICES": { "PRICE": [ { "QUANTITY": "5", "VALUE": "6.998400" } ] }, "OTHER_UNITS": { "UNIT": [ { "MODEL": "AS10000A1-H", "PACKAGE": "50", "PRICE": "300.000000", "PRICE_PER_UNIT": "6.000000" } ] } } ] } } ``` ``` -------------------------------- ### Authentication Failure Example Source: https://context7.com/colortastic/02_fimpler/llms.txt Demonstrates an example of an authentication failure using invalid credentials with the InnoCigs API. ```APIDOC ## GET /restapi/quantity_all (Authentication Failure Example) ### Description This example shows how to trigger an authentication failure by providing invalid credentials in the Auth header. ### Method GET ### Endpoint https://www.innocigs.com/restapi/quantity_all ### Parameters #### Query Parameters None #### Request Body None ### Request Example ```bash curl -H "Auth: INVALID:CREDENTIALS" \ "https://www.innocigs.com/restapi/quantity_all" ``` ### Response #### Error Response (401 Unauthorized or similar) - **ERRORS** (object) - Contains a list of errors. - **ERROR** (array) - A list of error objects. - **CODE** (integer) - The error code. - **MESSAGE** (string) - A human-readable error message. #### Response Example ```json { "ERRORS": { "ERROR": [ { "CODE": 10000, "MESSAGE": "Login fehlgeschlagen" } ] } } ``` ### Common Error Codes - **10000** - Login failed - **10001** - Invalid XML - **20011** - Order number already used - **30001** - Product not available - **30003** - Product unknown - **40002** - Order header data missing - **50000** - Too many API requests (rate limit) - **50003** - IP not whitelisted ``` -------------------------------- ### GET /restapi/product/{product_sku} Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves detailed information for a specific product using its SKU. Includes description, images, pricing, attributes, and CLP safety information. Requires authentication. ```APIDOC ## GET /restapi/product/{product_sku} ### Description Retrieves detailed information for a specific product using its Stock Keeping Unit (SKU). ### Method GET ### Endpoint `/restapi/product/{product_sku}` ### Parameters #### Path Parameters - **product_sku** (string) - Required - The SKU of the product to retrieve details for. #### Query Parameters None #### Request Body None ### Request Example ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/product/12M100L10-BG-0" ``` ### Response #### Success Response (200) Returns complete product data including description, images, pricing, attributes, CLP safety information, and packaging variations. #### Response Example (Response structure is similar to the detailed fields in the `/restapi/products/extended` endpoint for a single product.) ``` -------------------------------- ### Query Single Product Stock Level (XML vs REST) Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves the stock quantity for a specific product model. Examples are provided for both the XML API, which returns XML, and the REST API, which returns JSON. ```bash # XML API - get stock for specific product curl "https://www.innocigs.com/xmlapi/apiv2.php?cid=12345&auth=YOUR_API_PASSWORD&command=quantity&model=IC10000AIO-10" ``` ```bash # REST API - get stock for specific product curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/quantity/IC10000AIO-10" ``` -------------------------------- ### Get Delivery Information for Standard Orders Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves delivery information for standard orders shipped on a specific date. Requires an 'Auth' header and the date in YYYY-MM-DD format. ```bash # REST API - get delivery information for standard orders shipped on date curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/delivery/2018-05-01" ``` -------------------------------- ### Bash: Authenticate and Fetch Inventory with Invalid Credentials Source: https://context7.com/colortastic/02_fimpler/llms.txt Demonstrates how to use curl to make a request to the InnoCigs API with invalid authentication credentials. This example shows a common scenario for testing error handling and understanding API responses to authentication failures. ```bash curl -H "Auth: INVALID:CREDENTIALS" \ "https://www.innocigs.com/restapi/quantity_all" ``` -------------------------------- ### GET /restapi/products-by-master Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves products organized by their master SKU. This endpoint groups product variants under their respective master SKUs. Requires authentication. ```APIDOC ## GET /restapi/products-by-master ### Description Retrieves products organized by their master product SKU. This is useful for viewing product variants grouped under a common master identifier. ### Method GET ### Endpoint `/restapi/products-by-master` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/products-by-master" ``` ### Response #### Success Response (200) - **PRODUCTS-BY-MASTER** (object) - Contains products grouped by master SKU. - **MASTER** (object) - An object where keys are master SKUs. - **[MASTER_SKU]** (object) - Details for the master SKU and its variants. - **NAME** (string) - The name of the master product. - **PRODUCTS** (array) - List of product variants under this master SKU. - **MASTER** (string) - The master SKU. - **MODEL** (string) - The specific product model (variant). - **EAN** (string) - The EAN code of the variant. - **NAME** (string) - The name of the variant. - **PRODUCTS_PRICE** (string) - The price of the variant. - **PRODUCTS_ATTRIBUTES** (object) - Attributes of the variant. - **VPE** (object) - Volume per piece information. - **GRADUATED_PRICES** (object) - Graduated pricing information for the variant. #### Response Example ```json { "PRODUCTS-BY-MASTER": { "MASTER": { "12M100L10-BG": { "NAME": "Twelve Monkeys - Bonogurt - 50ml - 0mg/ml", "PRODUCTS": [ { "MASTER": "12M100L10-BG", "MODEL": "12M100L10-BG-0", "EAN": "0827152053568", "NAME": "Twelve Monkeys - Bonogurt 0 mg/ml 50ml", "PRODUCTS_PRICE": "7,51", "PRODUCTS_ATTRIBUTES": { "PACKUNG": "1er Packung" }, "VPE": { "CONTENT": 50, "UNIT": "ml" }, "GRADUATED_PRICES": { "GRADUATED_PRICE": [ { "QUANTITY": 10, "PRODUCTS_PRICE": "7.210000" } ] } } ] } } } } ``` ``` -------------------------------- ### GET /restapi/pending Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves a list of backordered or pending items. Requires authentication. ```APIDOC ## GET /restapi/pending ### Description Retrieves a list of backordered items. ### Method GET ### Endpoint `/restapi/pending` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/pending" ``` ### Response #### Success Response (200) - **PENDINGS** (object) - Contains pending item details. - **PRODUCT** (array) - List of pending products. - **ORDERS_ID** (string) - The order ID. - **PRODUCTS_MODEL** (string) - The product model. - **QUANTITY** (string) - The quantity pending. - **EAN** (string) - The product EAN code. - **SHIPPING_STATUS** (string) - The shipping status or availability information. #### Response Example ```json { "PENDINGS": { "PRODUCT": [ { "ORDERS_ID": "53-44", "PRODUCTS_MODEL": "AV100A10-SP-A", "QUANTITY": "20", "EAN": "4260510026129", "SHIPPING_STATUS": "in 1-10 Tagen lieferbar" } ] } } ``` ``` -------------------------------- ### GET /restapi/delivery/{date} Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves delivery information for standard orders shipped on a specific date. Requires authentication with an API key and password. ```APIDOC ## GET /restapi/delivery/{date} ### Description Retrieves delivery information for standard orders shipped on a specific date. ### Method GET ### Endpoint `/restapi/delivery/{date}` ### Parameters #### Path Parameters - **date** (string) - Required - The date for which to retrieve delivery information (format: YYYY-MM-DD). #### Query Parameters None #### Request Body None ### Request Example ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/delivery/2018-05-01" ``` ### Response #### Success Response (200) - **DELIVERIES** (object) - Contains delivery details. - **DELIVERY** (array) - List of deliveries. - **RECEIVER** (object) - Receiver's information. - **DELIVERY_NUMBER** (string) - The delivery number. - **TRACKINGS** (object) - Tracking information. - **INCLUDED_ORDERS** (array) - List of orders included in the delivery. #### Response Example ```json { "DELIVERIES": { "DELIVERY": [ { "RECEIVER": { "COMPANY": "", "FIRSTNAME": "Markus", "LASTNAME": "Tester", "STREET_ADDRESS": "Teststr. 9", "POSTCODE": "12345", "CITY": "Teststadt", "COUNTRY_CODE": "DE" }, "DELIVERY_NUMBER": "S0448091", "TRACKINGS": { "TRACKING": [ { "_attributes": { "carrier": "DHL", "tracking_code": "00340654321" } } ] }, "INCLUDED_ORDERS": [ { "ORDER": { "ORDERS_NUMBER": "ORDER15", "ORDERS_ID": "9903478-14645", "PRODUCTS": { "PRODUCT": [ { "PRODUCTS_MODEL": "GV100ABP1-10", "QUANTITY": "1" } ] } } } ] } ] } } ``` ``` -------------------------------- ### Authenticate and Query All Product Quantities (XML vs REST) Source: https://context7.com/colortastic/02_fimpler/llms.txt Demonstrates how to authenticate and query all product quantities using both the legacy XML API via URL parameters and the modern REST API via headers. Ensure you replace placeholders with your actual credentials. ```bash # XML API Authentication via URL Parameters curl "https://www.innocigs.com/xmlapi/apiv2.php?cid=12345&auth=YOUR_API_PASSWORD&command=quantity_all" ``` ```bash # REST API Authentication via Headers curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/quantity_all" ``` -------------------------------- ### Query All Product Prices (REST) Source: https://context7.com/colortastic/02_fimpler/llms.txt Fetches the complete price list for the entire product catalog via the REST API. The response includes details on graduated pricing and bulk packaging options. ```bash # REST API - retrieve complete price list curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/prices" ``` -------------------------------- ### Query Complete Product Catalog Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves the entire product catalog. You can request either 'normal' product details or 'extended' details for more comprehensive information. Requires an 'Auth' header. ```bash # REST API - get complete product catalog curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/products/normal" ``` ```bash # Use "extended" instead of "normal" for detailed descriptions: curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/products/extended" ``` -------------------------------- ### Query Single Product Details Source: https://context7.com/colortastic/02_fimpler/llms.txt Fetches detailed information for a specific product using its model identifier. This includes comprehensive data like descriptions, images, pricing, attributes, and CLP safety information. Requires an 'Auth' header. ```bash # REST API - get detailed information for specific product curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/product/12M100L10-BG-0" ``` -------------------------------- ### Query All Product Prices Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieve pricing information for the entire product catalog, including volume discounts and bulk packaging options, using the REST API. ```APIDOC ## Query All Product Prices ### REST API **Endpoint:** `https://www.innocigs.com/restapi/prices` **Method:** GET **Headers:** - **Auth** (string) - Required - `your_cid:YOUR_API_PASSWORD` ### Request Example ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/prices" ``` ### Response The response includes pricing for the entire catalog with graduated pricing and bulk packaging options. ``` -------------------------------- ### Create Standard Order via REST API Source: https://context7.com/colortastic/02_fimpler/llms.txt This code shows how to place a standard order through the InnoCigs REST API. Similar to dropshipping, it requires authentication and a JSON payload, but this is for orders shipping to your own address. An optional shipping parameter can be appended. ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ -H "Content-Type: application/json" \ -X POST \ "https://www.innocigs.com/restapi/order" \ -d '{ "ORDER": { "DATA": { "ORDERS_NUMBER": "ORDER1234", "RECEIVER": { "FIRSTNAME": "John", "LASTNAME": "Buyer", "BIRTHDAY": "23.6.1969", "CITY": "Hamburg", "POSTCODE": "22761", "STREET_ADDRESS": "Warehouse St 23", "COUNTRY_CODE": "DE", "COMPANY": "My Shop GmbH", "COMPANY2": "Building A", "EMAIL": "warehouse@myshop.com" } }, "PRODUCTS": [ { "PRODUCTS_MODEL": "IC10000L10-TE-3", "QUANTITY": 2 }, { "PRODUCTS_MODEL": "IC10000AIO-10", "QUANTITY": 1 } ] } }' # Optional: Add shipping parameter for DHL or UPS # &shipping=DHL or &shipping=UPS in XML API ``` -------------------------------- ### Create Standard Order Source: https://context7.com/colortastic/02_fimpler/llms.txt Creates a standard order that ships to your address. Requires authentication and a JSON payload. Optional shipping parameters can be appended. ```APIDOC ## POST /restapi/order ### Description Creates a standard order that ships to your address. Requires authentication and a JSON payload. Optional shipping parameters can be appended. ### Method POST ### Endpoint https://www.innocigs.com/restapi/order ### Parameters #### Headers - **Auth** (string) - Required - Authentication token in the format '12345:YOUR_API_PASSWORD' - **Content-Type** (string) - Required - 'application/json' #### Query Parameters - **shipping** (string) - Optional - Shipping carrier ('DHL' or 'UPS') #### Request Body - **ORDER** (object) - Required - Main object for order details - **DATA** (object) - Required - Receiver details - **ORDERS_NUMBER** (string) - Required - Your internal order number - **RECEIVER** (object) - Required - Your company details for delivery - **FIRSTNAME** (string) - Required - **LASTNAME** (string) - Required - **BIRTHDAY** (string) - Required (e.g., '23.6.1969') - **CITY** (string) - Required - **POSTCODE** (string) - Required - **STREET_ADDRESS** (string) - Required - **COUNTRY_CODE** (string) - Required (e.g., 'DE') - **COMPANY** (string) - Optional - **COMPANY2** (string) - Optional - **EMAIL** (string) - Required - **PRODUCTS** (array) - Required - List of products to order - **PRODUCTS_MODEL** (string) - Required - Product SKU - **QUANTITY** (integer) - Required - Number of units ### Request Example ```json { "ORDER": { "DATA": { "ORDERS_NUMBER": "ORDER1234", "RECEIVER": { "FIRSTNAME": "John", "LASTNAME": "Buyer", "BIRTHDAY": "23.6.1969", "CITY": "Hamburg", "POSTCODE": "22761", "STREET_ADDRESS": "Warehouse St 23", "COUNTRY_CODE": "DE", "COMPANY": "My Shop GmbH", "COMPANY2": "Building A", "EMAIL": "warehouse@myshop.com" } }, "PRODUCTS": [ { "PRODUCTS_MODEL": "IC10000L10-TE-3", "QUANTITY": 2 }, { "PRODUCTS_MODEL": "IC10000AIO-10", "QUANTITY": 1 } ] } } ``` ### Response #### Success Response (200) - **ORDER** (object) - Main response object - **ORDERS_NUMBER** (string) - Your internal order number - **STATUS** (string) - 'OK' for success - **MESSAGE** (string) - Confirmation message - **ORDERS_ID** (integer) - Internal order ID #### Response Example (Success) ```json { "ORDER": { "ORDERS_NUMBER": "ORDER12345", "STATUS": "OK", "MESSAGE": "Bestellung erfolgreich eingetragen", "ORDERS_ID": 78 } } ``` ``` -------------------------------- ### Create Dropship Order Source: https://context7.com/colortastic/02_fimpler/llms.txt Creates a dropship order where InnoCigs ships directly to the end customer. Requires authentication and a JSON payload detailing the order. ```APIDOC ## POST /restapi/dropship ### Description Creates a dropship order where InnoCigs ships directly to the end customer. ### Method POST ### Endpoint https://www.innocigs.com/restapi/dropship ### Parameters #### Headers - **Auth** (string) - Required - Authentication token in the format '12345:YOUR_API_PASSWORD' - **Content-Type** (string) - Required - 'application/json' #### Request Body - **DROPSHIPPING** (object) - Required - Main object for dropshipping details - **DROPSHIP** (object) - Required - Contains order and product information - **DATA** (object) - Required - Shipping and receiver data - **ORDERS_NUMBER** (string) - Required - Your internal order number - **SHIPPER** (object) - Required - Your company details for shipping - **COMPANY** (string) - Required - **COMPANY2** (string) - Optional - **FIRSTNAME** (string) - Required - **LASTNAME** (string) - Required - **STREET_ADDRESS** (string) - Required - **POSTCODE** (string) - Required - **CITY** (string) - Required - **COUNTRY_CODE** (string) - Required (e.g., 'DE') - **EMAIL** (string) - Required - **TELEPHONE** (string) - Required - **RECEIVER** (object) - Required - End customer details - **COMPANY** (string) - Optional - **FIRSTNAME** (string) - Required - **LASTNAME** (string) - Required - **STREET_ADDRESS** (string) - Required - **POSTCODE** (string) - Required - **CITY** (string) - Required - **COUNTRY_CODE** (string) - Required (e.g., 'DE') - **EMAIL** (string) - Required - **BIRTHDAY** (string) - Required (e.g., '23.6.1989') - **PRODUCTS** (array) - Required - List of products to ship - **PRODUCTS_MODEL** (string) - Required - Product SKU - **QUANTITY** (integer) - Required - Number of units ### Request Example ```json { "DROPSHIPPING": { "DROPSHIP": { "DATA": { "ORDERS_NUMBER": "ORDER1234", "SHIPPER": { "COMPANY": "Your Company", "COMPANY2": "Suite 200", "FIRSTNAME": "John", "LASTNAME": "Seller", "STREET_ADDRESS": "Business St 10", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "EMAIL": "seller@company.com", "TELEPHONE": "040 123456" }, "RECEIVER": { "COMPANY": "Customer Company", "FIRSTNAME": "Jane", "LASTNAME": "Customer", "STREET_ADDRESS": "Customer St 23", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "EMAIL": "customer@example.com", "BIRTHDAY": "23.6.1989" } }, "PRODUCTS": [ { "PRODUCTS_MODEL": "IC10000L10-TE-3", "QUANTITY": 2 }, { "PRODUCTS_MODEL": "IC10000AIO-10", "QUANTITY": 1 } ] } } } ``` ### Response #### Success Response (200) - **DROPSHIPPING** (object) - Main response object - **DROPSHIP** (object) - Dropship details - **ORDERS_NUMBER** (string) - Your internal order number - **STATUS** (string) - 'OK' for success - **MESSAGE** (string) - Confirmation message - **DROPSHIP_ID** (integer) - Internal ID for the dropship order - **ORDERS_ID** (integer) - Internal order ID #### Response Example (Success) ```json { "DROPSHIPPING": { "DROPSHIP": { "ORDERS_NUMBER": "ORDER1234", "STATUS": "OK", "MESSAGE": "Dropship erfolgreich eingetragen", "DROPSHIP_ID": 68, "ORDERS_ID": 77 } } } ``` #### Error Response - **DROPSHIPPING** (object) - Main response object - **DROPSHIP** (object) - Dropship details - **ORDERS_NUMBER** (string) - Your internal order number - **STATUS** (string) - 'NOK' for failure - **MESSAGE** (string) - Error message - **DROPSHIP_ID** (integer) - -1 on failure - **ORDERS_ID** (integer) - -1 on failure - **ERRORS** (array) - List of specific errors - **CODE** (integer) - Error code - **MESSAGE** (string) - Error description #### Response Example (Error) ```json { "DROPSHIPPING": { "DROPSHIP": { "ORDERS_NUMBER": "ORDER324", "STATUS": "NOK", "MESSAGE": "Dropship fehlgeschlagen", "DROPSHIP_ID": -1, "ORDERS_ID": -1, "ERRORS": [ { "CODE": 30001, "MESSAGE": "AS100AMZ nicht lieferbar" } ] } } } ``` ``` -------------------------------- ### Create Dropship Order via REST API Source: https://context7.com/colortastic/02_fimpler/llms.txt This snippet demonstrates how to create a dropship order using the InnoCigs REST API. It requires authentication headers and a JSON payload containing order details, shipper, receiver, and product information. The response indicates success or failure with relevant details. ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ -H "Content-Type: application/json" \ -X POST \ "https://www.innocigs.com/restapi/dropship" \ -d '{ "DROPSHIPPING": { "DROPSHIP": { "DATA": { "ORDERS_NUMBER": "ORDER1234", "SHIPPER": { "COMPANY": "Your Company", "COMPANY2": "Suite 200", "FIRSTNAME": "John", "LASTNAME": "Seller", "STREET_ADDRESS": "Business St 10", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "EMAIL": "seller@company.com", "TELEPHONE": "040 123456" }, "RECEIVER": { "COMPANY": "Customer Company", "FIRSTNAME": "Jane", "LASTNAME": "Customer", "STREET_ADDRESS": "Customer St 23", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "EMAIL": "customer@example.com", "BIRTHDAY": "23.6.1989" } }, "PRODUCTS": [ { "PRODUCTS_MODEL": "IC10000L10-TE-3", "QUANTITY": 2 }, { "PRODUCTS_MODEL": "IC10000AIO-10", "QUANTITY": 1 } ] } } }' ``` -------------------------------- ### Query Single Product Price Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieve pricing information, including graduated discounts, for a specific product using the REST API. ```APIDOC ## Query Single Product Price ### REST API **Endpoint:** `https://www.innocigs.com/restapi/price/{model}` **Method:** GET **Path Parameters:** - **model** (string) - Required - The product model number. **Headers:** - **Auth** (string) - Required - `your_cid:YOUR_API_PASSWORD` ### Request Example ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/price/12M100L10-BG-0" ``` ### Response Example (Success) ```json { "PRICES": { "PRODUCT": [ { "PRODUCTS_MODEL": "12M100L10-BG-0", "PRODUCTS_PRICE": "7,52", "PRODUCTS_PRICE_RECOMMENDED": "16,95", "GRADUATED_PRICES": { "GRADUATED_PRICE": [ { "QUANTITY": 5, "PRODUCTS_PRICE": "6.998400" } ] }, "OTHER_UNITS": { "OTHER_UNIT": [ { "MODEL": "12M100L10-BG-0-H", "PACKUNG": "10", "PRODUCTS_PRICE": "70.000000", "PRODUCTS_PRICE_SINGLE_UNIT": "0.700000" } ] } } ] } } ``` ``` -------------------------------- ### Query Single Product Price (REST) Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves the pricing information for a specific product, including base price, MSRP, and any applicable graduated volume discounts. This endpoint is part of the REST API. ```bash # REST API - get pricing with graduated discounts curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/price/12M100L10-BG-0" ``` -------------------------------- ### Query All Product Stock Levels (REST) Source: https://context7.com/colortastic/02_fimpler/llms.txt Fetches the inventory levels for all products available in the catalog using the REST API. The response is a JSON object containing details for each product. ```bash # REST API - retrieve complete inventory curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/quantity_all" ``` -------------------------------- ### API Authentication Source: https://context7.com/colortastic/02_fimpler/llms.txt This section details how to authenticate with the InnoCigs API, supporting both XML over URL parameters and REST over headers. It also includes instructions for activating test mode. ```APIDOC ## API Authentication ### XML API Authentication via URL Parameters ```bash # Query all product quantities using XML API curl "https://www.innocigs.com/xmlapi/apiv2.php?cid=12345&auth=YOUR_API_PASSWORD&command=quantity_all" ``` ### REST API Authentication via Headers ```bash # Query all product quantities using REST API curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/quantity_all" ``` ### Test Mode Activation ```bash # XML API test mode - no actual orders created curl "https://www.innocigs.com/xmlapi/apiv2.php?cid=12345&auth=YOUR_API_PASSWORD&command=dropship&modus=test&xml=..." # REST API test mode - pass modus=test in header curl -H "Auth: 12345:YOUR_API_PASSWORD" \ -H "modus: test" \ -X POST \ "https://www.innocigs.com/restapi/dropship" \ -d '{...}' ``` ``` -------------------------------- ### Query All Product Stock Levels Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieve the stock levels for all available products in the catalog using the REST API. ```APIDOC ## Query All Product Stock Levels ### REST API **Endpoint:** `https://www.innocigs.com/restapi/quantity_all` **Method:** GET **Headers:** - **Auth** (string) - Required - `your_cid:YOUR_API_PASSWORD` ### Request Example ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/quantity_all" ``` ### Response Example (Success) ```json { "QUANTITIES": { "PRODUCT": [ { "PRODUCTS_MODEL": "12M100L10-BG-0", "QUANTITY": 220, "SHIPPING_STATUS": "Sofort lieferbar" }, { "PRODUCTS_MODEL": "12M100L10-BN-20", "QUANTITY": 114, "SHIPPING_STATUS": "Sofort lieferbar" } ] } } ``` ``` -------------------------------- ### Activate Test Mode (XML vs REST) Source: https://context7.com/colortastic/02_fimpler/llms.txt Shows how to enable test mode for API requests, preventing actual orders from being created. This applies to both XML API requests and REST API requests, with different parameter placements. ```bash # XML API test mode - no actual orders created curl "https://www.innocigs.com/xmlapi/apiv2.php?cid=12345&auth=YOUR_API_PASSWORD&command=dropship&modus=test&xml=..." ``` ```bash # REST API test mode - pass modus=test in header curl -H "Auth: 12345:YOUR_API_PASSWORD" \ -H "modus: test" \ -X POST \ "https://www.innocigs.com/restapi/dropship" \ -d '{...}' ``` -------------------------------- ### Query Pending Items Source: https://context7.com/colortastic/02_fimpler/llms.txt Fetches a list of backordered or pending items. This endpoint is useful for tracking items that are currently out of stock but expected to be replenished. Requires an 'Auth' header. ```bash # REST API - get list of backordered items curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/pending" ``` -------------------------------- ### Query Single Product Stock Level Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieve the current stock level for a specific product using either the XML or REST API. ```APIDOC ## Query Single Product Stock Level ### XML API **Endpoint:** `https://www.innocigs.com/xmlapi/apiv2.php` **Method:** GET **Query Parameters:** - **cid** (string) - Required - Your customer ID. - **auth** (string) - Required - Your API password. - **command** (string) - Required - Set to `quantity`. - **model** (string) - Required - The product model number. ### REST API **Endpoint:** `https://www.innocigs.com/restapi/quantity/{model}` **Method:** GET **Path Parameters:** - **model** (string) - Required - The product model number. **Headers:** - **Auth** (string) - Required - `your_cid:YOUR_API_PASSWORD` ### Request Example (REST API) ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/quantity/IC10000AIO-10" ``` ### Response Example (REST API Success) ```json { "QUANTITIES": { "PRODUCT": [ { "PRODUCTS_MODEL": "12M100L10-BG-0", "QUANTITY": 220, "SHIPPING_STATUS": "Sofort lieferbar" } ] } } ``` ``` -------------------------------- ### Query Products Grouped by Master SKU Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves products organized by their master SKU, grouping product variants under a single master identifier. This endpoint is specific to the REST API and requires an 'Auth' header. ```bash # REST API - get products organized by master product (REST API only) curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/products-by-master" ``` -------------------------------- ### Submit Dropship Order Source: https://context7.com/colortastic/02_fimpler/llms.txt Submit a dropship order to InnoCigs, where products will be shipped directly to the end customer. ```APIDOC ## Submit Dropship Order ### REST API **Endpoint:** `https://www.innocigs.com/restapi/dropship` **Method:** POST **Headers:** - **Auth** (string) - Required - `your_cid:YOUR_API_PASSWORD` - **modus** (string) - Optional - Set to `test` for test mode. **Request Body:** - **order_data** (object) - Required - Contains the details of the dropship order. - **customer_name** (string) - Required - Name of the end customer. - **customer_address** (object) - Required - Shipping address of the end customer. - **street** (string) - Required - **zip** (string) - Required - **city** (string) - Required - **country** (string) - Required - **items** (array) - Required - List of products to order. - **model** (string) - Required - Product model number. - **quantity** (integer) - Required - Quantity of the product. ### Request Example ```json { "order_data": { "customer_name": "John Doe", "customer_address": { "street": "123 Main St", "zip": "10001", "city": "New York", "country": "US" }, "items": [ { "model": "IC10000AIO-10", "quantity": 2 } ] } } ``` ### Response Example (Success) ```json { "ORDER_RESPONSE": { "STATUS": "SUCCESS", "ORDER_ID": "D123456789" } } ``` ### Error Handling In case of errors, the response will contain an error message and a corresponding status code. ``` -------------------------------- ### Query Tracking Data by Date Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves tracking information for all shipments made on a specific date. Requires authentication. ```APIDOC ## GET /restapi/tracking/{date} ### Description Retrieves tracking information for all shipments made on a specific date. ### Method GET ### Endpoint https://www.innocigs.com/restapi/tracking/{date} ### Parameters #### Path Parameters - **date** (string) - Required - The date in 'YYYY-MM-DD' format (e.g., '2018-05-01') #### Headers - **Auth** (string) - Required - Authentication token in the format '12345:YOUR_API_PASSWORD' ### Response #### Success Response (200) - **TRACKING** (object) - Main response object - **DROPSHIP** (array) - List of dropship shipments - **DROPSHIP_ID** (string) - Internal ID for the dropship order - **ORDERS_NUMBER** (string) - Your internal order number - **DELIVERY_NUMBER** (string) - Shipment or delivery number - **TRACKINGS** (array) - List of tracking details - **TRACKINGINFO** (object) - Details of a specific tracking event - **CARRIER** (string) - Shipping carrier (e.g., 'DHL') - **CODE** (string) - Tracking code - **RECEIVER** (object) - Recipient details - **COMPANY** (string) - Optional - **FIRSTNAME** (string) - Required - **LASTNAME** (string) - Required - **STREET_ADDRESS** (string) - Required - **POSTCODE** (string) - Required - **CITY** (string) - Required - **COUNTRY_CODE** (string) - Required (e.g., 'DE') #### Response Example (Success) ```json { "TRACKING": { "DROPSHIP": [ { "DROPSHIP_ID": "6", "ORDERS_NUMBER": "DS24", "DELIVERY_NUMBER": "S0447631", "TRACKINGS": [ { "TRACKINGINFO": { "CARRIER": "DHL", "CODE": "0034012345", "RECEIVER": { "COMPANY": "", "FIRSTNAME": "Max", "LASTNAME": "Mustermann", "STREET_ADDRESS": "Str.7", "POSTCODE": "12345", "CITY": "Teststadt", "COUNTRY_CODE": "DE" } } } ] } ] } } ``` ``` -------------------------------- ### Query Tracking Data by Date via REST API Source: https://context7.com/colortastic/02_fimpler/llms.txt This API call retrieves tracking information for all shipments made on a specific date. It requires an authentication header and the date in YYYY-MM-DD format as part of the URL. The response is a JSON object containing tracking details for dropship orders. ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/tracking/2018-05-01" ``` -------------------------------- ### Query Tracking Data by Order Number via REST API Source: https://context7.com/colortastic/02_fimpler/llms.txt This snippet shows how to fetch tracking information for a specific order number. It uses the InnoCigs REST API with an authentication header and the order number in the URL. The response includes tracking details for dropship orders and any associated cancellations. ```bash curl -H "Auth: 12345:YOUR_API_PASSWORD" \ "https://www.innocigs.com/restapi/tracking-order/ORDER1234" ``` -------------------------------- ### Query Tracking Data by Order Number Source: https://context7.com/colortastic/02_fimpler/llms.txt Retrieves tracking information for a specific order number, including any cancellations. Requires authentication. ```APIDOC ## GET /restapi/tracking-order/{orderNumber} ### Description Retrieves tracking information for a specific order number, including any cancellations. ### Method GET ### Endpoint https://www.innocigs.com/restapi/tracking-order/{orderNumber} ### Parameters #### Path Parameters - **orderNumber** (string) - Required - Your internal order number #### Headers - **Auth** (string) - Required - Authentication token in the format '12345:YOUR_API_PASSWORD' ### Response #### Success Response (200) - **TRACKING** (object) - Main response object - **DROPSHIP** (array) - List of dropship shipments associated with the order - **DROPSHIP_ID** (string) - Internal ID for the dropship order - **ORDERS_NUMBER** (string) - Your internal order number - **DELIVERY_NUMBER** (string) - Shipment or delivery number - **TRACKINGS** (array) - List of tracking details - **TRACKINGINFO** (object) - Details of a specific tracking event - **CARRIER** (string) - Shipping carrier (e.g., 'DHL') - **CODE** (string) - Tracking code - **RECEIVER** (object) - Recipient details (structure same as in query by date) - **CANCELLATION** (object) - Details if the order was cancelled - **DROPSHIP_ID** (string) - Internal ID for the cancelled dropship order - **ORDERS_NUMBER** (string) - Your internal order number - **MESSAGE** (string) - Cancellation message #### Response Example (Success) ```json { "TRACKING": { "DROPSHIP": [ { "DROPSHIP_ID": "6", "ORDERS_NUMBER": "DS24", "DELIVERY_NUMBER": "S0447631", "TRACKINGS": [ { "TRACKINGINFO": { "CARRIER": "DHL", "CODE": "0034012345", "RECEIVER": {...} } } ] } ], "CANCELLATION": { "DROPSHIP_ID": "8", "ORDERS_NUMBER": "DSX1", "MESSAGE": "Der Auftrag wurde storniert" } } } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.