### GET /restapi/prices Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves the complete price list for all products, including graduated pricing and bulk options. ```APIDOC ## Query All Product Prices ### Description Retrieves the complete price list with graduated pricing and bulk options for the entire product catalog. ### Method GET ### Endpoint `/restapi/prices` #### Request Example ```bash curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/prices" ``` #### Response *Success Response (200)* This endpoint returns a structure similar to the `GET /restapi/price/{product_model}` endpoint, but for all products in the catalog. *(Please refer to the Response section of the 'Query Single Product Price' endpoint for the detailed structure of the pricing information.)* ``` -------------------------------- ### GET /restapi/quantity_all Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves a complete snapshot of inventory levels for all products in the catalog. ```APIDOC ## Query All Product Stock Levels ### Description Retrieves complete inventory snapshot across the entire product catalog. ### Method GET ### Endpoint `/restapi/quantity_all` #### Request Example ```bash curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/quantity_all" ``` #### Response *Success Response (200)* - **QUANTITIES** (object) - Contains product quantity information. - **PRODUCT** (array) - An array of product objects. - **PRODUCTS_MODEL** (string) - The model number of the product. - **QUANTITY** (integer) - The current stock quantity. - **SHIPPING_STATUS** (string) - The shipping status of the product. #### Response Example ```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" } ] } } ``` ``` -------------------------------- ### GET /restapi/price/{product_model} Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves detailed pricing information for a specific product, including base price, MSRP, and graduated pricing tiers. ```APIDOC ## Query Single Product Price ### Description Retrieves pricing information including base price, MSRP, graduated pricing tiers, and bulk packaging options for a specific product. ### Method GET ### Endpoint `/restapi/price/{product_model}` #### Path Parameters - **product_model** (string) - Required - The model number of the product to query. #### Request Example ```bash curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/price/12M100L10-BG-0" ``` #### Response *Success Response (200)* - **PRICES** (object) - Contains pricing information. - **PRODUCT** (array) - An array of product pricing objects. - **PRODUCTS_MODEL** (string) - The model number of the product. - **PRODUCTS_PRICE** (string) - The base price of the product. - **PRODUCTS_PRICE_RECOMMENDED** (string) - The Manufacturer's Suggested Retail Price (MSRP). - **GRADUATED_PRICES** (object) - Contains graduated pricing tiers. - **GRADUATED_PRICE** (array) - An array of graduated price objects. - **QUANTITY** (integer) - The minimum quantity for this price tier. - **PRODUCTS_PRICE** (string) - The discounted price for this quantity. - **OTHER_UNITS** (object) - Contains pricing for alternative units (e.g., bulk packaging). - **OTHER_UNIT** (array) - An array of other unit pricing objects. - **MODEL** (string) - The model identifier for this unit. - **PACKUNG** (string) - The packaging size (e.g., "10"). - **PRODUCTS_PRICE** (string) - The price for this unit. - **PRODUCTS_PRICE_SINGLE_UNIT** (string) - The price per single unit within this packaging. #### Response Example ```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" } ] } } ] } } ``` ``` -------------------------------- ### Handle API Authentication Errors Source: https://context7.com/colortastic/innocigs_api/llms.txt Demonstrates how to handle authentication errors when interacting with the API. Incorrect credentials will result in an error response containing a numeric error code and a descriptive message. This example shows a common authentication failure scenario. ```bash # Example authentication error curl -H "Auth: wrong:credentials" \ "https://www.innocigs.com/restapi/quantity_all" ``` -------------------------------- ### GET /restapi/tracking/{date} Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieve all tracking information for shipments processed on a specific date. ```APIDOC ## GET /restapi/tracking/{date} ### Description Retrieve all tracking information for shipments processed on a specific date. ### Method GET ### Endpoint `https://www.innocigs.com/restapi/tracking/{date}` ### Parameters #### Path Parameters - **date** (string) - Required - The date for which to retrieve tracking information (format: YYYY-MM-DD). #### Headers - **Auth** (string) - Required - Authentication token. ### Response #### Success Response (200) - **TRACKING** (object) - Contains tracking information. - **DROPSHIP** (array) - List of dropship tracking information. - **DROPSHIP_ID** (string) - Unique ID for the dropship order. - **ORDERS_NUMBER** (string) - The order number. - **DELIVERY_NUMBER** (string) - The delivery number. - **TRACKINGS** (array) - List of tracking details. - **TRACKINGINFO** (object) - **CARRIER** (string) - The shipping carrier (e.g., 'DHL'). - **CODE** (string) - The tracking code. - **RECEIVER** (object) - Information about the receiver. - **COMPANY** (string) - Receiver's company name. - **FIRSTNAME** (string) - Receiver's first name. #### Response Example ```json { "TRACKING": { "DROPSHIP": [ { "DROPSHIP_ID": "6", "ORDERS_NUMBER": "DS24", "DELIVERY_NUMBER": "S0447631", "TRACKINGS": [ { "TRACKINGINFO": { "CARRIER": "DHL", "CODE": "0034012345", "RECEIVER": { "COMPANY": "", "FIRSTNAME": "Max" } } } ] } ] } } ``` ``` -------------------------------- ### GET /restapi/quantity/{product_model} Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves the current inventory level for a specific product identified by its model number. ```APIDOC ## Query Single Product Stock ### Description Retrieves current inventory level for a specific product by model number. ### Method GET ### Endpoint `/restapi/quantity/{product_model}` #### Path Parameters - **product_model** (string) - Required - The model number of the product to query. #### Request Example ```bash curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/quantity/IC10000AIO-10" ``` #### Response *Success Response (200)* - **QUANTITIES** (object) - Contains product quantity information. - **PRODUCT** (array) - An array of product objects. - **PRODUCTS_MODEL** (string) - The model number of the product. - **QUANTITY** (integer) - The current stock quantity. - **SHIPPING_STATUS** (string) - The shipping status of the product (e.g., "Sofort lieferbar"). #### Response Example ```json { "QUANTITIES": { "PRODUCT": [ { "PRODUCTS_MODEL": "IC10000AIO-10", "QUANTITY": 155, "SHIPPING_STATUS": "Sofort lieferbar" } ] } } ``` ``` -------------------------------- ### Query All Products with Basic Info Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieve the complete product catalog with pricing, images, and basic attributes. ```APIDOC ## GET /restapi/products/normal ### Description Retrieve the complete product catalog including pricing, images, and basic attributes. This is the 'normal' mode. ### Method GET ### Endpoint `https://www.innocigs.com/restapi/products/normal` ### Parameters None ### Request Example ```bash curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/products/normal" ``` ### Response #### Success Response (200) - **PRODUCTS.PRODUCT** (array) - An array of product objects. - **CATEGORY** (string) - The product category. - **MASTER** (string) - Master product identifier. - **MODEL** (string) - The product model number. - **EAN** (string) - The EAN (barcode) of the product. - **NAME** (string) - The name of the product. - **PARENT_NAME** (string) - The parent name of the product, if applicable. - **PRODUCTS_PRICE** (string) - The current selling price. - **PRODUCTS_PRICE_RECOMMENDED** (string) - The recommended retail price. - **PRODUCTS_IMAGE** (string) - URL for the main product image. - **PRODUCTS_IMAGE_ADDITIONAL** (array) - URLs for additional product images. - **MANUFACTURER** (string) - The manufacturer of the product. - **PRODUCTS_ATTRIBUTES** (object) - Key-value pairs of product attributes (e.g., `PACKUNG`). - **VPE** (object) - Packaging unit information. - **CONTENT** (string) - The quantity of content in the package. - **UNIT** (string) - The unit of measure (e.g., 'ml'). - **GRADUATED_PRICES.PRICE** (array) - Information about graduated pricing tiers. - **QUANTITY** (string) - The minimum quantity for this price tier. - **VALUE** (string) - The price per unit for this tier. - **OTHER_UNITS.UNIT** (array) - Information about other available units/packaging. - **MODEL** (string) - Model identifier for this unit. - **PACKAGE** (string) - The package size for this unit. - **PRICE** (string) - The total price for this unit. - **PRICE_PER_UNIT** (string) - The price per single unit. #### 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", "PRODUCTS_ATTRIBUTES": { "PACKUNG": "1er Packung" }, "VPE": { "CONTENT": "50", "UNIT": "ml" }, "GRADUATED_PRICES": { "PRICE": [ { "QUANTITY": "5", "VALUE": "6.998400" } ] }, "OTHER_UNITS": { "UNIT": [ { "MODEL": "12M100L10-BG-0-H", "PACKAGE": "10", "PRICE": "70.000000", "PRICE_PER_UNIT": "7.000000" } ] } } ] } } ``` ``` -------------------------------- ### Query All Product Prices (REST API) Source: https://context7.com/colortastic/innocigs_api/llms.txt Fetches the complete price list for all products in the catalog via the REST API. This includes base prices, MSRPs, and details on graduated and bulk pricing options. ```bash # REST API - Get all prices (bulk query) curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/prices" ``` -------------------------------- ### Query All Products with Basic Info Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves the complete product catalog including pricing, images, and basic attributes using the REST API. This 'normal' mode endpoint requires authentication. An 'extended' mode is also available for product descriptions. ```bash # REST API - Get all products (normal mode) curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/products/normal" # Response: # { # "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", # "PRODUCTS_ATTRIBUTES": { # "PACKUNG": "1er Packung" # }, # "VPE": { # "CONTENT": "50", # "UNIT": "ml" # }, # "GRADUATED_PRICES": { # "PRICE": [ # { # "QUANTITY": "5", # "VALUE": "6.998400" # } # ] # }, # "OTHER_UNITS": { # "UNIT": [ # { # "MODEL": "12M100L10-BG-0-H", # "PACKAGE": "10", # "PRICE": "70.000000", # "PRICE_PER_UNIT": "7.000000" # } # ] # } # } # ] # } # } # Extended mode includes product descriptions: curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/products/extended" ``` -------------------------------- ### Query All Products with Extended Info Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieve the complete product catalog including detailed product descriptions. ```APIDOC ## GET /restapi/products/extended ### Description Retrieve the complete product catalog including detailed product descriptions. This is the 'extended' mode. ### Method GET ### Endpoint `https://www.innocigs.com/restapi/products/extended` ### Parameters None ### Request Example ```bash curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/products/extended" ``` ### Response #### Success Response (200) Returns the same structure as `/restapi/products/normal`, but includes additional fields such as product descriptions. #### Response Example (Response structure is identical to `/restapi/products/normal` but with added description fields. Specific example omitted for brevity.) ``` -------------------------------- ### Query Single Product Price (REST API) Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves detailed pricing information for a single product via the REST API, including base price, MSRP, and any applicable graduated or bulk pricing tiers. ```bash # REST API - Get price for specific product curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/price/12M100L10-BG-0" ``` -------------------------------- ### Query Single Product Details using REST API Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves detailed information for a specific product, including its description and composition. This endpoint requires authentication and a valid product model identifier. The response is a JSON object containing comprehensive product data. ```bash # REST API - Get detailed product info curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/product/12M100L10-BG-0" ``` -------------------------------- ### Create Dropship Order - REST API Source: https://context7.com/colortastic/innocigs_api/llms.txt Submits a dropship order with specified shipper and receiver addresses, along with a list of products. The order is directly shipped to the end customer. Requires 'Auth' and 'Content-Type' headers. Input is a JSON payload defining order details and products. ```bash # REST API - Create dropship order curl -X POST \ -H "Auth: 12345:password" \ -H "Content-Type: application/json" \ -d '{ "DROPSHIPPING": { "DROPSHIP": { "DATA": { "ORDERS_NUMBER": "ORDER1234", "SHIPPER": { "COMPANY": "My Vape Store", "FIRSTNAME": "John", "LASTNAME": "Smith", "STREET_ADDRESS": "Main St 10", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "EMAIL": "shop@example.com", "TELEPHONE": "040 123456" }, "RECEIVER": { "COMPANY": "Customer Company", "FIRSTNAME": "Jane", "LASTNAME": "Doe", "STREET_ADDRESS": "Test St 23", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "EMAIL": "customer@test.com", "BIRTHDAY": "23.6.1989" } }, "PRODUCTS": [ { "PRODUCTS_MODEL": "IC10000L10-TE-3", "QUANTITY": 2 }, { "PRODUCTS_MODEL": "IC10000AIO-10", "QUANTITY": 1 } ] } } }' \ "https://www.innocigs.com/restapi/dropship" # Success Response: # { # "DROPSHIPPING": { # "DROPSHIP": { # "ORDERS_NUMBER": "ORDER1234", # "STATUS": "OK", # "MESSAGE": "Dropship erfolgreich eingetragen", # "DROPSHIP_ID": 68, # "ORDERS_ID": 77 # } # } # } # Error Response: # { # "DROPSHIPPING": { # "DROPSHIP": { # "ORDERS_NUMBER": "ORDER1234", # "STATUS": "NOK", # "MESSAGE": "Dropship fehlgeschlagen", # "DROPSHIP_ID": -1, # "ORDERS_ID": -1, # "ERRORS": [ # { # "CODE": 30001, # "MESSAGE": "AS100AMZ nicht lieferbar" # } # ] # } # } # } ``` -------------------------------- ### Authentication Source: https://context7.com/colortastic/innocigs_api/llms.txt Details on how to authenticate with the InnoCigs Dropship API using HTTP headers. ```APIDOC ## API Authentication ### REST API Authentication Authentication is performed by sending an `Auth` HTTP header with your credentials in the format `customer_id:api_password`. #### Headers - **Auth** (string) - Required - Your authentication credentials in `cid:auth` format. ### Test Mode To validate requests without affecting live data, enable test mode by including the `modus: test` header. This is useful for verifying data structures and business rules. #### Headers - **Auth** (string) - Required - Your authentication credentials in `cid:auth` format. - **modus** (string) - Optional - Set to `test` to enable test mode. ``` -------------------------------- ### Query All Product Stock Levels (REST API) Source: https://context7.com/colortastic/innocigs_api/llms.txt Fetches a complete snapshot of inventory levels for all products in the catalog using the REST API. This is useful for bulk inventory checks. ```bash # REST API - Get all stock levels (bulk query) curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/quantity_all" ``` -------------------------------- ### Query Single Product Details Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieve detailed product information including full description and composition for a specific product using its model number. ```APIDOC ## GET /restapi/product/{productId} ### Description Retrieves detailed product information, including full description and composition, for a specific product identified by its model number. ### Method GET ### Endpoint /restapi/product/{productId} ### Parameters #### Path Parameters - **productId** (string) - Required - The unique model identifier for the product. #### Query Parameters None #### Request Body None ### Request Example ```bash curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/product/12M100L10-BG-0" ``` ### Response #### Success Response (200) - **PRODUCTS** (object) - Contains product details. - **PRODUCT** (array) - An array of product objects. - **CATEGORY** (string) - The product category. - **MASTER** (string) - The master product identifier. - **MODEL** (string) - The product model identifier. - **EAN** (string) - The EAN barcode of the product. - **NAME** (string) - The name of the product. - **PARENT_NAME** (string) - The parent name of the product. - **PRODUCTS_PRICE** (string) - The product price. - **PRODUCTS_PRICE_RECOMMENDED** (string) - The recommended retail price. - **PRODUCTS_IMAGE** (string) - URL of the product image. - **PRODUCTS_IMAGE_ADDITIONAL** (array) - Array of additional image URLs. - **MANUFACTURER** (string) - The manufacturer of the product. - **CLP_INFOS** (object) - CLP information. - **MSDS_CODES** (string) - MSDS codes. - **MSDS_GHS_SYMBOL** (string) - MSDS GHS symbols. - **DESCRIPTION** (object) - Product description. - **_cdata** (string) - CDATA formatted product description. - **COMPOSITION** (string) - The composition of the product. - **PRODUCTS_ATTRIBUTES** (object) - Product attributes. - **PACKUNG** (string) - Packaging information. - **VPE** (object) - Unit of packaging. - **CONTENT** (string) - The content quantity. - **UNIT** (string) - The unit of measurement (e.g., ml). - **GRADUATED_PRICES** (object) - Graduated pricing details. - **OTHER_UNITS** (object) - Other unit information. #### 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://shopware-test.innocigs.com/media/b5/45/6d/1618387425/Bonogurt-60mL-Bottle.png", "PRODUCTS_IMAGE_ADDITIONAL": [], "MANUFACTURER": "Twelve Monkeys", "CLP_INFOS": { "MSDS_CODES": null, "MSDS_GHS_SYMBOL": null }, "DESCRIPTION": { "_cdata": "Das Shake & Vape Liquid Bonogurt von Twelve Monkeys schmeckt nach Beeren und Joghurt. Shake & Vape Liquids eignen sich nicht für das pure Dampfen. Sie erhalten 50ml Liquid in einer 60ml Flasche geliefert." }, "COMPOSITION": "Pflanzliches Glycerin, Propylenglykol, Natürliche und künstliche Aromastoffe", "PRODUCTS_ATTRIBUTES": { "PACKUNG": "1er Packung" }, "VPE": { "CONTENT": "50", "UNIT": "ml" }, "GRADUATED_PRICES": {}, "OTHER_UNITS": {} } ] } } ``` ``` -------------------------------- ### Query Backordered Products Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieve a list of products from orders that are awaiting stock or fulfillment. ```APIDOC ## GET /restapi/pending ### Description Retrieve a list of products from orders that are awaiting stock or fulfillment (backordered). ### Method GET ### Endpoint `https://www.innocigs.com/restapi/pending` ### Parameters None ### Request Example ```bash curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/pending" ``` ### Response #### Success Response (200) - **PENDINGS.PRODUCT** (array) - An array of backordered product objects. - **ORDERS_ID** (string) - The internal order ID associated with the backordered product. - **PRODUCTS_MODEL** (string) - The product model number. - **QUANTITY** (string) - The quantity of the product that is backordered. - **EAN** (string) - The EAN (barcode) of the product. - **SHIPPING_STATUS** (string) - Information about the expected shipping availability (e.g., 'in 1-10 Tagen lieferbar'). #### 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" } ] } } ``` ``` -------------------------------- ### Create Standard Order - REST API Source: https://context7.com/colortastic/innocigs_api/llms.txt Submits a standard order to the reseller's registered address. Requires 'Auth' and 'Content-Type' headers. The order details and products are sent as a JSON payload. An optional 'shipping' header can specify the carrier. ```bash # REST API - Create standard order curl -X POST \ -H "Auth: 12345:password" \ -H "Content-Type: application/json" \ -d '{ "ORDER": { "DATA": { "ORDERS_NUMBER": "ORDER5678", "RECEIVER": { "FIRSTNAME": "Store", "LASTNAME": "Manager", "STREET_ADDRESS": "Business St 23", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "COMPANY": "My Vape Store GmbH", "EMAIL": "orders@example.com" } }, "PRODUCTS": [ { "PRODUCTS_MODEL": "IC10000L10-TE-3", "QUANTITY": 2 }, { "PRODUCTS_MODEL": "IC10000AIO-10", "QUANTITY": 1 } ] } }' \ "https://www.innocigs.com/restapi/order" # Optional: Specify shipping carrier curl -X POST \ -H "Auth: 12345:password" \ -H "Content-Type: application/json" \ -H "shipping: UPS" \ -d '{...}' \ "https://www.innocigs.com/restapi/order" # Success Response: # { # "ORDER": { # "ORDERS_NUMBER": "ORDER5678", # "STATUS": "OK", # "MESSAGE": "Bestellung erfolgreich eingetragen", # "ORDERS_ID": 1151607 # } # } # Error Response: # { # "ORDER": { # "ORDERS_NUMBER": "ORDER5678", # "STATUS": "NOK", # "MESSAGE": "Eintragen der Bestellung fehlgeschlagen", # "ORDERS_ID": -1, # "ERRORS": [ # { # "CODE": 30001, # "MESSAGE": "AS100AMZ nicht lieferbar" # } # ] # } # } ``` -------------------------------- ### Query Backordered Products Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves a list of products from orders that are currently awaiting stock or fulfillment. This endpoint requires authentication and can be queried via the REST API. ```bash # REST API - Get pending/backordered items curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/pending" # Response: # { # "PENDINGS": { # "PRODUCT": [ # { # "ORDERS_ID": "53-44", # "PRODUCTS_MODEL": "AV100A10-SP-A", # "QUANTITY": "20", # "EAN": "4260510026129", # "SHIPPING_STATUS": "in 1-10 Tagen lieferbar" # } # ] # } # } ``` -------------------------------- ### Query Deliveries by Date Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves delivery notes and shipped products for regular orders (non-dropship) on a specific date using the REST API. The date is provided as part of the URL path. Authentication is required. ```bash # REST API - Get delivery notes for specific date curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/delivery/2022-04-28" # Response: # { # "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" # } # ] # } # } # } # ] # } # ] # } # } ``` -------------------------------- ### Enable Test Mode for API Requests Source: https://context7.com/colortastic/innocigs_api/llms.txt Demonstrates how to enable test mode for both XML and REST API calls. Test mode allows validation of requests without affecting live data, ensuring correct formatting and business rule adherence. ```bash # XML API test mode (URL parameter) curl "https://www.innocigs.com/xmlapi/apiv2.php?cid=12345&auth=password&command=dropship&modus=test&xml=..." # REST API test mode (HTTP header) curl -H "Auth: 12345:password" \ -H "modus: test" \ -H "Content-Type: application/json" \ -d '{"DROPSHIPPING": {...}}' \ "https://www.innocigs.com/restapi/dropship" # Test mode validates all data structures and business rules without creating database records ``` -------------------------------- ### Authenticate XML API Source: https://context7.com/colortastic/innocigs_api/llms.txt Authenticates with the InnoCigs XML API using customer ID and API password via URL parameters. This method is for legacy integrations. ```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" ``` -------------------------------- ### Query Single Product Stock (REST API) Source: https://context7.com/colortastic/innocigs_api/llms.txt Retrieves the current inventory level for a specific product using its model number via the REST API. Returns the product's quantity and shipping status. ```bash # REST API - Get stock for specific product curl -H "Auth: 12345:password" \ "https://www.innocigs.com/restapi/quantity/IC10000AIO-10" ``` -------------------------------- ### POST /restapi/order Source: https://context7.com/colortastic/innocigs_api/llms.txt Submit a standard order that ships to the reseller's registered address. ```APIDOC ## POST /restapi/order ### Description Submit standard order that ships to reseller's registered address (not dropship). ### Method POST ### Endpoint `https://www.innocigs.com/restapi/order` ### Parameters #### Headers - **Auth** (string) - Required - Authentication token. - **Content-Type** (string) - Required - `application/json` - **shipping** (string) - Optional - Specify shipping carrier (e.g., 'UPS'). #### Request Body - **ORDER** (object) - Required - Main object for the order. - **DATA** (object) - Required - Contains order and receiver details. - **ORDERS_NUMBER** (string) - Required - Unique identifier for the order. - **RECEIVER** (object) - Required - Information about the receiver (reseller). - **FIRSTNAME** (string) - Required - Receiver's first name. - **LASTNAME** (string) - Required - Receiver's last name. - **STREET_ADDRESS** (string) - Required - Receiver's street address. - **POSTCODE** (string) - Required - Receiver's postal code. - **CITY** (string) - Required - Receiver's city. - **COUNTRY_CODE** (string) - Required - Receiver's country code (e.g., 'DE'). - **COMPANY** (string) - Required - Receiver's company name. - **EMAIL** (string) - Required - Receiver's email address. - **PRODUCTS** (array) - Required - List of products in the order. - **PRODUCTS_MODEL** (string) - Required - Product model identifier. - **QUANTITY** (integer) - Required - Number of units for the product. ### Request Example ```json { "ORDER": { "DATA": { "ORDERS_NUMBER": "ORDER5678", "RECEIVER": { "FIRSTNAME": "Store", "LASTNAME": "Manager", "STREET_ADDRESS": "Business St 23", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "COMPANY": "My Vape Store GmbH", "EMAIL": "orders@example.com" } }, "PRODUCTS": [ { "PRODUCTS_MODEL": "IC10000L10-TE-3", "QUANTITY": 2 }, { "PRODUCTS_MODEL": "IC10000AIO-10", "QUANTITY": 1 } ] } } ``` ### Response #### Success Response (200) - **ORDER** (object) - Contains the result of the standard order submission. - **ORDERS_NUMBER** (string) - The order number. - **STATUS** (string) - Status of the operation ('OK' or 'NOK'). - **MESSAGE** (string) - A message describing the result. - **ORDERS_ID** (integer) - The internal order ID. #### Response Example ```json { "ORDER": { "ORDERS_NUMBER": "ORDER5678", "STATUS": "OK", "MESSAGE": "Bestellung erfolgreich eingetragen", "ORDERS_ID": 1151607 } } ``` #### Error Response Example ```json { "ORDER": { "ORDERS_NUMBER": "ORDER5678", "STATUS": "NOK", "MESSAGE": "Eintragen der Bestellung fehlgeschlagen", "ORDERS_ID": -1, "ERRORS": [ { "CODE": 30001, "MESSAGE": "AS100AMZ nicht lieferbar" } ] } } ``` ``` -------------------------------- ### Authenticate REST API Source: https://context7.com/colortastic/innocigs_api/llms.txt Authenticates with the InnoCigs REST API using credentials provided in the 'Auth' HTTP header. This is the modern approach for API interaction. ```bash # Query all product quantities using REST API curl -H "Auth: 12345:your-api-password" \ "https://www.innocigs.com/restapi/quantity_all" ``` -------------------------------- ### POST /restapi/dropship Source: https://context7.com/colortastic/innocigs_api/llms.txt Submit dropship orders with shipper/receiver addresses and product lists. The order ships directly to the end customer. ```APIDOC ## POST /restapi/dropship ### Description Submit dropship order with shipper/receiver addresses and product list. Order ships directly to end customer. ### Method POST ### Endpoint `https://www.innocigs.com/restapi/dropship` ### Parameters #### Headers - **Auth** (string) - Required - Authentication token. - **Content-Type** (string) - Required - `application/json` #### Request Body - **DROPSHIPPING** (object) - Required - Main object for dropshipping. - **DROPSHIP** (object) - Required. - **DATA** (object) - Required - Contains order and address details. - **ORDERS_NUMBER** (string) - Required - Unique identifier for the order. - **SHIPPER** (object) - Required - Information about the shipper. - **COMPANY** (string) - Required - Shipper's company name. - **FIRSTNAME** (string) - Required - Shipper's first name. - **LASTNAME** (string) - Required - Shipper's last name. - **STREET_ADDRESS** (string) - Required - Shipper's street address. - **POSTCODE** (string) - Required - Shipper's postal code. - **CITY** (string) - Required - Shipper's city. - **COUNTRY_CODE** (string) - Required - Shipper's country code (e.g., 'DE'). - **EMAIL** (string) - Required - Shipper's email address. - **TELEPHONE** (string) - Required - Shipper's telephone number. - **RECEIVER** (object) - Required - Information about the end customer. - **COMPANY** (string) - Optional - Receiver's company name. - **FIRSTNAME** (string) - Required - Receiver's first name. - **LASTNAME** (string) - Required - Receiver's last name. - **STREET_ADDRESS** (string) - Required - Receiver's street address. - **POSTCODE** (string) - Required - Receiver's postal code. - **CITY** (string) - Required - Receiver's city. - **COUNTRY_CODE** (string) - Required - Receiver's country code (e.g., 'DE'). - **EMAIL** (string) - Required - Receiver's email address. - **BIRTHDAY** (string) - Optional - Receiver's birthday (format: 'DD.MM.YYYY'). - **PRODUCTS** (array) - Required - List of products in the order. - **PRODUCTS_MODEL** (string) - Required - Product model identifier. - **QUANTITY** (integer) - Required - Number of units for the product. ### Request Example ```json { "DROPSHIPPING": { "DROPSHIP": { "DATA": { "ORDERS_NUMBER": "ORDER1234", "SHIPPER": { "COMPANY": "My Vape Store", "FIRSTNAME": "John", "LASTNAME": "Smith", "STREET_ADDRESS": "Main St 10", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "EMAIL": "shop@example.com", "TELEPHONE": "040 123456" }, "RECEIVER": { "COMPANY": "Customer Company", "FIRSTNAME": "Jane", "LASTNAME": "Doe", "STREET_ADDRESS": "Test St 23", "POSTCODE": "22761", "CITY": "Hamburg", "COUNTRY_CODE": "DE", "EMAIL": "customer@test.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) - Contains the result of the dropship order submission. - **DROPSHIP** (object) - **ORDERS_NUMBER** (string) - The order number. - **STATUS** (string) - Status of the operation ('OK' or 'NOK'). - **MESSAGE** (string) - A message describing the result. - **DROPSHIP_ID** (integer) - The unique ID assigned to the dropship order. - **ORDERS_ID** (integer) - The internal order ID. #### Response Example ```json { "DROPSHIPPING": { "DROPSHIP": { "ORDERS_NUMBER": "ORDER1234", "STATUS": "OK", "MESSAGE": "Dropship erfolgreich eingetragen", "DROPSHIP_ID": 68, "ORDERS_ID": 77 } } } ``` #### Error Response Example ```json { "DROPSHIPPING": { "DROPSHIP": { "ORDERS_NUMBER": "ORDER1234", "STATUS": "NOK", "MESSAGE": "Dropship fehlgeschlagen", "DROPSHIP_ID": -1, "ORDERS_ID": -1, "ERRORS": [ { "CODE": 30001, "MESSAGE": "AS100AMZ nicht lieferbar" } ] } } } ``` ```