Request Offset API Key

Offset Product API

BASE URL https://api.securecheckout.com/v1/

Welcome to the Offset Product API documentation. This API can be used for manageing product data and inventory for the Offset platform.

Headers

There are 2 HTTP Headers used by the JS Cart API:

  • Content-Type
  • X-Auth-Token

The Content-Type header should be set to application/json for all requests.

The X-Api-Key header is used to authenticate with the API server.

Getting Started

Every request needs an API key. An authorized user can provision one in Offset Commerce under Settings › More › API Keys. No account, or need a hand? Email developer@offsetpartners.com.

Thank you for choosing Offset to power your wine business.

Categories

Resources related to Categories.

POST /prodadmin/categories Create a new Category
Examples
Request
POST/prodadmin/categories
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Body
{
    "slug": "bubbles",
    "name": "bubbles",
    "description": "Champagne"
}
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "15",
    "slug": "bubbles",
    "name": "bubbles",
    "sort": "3",
    "status": "Active",
    "description": "Champagne",
    "short_description": "",
    "extended_description": "",
    "image": ""
}
DELETE /prodadmin/categories/{id} Delete Category
Examples
Request
DELETE/prodadmin/categories/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
true
GET /prodadmin/categories/{id} Get Category
Examples
Request
GET/prodadmin/categories/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "1",
    "slug": "store",
    "name": "Store Front",
    "sort": "1",
    "status": "Active",
    "description": "Store Front",
    "short_description": "",
    "extended_description": "",
    "image": ""
}
GET /prodadmin/categories Get List of Available Categories
Examples
Request
GET/prodadmin/categories
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "1",
        "slug": "store",
        "name": "Store Front",
        "sort": "1",
        "status": "Active",
        "description": "Store Front",
        "short_description": "",
        "extended_description": "",
        "image": ""
    },
    {
        "id": "11",
        "slug": "nov-2021-offering",
        "name": "Nov 2021 Offering",
        "sort": "2",
        "status": "Active",
        "description": "",
        "short_description": "",
        "extended_description": "",
        "image": ""
    },
    {
        "id": "15",
        "slug": "bubbles",
        "name": "bubbles",
        "sort": "3",
        "status": "Active",
        "description": "Champagne",
        "short_description": "",
        "extended_description": "",
        "image": ""
    }
]
PUT /prodadmin/categories/{id} Update Category
Examples
Request
PUT/prodadmin/categories/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Body
{
    "slug": "bubbles",
    "name": "bubbles",
    "description": "Champagne"
}
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "15",
    "slug": "bubbles",
    "name": "bubbles",
    "sort": "3",
    "status": "Active",
    "description": "Champagne",
    "short_description": "",
    "extended_description": "",
    "image": ""
}
PUT /prodadmin/categories/{id}/products/{sku} Add Product to Category
Examples
Request
PUT/prodadmin/categories/{id}/products/{sku}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
true
GET /prodadmin/categories/{id}/products Get Product in Category
Examples
Request
GET/prodadmin/categories/{id}/products
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "3",
        "name": "2009 Cabernet Sauvignon",
        "sku": "123-ABC",
        "price": "65.00",
        "description": "Hundred year old vines have worked their roots deep, deep into the hillside soils of the storied Black Hawk Vineyard in Oakville to produce small amounts of the sultry, supple fruit used in this 100% Cabernet Sauvignon. Aged in a mix of the finest new and used oak for 18 months, then bottled and cellared for an additional 24 months deep in the heart of our century-old cave system, this wine is redolent of black fruit with a hint of spice box, tar, and graphite.  Drink now or age for up to 50 years.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "Unreal. A Napa Valley Cab that is truly worthy drinking.<br>Wine Review Online",
        "aging": "18 Months in French Barrels",
        "alcohol": "16.5",
        "appellation": "Oakville, Napa Valley",
        "blend": "100% Cabernet Sauvignon",
        "bottle_count": "1",
        "bottle_size": "750mL",
        "case_production": "60",
        "country": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV09NVCS1-1204.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
        "max_purchase_quantity": "9",
        "new_product": "Yes",
        "not_availible_message": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 1, 2012",
        "residual_sugar": "",
        "retail_price": "0.00",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "Active",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": ".06",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": {
            "2": {
                "id": "2",
                "name": "Past Vintages",
                "sort": "1"
            }
        },
        "quantity": "0"
    },
    {
        "id": "5",
        "name": "2009 Red Blend",
        "sku": "AV10NVRB",
        "price": "38.00",
        "description": "Our Chardonnay was produced from vines located on the south side of our Katie's Hill vineyard. The microclimate of this gentle knoll is just right for producing a white wine that offers rich and supple fruit on the palate while retaining enough acid to keep it light and crisp. The use of restrained oak in the cellar further adds to the depth of this wine, making it one of our personal favorites for starting a meal, or pairing with fish.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "Another wonderfully crisp drinkable Chardonnay from Acme.<br>Wine Reviewer",
        "aging": "3 months in second year Oak",
        "alcohol": "13.5",
        "appellation": "Rutherford Napa Valley",
        "blend": "98% Chardonnay, 2% Viognier",
        "bottle_count": "1",
        "bottle_size": "750mL",
        "case_production": "235",
        "cost": "0.00",
        "country": "",
        "custom01": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "September 2, 2010",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRB-3972.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCH-2610.jpg",
        "label": "",
        "max_purchase_quantity": "",
        "not_availible_message": "",
        "oak": "Francois Freres French Oak",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "October 2011",
        "residual_sugar": "",
        "retail_price": "40.00",
        "shipping_offer_min": "",
        "short_description": "Estate-grown Chardonnay from Katie's Hill Vineyard",
        "soil": "",
        "starting_quantity": "999",
        "status_availability": "",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": "",
        "tasting_notes_pdf": "",
        "upc": "",
        "varietal": "CHARDONNAY",
        "vineyard": "Katie's Hill Vineyard",
        "vintage": "2009",
        "winemaker": "Owen Benson",
        "wine_type": "WHITE",
        "categories": {
            "2": {
                "id": "2",
                "name": "Past Vintages",
                "sort": "2"
            }
        },
        "quantity": "50"
    }
]
DELETE /prodadmin/categories/{id}/products/{sku} Remove a Product from Category
Examples
Request
DELETE/prodadmin/categories/{id}/products/{sku}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
true

