Search 1.0.0

The Search service is a proprietary, non-PromoStandards-based service that can be used to process product search requests. This is the same service used by Promo.zone, the popular promotional products search engine.


Functions Supported

The Search service supports these functions:


HTTP Method and URL

HTTP Method: POST
URL: https://api.promo.zone/


searchProducts Requests

The function supports the following parameters.

Parameter Description Required
apiKey The Promo.zone API Key that has been assigned to you. Note that this is not an ID assigned to you by suppliers. Yes
service The service being requested. (Search) Yes
version The version of the service. (1.0.0) Yes
function The PromoStandards Search API function being requested. (searchProducts) Yes
keywords One or more keywords to search for. For example: noise cancelling headphones Yes
supplierCode The code representing the specific supplier whose products should be returned. For a list of supplier codes, use the getSuppliers function. No
limit The maximum number of products to be returned. The default value is 25. The maximum is 500. No
offset The number of products to "skip" when returning results. This parameter is used to return products using pagination. Default value is 0. No
scoreBoostImage A numeric value that can be used to increase the "score" of products that have primary images. No

Example Request

{
  "apiKey": "** Your Promo.zone API Key **",
  "service": "Search",
  "version": "1.0.0",
  "function": "searchProducts",
  "keywords": "first aid kit",
  "limit": "5"
}		
			

Example Response

{
  "status": "200",
  "criteria": {
    "keywords": "first aid kit",
    "supplierCode": "",
    "limit": 5,
    "offset": 0,
    "scoreBoostImage": 0
  },
  "results": {
    "totalFoundCount": 72,
    "foundCount": 5,
    "products": [
      {
        "score": "27.65756035",
        "supplierCode": "STAR",
        "supplierName": "Starline",
        "productID": "FA05",
        "productName": "133 Piece All Purpose First Aid Kit",
        "primaryImageURL": "http:\/\/cdn.starline.com\/images\/product\/FA05\/lg_16305.jpg",
        "primaryImageHeight": "700",
        "primaryImageWidth": "700",
        "validTimestamp": "2018-07-23 11:00:35"
      },
      {
        "score": "27.65756035",
        "supplierCode": "STAR",
        "supplierName": "Starline",
        "productID": "TS19",
        "productName": "Roadsafe First Aid\/Emergency Kit",
        "primaryImageURL": "http:\/\/cdn.starline.com\/images\/product\/TS19\/lg_17219.jpg",
        "primaryImageHeight": "700",
        "primaryImageWidth": "700",
        "validTimestamp": "2018-07-23 11:06:32"
      },
      {
        "score": "26.53445053",
        "supplierCode": "BIC",
        "supplierName": "BIC Graphic",
        "productID": "41061",
        "productName": "Laureate First Aid Bag",
        "primaryImageURL": "",
        "primaryImageHeight": "0",
        "primaryImageWidth": "0",
        "validTimestamp": "2018-07-23 13:50:04"
      },
      {
        "score": "25.25297737",
        "supplierCode": "PCNA",
        "supplierName": "PCNA (Leed's\/Bullet\/Trimark)",
        "productID": "SM-1506",
        "productName": "On The Go First Aid Pack",
        "primaryImageURL": "",
        "primaryImageHeight": "0",
        "primaryImageWidth": "0",
        "validTimestamp": "2018-07-24 11:51:26"
      },
      {
        "score": "24.8506012",
        "supplierCode": "PCNA",
        "supplierName": "PCNA (Leed's\/Bullet\/Trimark)",
        "productID": "SM-1520",
        "productName": "Bolt 20 Piece First Aid Kit",
        "primaryImageURL": "",
        "primaryImageHeight": "0",
        "primaryImageWidth": "0",
        "validTimestamp": "2018-07-24 11:49:52"
      }
    ]
  }
}			
			

getProduct Requests

The function supports the following parameters.

Parameter Description Required
apiKey The Promo.zone API Key that has been assigned to you. Note that this is not an ID assigned to you by suppliers. Yes
service The service being requested. (Search) Yes
version The version of the service. (1.0.0) Yes
function The PromoStandards Search API function being requested. (getProduct) Yes
supplierCode The code representing the specific supplier whose products should be returned. For a list of supplier codes, use the getSuppliers function. Yes
productID The ID of the product to be retrieved. Yes

Example Request

