Overview

The Products Collection contains all product data related to a product catalog. It's a supplemental collection designed specifically to accommodate product data. The most common product-related attributes are provided by default as part of the schema.

• API Set Name: products

Related collections

The following resource collections are associated to this collection.

POST /products

Parameters

*Required

Example JSON requests

Simple example (minimum requirements)

{
    "productID": "AC30",
    "productName": "Acme-30 Stapler"
}

Kitchen sink example (optional fields included)

{
    "productID": "AC30",
    "productName": "Acme-30 Stapler",
    "variants": [
        {
            "sku": "AC30-1000R",
            "attr": {
                "color": "red",
                "size": "10-inch"
            },
            "qty": 100
        },
        {
            "sku": "AC30-1000B",
            "attr": {
                "color": "blue",
                "size": "10-inch"
            },
            "qty": 100
        }
    ],
    "productType": "physical",
    "price": 14.95,
    "sale": {
	    "enabled": true,
	    "price": 12.95,
	    "start": "2016-09-13",
	    "end": "2016-10-13"
	  },
    "UPCCode": "8 34460 00372 4",
    "category": "office_supplies",
    "description": "Reliable for up to 20 pages!",
    "images": [
        "http://acmeofficesupplies.com/img/ac30-red", "http://acmeofficesupplies.com/img/ac30-blue"
    ],
    "manufacturerName": "Acme Office Supplies",
    "inStock": true,
    "taxable": true,
    "enabled": true,
    "url": "http://acmeofficesupplies.com/AC30",
    "tags": [
        "office",
        "office supplies",
        "stapler",
        "stationary"
      ],
    "properties": {
        "some-key1":"value1",
        "some-key2":"value2"
     }
}

Example request URIs

The following URI in conjunction with the JSON will perform the POST.

http://<path>/products

GET /products

Parameters

Example request URIs

Return all records

The following URI will retrieve all products and include all fields.

http://<path>/products

Return records filtered by a field

The following URI will retrieve all orders, but only include the field data for the productName.

http://<path>/products?fields=productName

Return records filtered by multiple fields

The following URI will retrieve all orders, and include the field data for both productName and category.

http://<path>/products?fields=productName,category

Return records filtered by page number and records per page

The following URI will retrieve all products starting from the third page grouping contacts by 10. For example, page 1 would have included the first 10, page 2 the second group of 10 and so on.

http://<path>/products?page=3&per_page=10

GET /products/{id}

Example request URIs

The following URI will retrieve the product where the product id is 112233. It will include all fields.

http://<path>/products/112233

PUT /products/{id}

Required and optional parameters

Same requirements and schema as the POST method above.

Example JSON requests

The following will update the Acme-30 Stapler, changing the price to 16.95 and marking it as not in stock.

{
    "productID": "AC30",
    "productName": "Acme-30 Stapler",
    "price": "16.95",
    "inStock": false
}

Example request URIs

The following URI in conjunction with the JSON will perform the PUT for the product with the productID of AC30.

http://<path>/products/AC30

DELETE /products/{id}

Example request URIs

The following URI will delete the product where the product id is 112233.

http://<path>/products/112233

Error responses

The Cordial API will return an error object with an errorKey and message if there is a problem with an API call. Below is a list of errors specific to the Products API endpoint, along with suggested modifications to resolve each error. If you receive an error from this API endpoint that is not listed in this table, it's likely recorded within the Global API Error Responses page.