Inventory

Resources related to Inventory.

POST /prodadmin/inventory/{sku} Adjust Inventory By SKU
Parameters
NameTypeRequiredDescriptionExample
location number Optional Inventory Location
note string Optional Reason for adjustment
quantity number Required Adjustment amount
user string Optional User making adjustment
sku string Required Product SKU
Examples
Request
POST/prodadmin/inventory/{sku}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Body
{
    "quantity": 24,
    "location": "West Coast Warehouse",
    "note": "Transfer from Tasting Room",
    "user": "John Doe"
}
Response
Headers · 200
Content-Type: application/json
Body
{
    "sku": "AV09NVCS",
    "location": "West Coast Warehouse",
    "quantity": "64"
}
GET /prodadmin/inventory Get All Inventory
Examples
Request
GET/prodadmin/inventory
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "AV09NVCS": 100,
    "AV09NVCH": 0,
    "AV10NVRB": 3,
    "AV08NVCH": 0,
    "AV10NVRCS": 3983,
    "AV11NVRCS": 499
}
GET /prodadmin/inventory/{sku} Get Inventory By SKU
Parameters
NameTypeRequiredDescriptionExample
sku string Required Product SKU
Examples
Request
GET/prodadmin/inventory/{sku}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
100
GET /prodadmin/inventory/location/{location} Get All Inventory by Location
Parameters
NameTypeRequiredDescriptionExample
location string Required Inventory Location
Examples
Request
GET/prodadmin/inventory/location/{location}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "AV09NVCS": 100,
    "AV09NVCH": 0,
    "AV10NVRB": 3,
    "AV08NVCH": 0,
    "AV10NVRCS": 3983,
    "AV11NVRCS": 499
}
GET /prodadmin/inventory/location/{location}/{sku} Get Inventory By Location
Parameters
NameTypeRequiredDescriptionExample
location string Required Inventory Location
sku string Required Product SKU
Examples
Request
GET/prodadmin/inventory/location/{location}/{sku}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
76

InventoryLocations

Resources related to InventoryLocations.

GET /prodadmin/inventory-locations Get All Inventory Locations
Examples
Request
GET/prodadmin/inventory-locations
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "1": {
        "id": "1",
        "name": "Website",
        "description": "Website"
    },
    "2": {
        "id": "2",
        "name": "Tasting Room",
        "description": "Tasting Room"
    },
    "3": {
        "id": "3",
        "name": "Library",
        "description": "Library"
    }
}

Products

Resources related to Products.