{
	"apiKey": "** Your Promo.zone API Key **",
	"service": "Search",
	"version": "1.0.0",	
	"function": "getProduct",
	"supplierCode": "HIT",
	"productID": "9421"
}		
			

Example Response

{
  "status": "200",
  "product": {
    "supplierCode": "HIT",
    "supplierName": "HIT Promotional Products",
    "productID": "9421",
    "productName": "First Aid Kit",
    "primaryImageURL": "http:\/\/hitpromo.net\/imageManager\/show\/9421_RED_Silkscreen.jpg",
    "primaryImageHeight": "0",
    "primaryImageWidth": "0",
    "validTimestamp": "2018-07-23 11:21:06",
    "productInfoJSON": {
      "Status": "200",
      "Response": {
        "Envelope": {
          "Body": {
            "GetProductResponse": {
              "Product": {
                "productId": "9421",
                "productName": "First Aid Kit",
                "description": "Kit Includes: Scissors, Safety Pins, Bandage Fasteners, Alcohol Swabs, Tweezers, Pill Bottle, Gloves, Ear Swabs, Roll Of Tape, Roll Of Cotton, Gauze Pad, Assortment Of Bandages, Sewing Needle, Thread And Two Buttons. Zippered Closure And Belt Loop Attachment. Bandages Are Latex Free.",
                "ProductMarketingPointArray": {
                  "ProductMarketingPoint": [
                    {
                      "pointType": "Highlight",
                      "pointCopy": "Kit Includes: Scissors, Safety Pins, Bandage Fasteners, Alcohol Swabs, Tweezers, Pill Bottle, Gloves, Ear Swabs, Roll Of Tape, Roll Of Cotton, Gauze Pad, Assortment Of Bandages, Sewing Needle, Thread And Two Buttons."
                    },
                    {
                      "pointType": "Highlight",
                      "pointCopy": "Zippered Closure And Belt Loop Attachment."
                    },
                    {
                      "pointType": "Highlight",
                      "pointCopy": "Bandages Are Latex Free."
                    }
                  ]
                },
                "productBrand": "",
                "export": "false",
                "ProductCategoryArray": {
                  "ProductCategory": {
                    "category": "Amenities",
                    "subCategory": "First Aid Products"
                  }
                },
                "ProductPartArray": {
                  "ProductPart": {
                    "partId": "9421RED",
                    "countryOfOrigin": "US",
                    "ColorArray": {
                      "Color": {
                        "colorName": "RED",
                        "hex": "C8102E"
                      }
                    },
                    "primaryMaterial": "Nylon",
                    "shape": "",
                    "Dimension": {
                      "dimensionUom": "IN",
                      "depth": "0.0000",
                      "height": "4.5000",
                      "width": "5.0000",
                      "weightUom": "ME",
                      "weight": "0.0000"
                    },
                    "leadTime": "5",
                    "gtin": "",
                    "isRushService": "false",
                    "ShippingPackageArray": {
                      "ShippingPackage": [
                        {
                          "packageType": "Box",
                          "description": "9D",
                          "quantity": "200.0000",
                          "dimensionUom": "IN",
                          "depth": "25.0000",
                          "height": "13.0000",
                          "width": "17.0000",
                          "weightUom": "LB",
                          "weight": "34.0000"
                        },
                        {
                          "packageType": "Box",
                          "description": "D0",
                          "quantity": "100.0000",
                          "dimensionUom": "IN",
                          "depth": "19.0000",
                          "height": "12.0000",
                          "width": "15.0000",
                          "weightUom": "LB",
                          "weight": "18.0000"
                        }
                      ]
                    },
                    "endDate": "2023-05-01T00:00:00",
                    "effectiveDate": "2018-05-01T00:00:00",
                    "isCloseout": "false",
                    "isCaution": "",
                    "nmfcCode": "0.0000",
                    "nmfcDescription": "",
                    "nmfcNumber": "",
                    "isOnDemand": "false",
                    "isHazmat": ""
                  }
                },
                "lastChangeDate": "2017-05-17T05:01:59",
                "creationDate": "2016-01-01T00:00:00",
                "endDate": "2023-05-01T00:00:00",
                "effectiveDate": "2018-05-01T00:00:00",
                "isCaution": "false",
                "isCloseout": "false",
                "lineName": ""
              }
            }
          }
        }
      }
    },
    "mediaContentJSON": {
      "Status": "200",
      "Response": {
        "Envelope": {
          "Body": {
            "GetMediaContentResponse": {
              "MediaContentArray": {
                "MediaContent": {
                  "productId": "9421",
                  "partId": "9421RED",
                  "url": "http:\/\/hitpromo.net\/imageManager\/show\/9421_RED_Silkscreen.jpg",
                  "mediaType": "Image",
                  "ClassTypeArray": {
                    "ClassType": {
                      "classTypeId": "1006",
                      "classTypeName": "Primary"
                    }
                  },
                  "DecorationArray": {
                    "Decoration": {
                      "decorationId": "54",
                      "decorationName": "Silk-Screen"
                    }
                  },
                  "description": "",
                  "singlePart": "false"
                }
              }
            }
          }
        }
      }
    }
  }
}		
			

