Creating Quotes for Promotional Products via API

Creating Quotes for Promotional Products via API

This guide outlines how to create quotes in printIQ for promotional and apparel products using the API. It includes the required payload structure, key validations, and expected usage scenarios.


API Support Overview

The printIQ API supports ordering Promotional Product Kits via GetPrice and CreateQuoteWithDelivery. This includes:

  • Specifying a product range or category

  • Listing one or more sales items with quantity

  • Optionally including embellishments with finishing options


Sample Payloads

Basic Quote with Promotional Product

{
  "JobTitle": "Promotional Product Order",
  "CustomerCode": "SampleCustomer",
  "SelectedQuantity": {
    "Quantity": 1,
    "Kinds": 1,
    "TargetRetailPrice": 0
  },
  "CustomerExpectedDate": "2024-06-30T12:00:00.000Z",
  "JobDueDate": "2024-06-25T00:00:00.000Z",
  "AcceptQuote": false,
  "PromotionalProduct": {
    "Range": "Promo Range A",
    "Category": "Promo Category A",
    "SalesItems": [
      {
        "Code": "Item123",
        "Quantity": 10
      }
    ],
    "Embellishments": []
  }
}

Quote with Embellishment Operation

{
  "JobTitle": "Promo Order with Embellishment",
  "CustomerCode": "SampleCustomer",
  "SelectedQuantity": {
    "Quantity": 1,
    "Kinds": 1,
    "TargetRetailPrice": 0
  },
  "CustomerExpectedDate": "2024-06-30T12:00:00.000Z",
  "JobDueDate": "2024-06-25T00:00:00.000Z",
  "AcceptQuote": false,
  "PromotionalProduct": {
    "Range": "Promo Range A",
    "Category": "Promo Category A",
    "SalesItems": [
      {
        "Code": "Item123",
        "Quantity": 10
      }
    ],
    "Embellishments": [
      {
        "Code": "Embellish001",
        "Operations": [
          {
            "Name": "EMB-STANDARD"
          }
        ]
      }
    ]
  }
}

Payload Fields Explained

"PromotionalProduct": {
  "Range": "string",              // Required unless items have no range
  "ProductCategory": "string",    // Optional unless multiple categories exist
  "SalesItems": [
    { "Code": "string", "Quantity": 0 }
  ],
  "Embellishments": [
    {
      "Code": "string",
      "Operations": [
        {
          "Name": "string",         // Required
          "Reference": "string",    // Optional
          "Group": "string"         // Optional
        }
      ]
    }
  ]
}

Note: Only the Name field is required under Operations. Reference and Group are optional.


Validation Rules

To ensure a successful quote, the following validations apply:

  • All sales item codes must exist and be active

  • If a range is specified, all sales items must belong to that range

  • If no range is provided, a product category must be included

  • If items are in multiple categories, a specific category must be selected

  • Embellishments must be valid and correctly mapped to the sales items

  • Finishing operations should match expected reference/group answers if used

If validation fails, the API will return a descriptive error message.


Summary

This API functionality enables users to seamlessly quote promotional products and apparel using printIQ. Make sure your request payload follows the format outlined above, and includes valid sales items and embellishment details where needed.

For further assistance, please contact your printIQ support representative.

    • Related Articles

    • Promotional Products

      Promotional Products are a type of sales items/IQstore items that are grouped together based on a product range to provide customers with the option to order a collection of related items together, instead of ordering them separately. Additionally, ...
    • Bulk Upload IQstore Items

      IQ Store Items can be created and modified in bulk using the sales item import / export options on the IQStore Admin screen toolbar. Download the CSV Selecting Import from the drop-down menu will open a file selector to select the CSV for upload. The ...
    • PRODUCT CATALOGUE – Product Range Items

      Product Range items can be created and managed from the ‘Product Range Items’ screen: From here you can search on existing items, edit existing and create new items: To add a new item manually (this can be done here or at the time of creating a ...
    • Creating a Quote Using Filter Values in printIQ API

      This guide outlines the steps required to create a quote in printIQ using filter values specific to a customer, including retrieving product categories and their associated filters. Step 1: Get Tree Nodes for a Specific Customer Endpoint: ...
    • PRODUCT CATALOGUE – Create and Edit a Product Range

      A ‘Product Range’ is a method of configuring ranges where the production of all items within the range is identical (apart from maybe the colours/PMS inks used). These range includes multiple items all with different artwork. Using a product range ...