POST /prodadmin/products Create a new Product
Parameters
NameTypeRequiredDescriptionExample
name string Required Product Description
price number Optional Product Price
sku string Required Unique Product SKU
Examples
Request
POST/prodadmin/products
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Body
{
    "sku": "132-ABC",
    "name": "2018 Cabernet Sauvignon",
    "status": "Active",
    "price": "100.00",
    "alcohol": "14.5",
    "appellation": "Oakville, Napa Valley"
}
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "1003",
    "sku": "132-ABC",
    "name": "2018 Cabernet Sauvignon",
    "status": "Active",
    "price": "100.00",
    "alcohol": "14.5",
    "appellation": "Oakville, Napa Valley"
}
DELETE /prodadmin/products/{sku} Delete a Product by SKU
Parameters
NameTypeRequiredDescriptionExample
sku string Required Product SKU
Examples
Request
DELETE/prodadmin/products/{sku}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
true
POST /prodadmin/products/filter Filter List of Products
Examples
Request
POST/prodadmin/products/filter
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Body
[
    {
        "type": "range",
        "key": "last_update",
        "from": 1660978800,
        "to": 1662188400
    },
    {
        "type": "term",
        "key": "bottle_size",
        "value": "750mL"
    },
    {
        "type": "terms",
        "key": "wine_type",
        "value": [
            "Red",
            "White"
        ]
    },
    {
        "type": "range",
        "key": "price",
        "from": 35,
        "to": 75
    }
]
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "3",
        "name": "2009 Cabernet Sauvignon",
        "sku": "123-ABC",
        "price": "65.00",
        "created": "2022-06-20 12:38:56",
        "last_update": "2022-08-21 14:45:21",
        "description": "Hundred year old vines have worked their roots deep, deep into the hillside soils of the storied Black Hawk Vineyard in Oakville to produce small amounts of the sultry, supple fruit used in this 100% Cabernet Sauvignon. Aged in a mix of the finest new and used oak for 18 months, then bottled and cellared for an additional 24 months deep in the heart of our century-old cave system, this wine is redolent of black fruit with a hint of spice box, tar, and graphite.  Drink now or age for up to 50 years.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "Unreal. A Napa Valley Cab that is truly worthy drinking.<br>Wine Review Online",
        "aging": "18 Months in French Barrels",
        "alcohol": "16.5",
        "appellation": "Oakville, Napa Valley",
        "blend": "100% Cabernet Sauvignon",
        "bottle_count": "1",
        "bottle_size": "750mL",
        "case_production": "60",
        "country": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV09NVCS1-1204.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
        "max_purchase_quantity": "9",
        "new_product": "Yes",
        "not_availible_message": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 1, 2012",
        "residual_sugar": "",
        "retail_price": "0.00",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "Active",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": ".06",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": {
            "2": {
                "id": "2",
                "name": "Past Vintages",
                "sort": "1"
            }
        },
        "quantity": "0"
    },
    {
        "id": "5",
        "name": "2009 Red Blend",
        "sku": "AV10NVRB",
        "price": "38.00",
        "created": "2022-07-22 10:17:38",
        "last_update": "2022-09-02 16:09:52",
        "description": "Our Chardonnay was produced from vines located on the south side of our Katie's Hill vineyard. The microclimate of this gentle knoll is just right for producing a white wine that offers rich and supple fruit on the palate while retaining enough acid to keep it light and crisp. The use of restrained oak in the cellar further adds to the depth of this wine, making it one of our personal favorites for starting a meal, or pairing with fish.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "Another wonderfully crisp drinkable Chardonnay from Acme.<br>Wine Reviewer",
        "aging": "3 months in second year Oak",
        "alcohol": "13.5",
        "appellation": "Rutherford Napa Valley",
        "blend": "98% Chardonnay, 2% Viognier",
        "bottle_count": "1",
        "bottle_size": "750mL",
        "case_production": "235",
        "cost": "0.00",
        "country": "",
        "custom01": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "September 2, 2010",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRB-3972.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCH-2610.jpg",
        "label": "",
        "max_purchase_quantity": "",
        "not_availible_message": "",
        "oak": "Francois Freres French Oak",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "October 2011",
        "residual_sugar": "",
        "retail_price": "40.00",
        "shipping_offer_min": "",
        "short_description": "Estate-grown Chardonnay from Katie's Hill Vineyard",
        "soil": "",
        "starting_quantity": "999",
        "status_availability": "",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": "",
        "tasting_notes_pdf": "",
        "upc": "",
        "varietal": "CHARDONNAY",
        "vineyard": "Katie's Hill Vineyard",
        "vintage": "2009",
        "winemaker": "Owen Benson",
        "wine_type": "WHITE",
        "categories": {
            "2": {
                "id": "2",
                "name": "Past Vintages",
                "sort": "2"
            }
        },
        "quantity": "50"
    }
]
GET /prodadmin/products/{sku} Get a Product by SKU
Parameters
NameTypeRequiredDescriptionExample
sku string Required Product SKU
Examples
Request
GET/prodadmin/products/{sku}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "3",
    "name": "2009 Cabernet Sauvignon",
    "sku": "123-ABC",
    "price": "65.00",
    "created": "2022-06-20 12:38:56",
    "last_update": "2022-08-21 14:45:21",
    "description": "Hundred year old vines have worked their roots deep, deep into the hillside soils of the storied Black Hawk Vineyard in Oakville to produce small amounts of the sultry, supple fruit used in this 100% Cabernet Sauvignon. Aged in a mix of the finest new and used oak for 18 months, then bottled and cellared for an additional 24 months deep in the heart of our century-old cave system, this wine is redolent of black fruit with a hint of spice box, tar, and graphite.  Drink now or age for up to 50 years.",
    "status": "Active",
    "accolades_01": "",
    "additional_description": "Unreal. A Napa Valley Cab that is truly worthy drinking.<br>Wine Review Online",
    "aging": "18 Months in French Barrels",
    "alcohol": "16.5",
    "appellation": "Oakville, Napa Valley",
    "blend": "100% Cabernet Sauvignon",
    "bottle_count": "1",
    "bottle_size": "750mL",
    "case_production": "60",
    "country": "",
    "farming_method": "",
    "featured_product": "Yes",
    "free_shipping": "",
    "harvest_date": "October 19, 2007",
    "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV09NVCS1-1204.jpg",
    "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
    "max_purchase_quantity": "9",
    "new_product": "Yes",
    "not_availible_message": "",
    "oak": "40% new, 60% 2 year old",
    "ph": "",
    "qb_account": "",
    "qb_class": "",
    "qb_sku": "",
    "region": "",
    "release_date": "September 1, 2012",
    "residual_sugar": "",
    "retail_price": "0.00",
    "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
    "soil": "",
    "starting_quantity": "99",
    "status_availability": "Active",
    "subtitle": "Napa Valley",
    "sub_region": "",
    "ta": ".06",
    "upc": "",
    "varietal": "CABERNET_BLENDS",
    "vineyard": "Black Hawk",
    "vintage": "2007",
    "winemaker": "Pepe LePepe",
    "wine_type": "RED",
    "categories": {
        "2": {
            "id": "2",
            "name": "Past Vintages",
            "sort": "1"
        }
    },
    "quantity": "0"
}
GET /prodadmin/products Get List of Available Products
Examples
Request
GET/prodadmin/products
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "3",
        "name": "2009 Cabernet Sauvignon",
        "sku": "123-ABC",
        "price": "65.00",
        "created": "2022-06-20 12:38:56",
        "last_update": "2022-08-21 14:45:21",
        "description": "Hundred year old vines have worked their roots deep, deep into the hillside soils of the storied Black Hawk Vineyard in Oakville to produce small amounts of the sultry, supple fruit used in this 100% Cabernet Sauvignon. Aged in a mix of the finest new and used oak for 18 months, then bottled and cellared for an additional 24 months deep in the heart of our century-old cave system, this wine is redolent of black fruit with a hint of spice box, tar, and graphite.  Drink now or age for up to 50 years.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "Unreal. A Napa Valley Cab that is truly worthy drinking.<br>Wine Review Online",
        "aging": "18 Months in French Barrels",
        "alcohol": "16.5",
        "appellation": "Oakville, Napa Valley",
        "blend": "100% Cabernet Sauvignon",
        "bottle_count": "1",
        "bottle_size": "750mL",
        "case_production": "60",
        "country": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV09NVCS1-1204.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
        "max_purchase_quantity": "9",
        "new_product": "Yes",
        "not_availible_message": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 1, 2012",
        "residual_sugar": "",
        "retail_price": "0.00",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "Active",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": ".06",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": {
            "2": {
                "id": "2",
                "name": "Past Vintages",
                "sort": "1"
            }
        },
        "quantity": "0"
    },
    {
        "id": "5",
        "name": "2009 Red Blend",
        "sku": "AV10NVRB",
        "price": "38.00",
        "created": "2022-07-22 10:17:38",
        "last_update": "2022-09-02 16:09:52",
        "description": "Our Chardonnay was produced from vines located on the south side of our Katie's Hill vineyard. The microclimate of this gentle knoll is just right for producing a white wine that offers rich and supple fruit on the palate while retaining enough acid to keep it light and crisp. The use of restrained oak in the cellar further adds to the depth of this wine, making it one of our personal favorites for starting a meal, or pairing with fish.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "Another wonderfully crisp drinkable Chardonnay from Acme.<br>Wine Reviewer",
        "aging": "3 months in second year Oak",
        "alcohol": "13.5",
        "appellation": "Rutherford Napa Valley",
        "blend": "98% Chardonnay, 2% Viognier",
        "bottle_count": "1",
        "bottle_size": "750mL",
        "case_production": "235",
        "cost": "0.00",
        "country": "",
        "custom01": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "September 2, 2010",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRB-3972.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCH-2610.jpg",
        "label": "",
        "max_purchase_quantity": "",
        "not_availible_message": "",
        "oak": "Francois Freres French Oak",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "October 2011",
        "residual_sugar": "",
        "retail_price": "40.00",
        "shipping_offer_min": "",
        "short_description": "Estate-grown Chardonnay from Katie's Hill Vineyard",
        "soil": "",
        "starting_quantity": "999",
        "status_availability": "",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": "",
        "tasting_notes_pdf": "",
        "upc": "",
        "varietal": "CHARDONNAY",
        "vineyard": "Katie's Hill Vineyard",
        "vintage": "2009",
        "winemaker": "Owen Benson",
        "wine_type": "WHITE",
        "categories": {
            "2": {
                "id": "2",
                "name": "Past Vintages",
                "sort": "2"
            }
        },
        "quantity": "50"
    }
]
PUT /prodadmin/products/{sku} Update a Product by SKU
Parameters
NameTypeRequiredDescriptionExample
sku string Required Product SKU
Examples
Request
PUT/prodadmin/products/{sku}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX
Body
{
    "status": "Active",
    "price": "100.00",
    "alcohol": "14.5",
    "appellation": "Oakville, Napa Valley"
}
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "3",
    "name": "2009 Cabernet Sauvignon",
    "sku": "123-ABC",
    "price": "100.00",
    "description": "Hundred year old vines have worked their roots deep, deep into the hillside soils of the storied Black Hawk Vineyard in Oakville to produce small amounts of the sultry, supple fruit used in this 100% Cabernet Sauvignon. Aged in a mix of the finest new and used oak for 18 months, then bottled and cellared for an additional 24 months deep in the heart of our century-old cave system, this wine is redolent of black fruit with a hint of spice box, tar, and graphite.  Drink now or age for up to 50 years.",
    "status": "Active",
    "accolades_01": "",
    "additional_description": "\"Unreal. A Napa Valley Cab that is truly worthy drinking.\"<br>u2014Wine Review Online",
    "aging": "18 Months in French Barrels",
    "alcohol": "14.5",
    "appellation": "Oakville, Napa Valley",
    "blend": "100% Cabernet Sauvignon",
    "bottle_count": "1",
    "bottle_size": "750mL",
    "case_production": "60",
    "country": "",
    "farming_method": "",
    "featured_product": "Yes",
    "free_shipping": "",
    "harvest_date": "October 19, 2007",
    "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV09NVCS1-1204.jpg",
    "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
    "max_purchase_quantity": "9",
    "new_product": "Yes",
    "not_availible_message": "",
    "oak": "40% new, 60% 2 year old",
    "ph": "",
    "qb_account": "",
    "qb_class": "",
    "qb_sku": "",
    "region": "",
    "release_date": "September 1, 2012",
    "residual_sugar": "",
    "retail_price": "0.00",
    "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
    "soil": "",
    "starting_quantity": "99",
    "status_availability": "Active",
    "subtitle": "Napa Valley",
    "sub_region": "",
    "ta": ".06",
    "upc": "",
    "varietal": "CABERNET_BLENDS",
    "vineyard": "Black Hawk",
    "vintage": "2007",
    "winemaker": "Pepe LePepe",
    "wine_type": "RED",
    "categories": {
        "2": {
            "id": "2",
            "name": "Past Vintages",
            "sort": "1"
        }
    },
    "quantity": "0"
}
Public URL copied