getSuppliers Requests

The function supports the following parameters.

Parameter Description Required
apiKey The Promo.zone API Key that has been assigned to you. Note that this is not an ID assigned to you by suppliers. Yes
service The service being requested. (Search) Yes
version The version of the service. (1.0.0) Yes
function The PromoStandards Search API function being requested. (getSuppliers) Yes

Example Request

{
	"apiKey": "** Your Promo.zone API Key **",
	"service": "Search",
	"version": "1.0.0",
	"function": "getSuppliers"	
}		
			

Example Response

{
  "status": "200",
  "suppliers": [
    {
      "code": "alphabroder",
      "name": "Alphabroder",
      "products": "5677"
    },
    {
      "code": "BIC",
      "name": "BIC Graphic",
      "products": "3861"
    },
    {
      "code": "GEM",
      "name": "Gemline",
      "products": "813"
    },
    {
      "code": "HIT",
      "name": "HIT Promotional Products",
      "products": "3700"
    },
    {
      "code": "PCNA",
      "name": "PCNA (Leed's\/Bullet\/Trimark)",
      "products": "4978"
    },
    {
      "code": "STAR",
      "name": "Starline",
      "products": "899"
    },
    {
      "code": "MAG",
      "name": "The Magnet Group",
      "products": "2423"
    }
  ]
}
			

getInventory Requests

The function supports the following parameters.

Parameter Description Required
apiKey The Search API key that has been assigned to you. Note that this is not an ID assigned to you by suppliers. Yes
service The service being requested. (Search) Yes
version The version of the service. (1.0.0) Yes
function The Search API function being requested. (getInventory) Yes
supplierCode The code assigned by PromoStandards to the supplier. Yes
productID The ID of the product. Yes

Example Request

{
	"apiKey": "** Your Promo.zone API Key **",	
	"service": "Search",
	"version": "1.0.0",
	"function": "getInventory",
	"supplierCode": "HIT",	
	"productID": "2543"	
}

			

Example Response

{
  "Error": {
    "Code": "0",
    "Message": ""
  },
  "Response": {
    "Envelope": {
      "Body": {
        "Reply": {
          "productID": "2543",
          "ProductVariationInventoryArray": {
            "ProductVariationInventory": [
              {
                "partID": "2543ROY",
                "partDescription": "LED LOOP FLASHLIGHT ROY",
                "quantityAvailable": "20341",
                "attributeColor": "ROYAL BLUE",
                "customProductMessage": "Available week of 2019-02-18",
                "validTimestamp": "2018-11-27T13:25:49-05:00"
              },
              {
                "partID": "2543RED",
                "partDescription": "LED LOOP FLASHLIGHT RED",
                "quantityAvailable": "13730",
                "attributeColor": "RED",
                "validTimestamp": "2018-11-27T13:25:49-05:00"
              },
              {
                "partID": "2543ORN",
                "partDescription": "LED LOOP FLASHLIGHT ORN",
                "quantityAvailable": "9511",
                "attributeColor": "ORANGE",
                "customProductMessage": "Available week of 2018-12-31",
                "validTimestamp": "2018-11-27T13:25:49-05:00"
              },
              {
                "partID": "2543GRN",
                "partDescription": "LED LOOP FLASHLIGHT GRN",
                "quantityAvailable": "5282",
                "attributeColor": "GREEN",
                "customProductMessage": "Available week of 2019-02-18",
                "validTimestamp": "2018-11-27T13:25:49-05:00"
              }
            ]
          }
        }
      }
    }
  }
}
			

© Copyright 2019 Dietrich Enterprises, LLC.