Offset Cart API

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

Welcome to the Offset Cart API documentation. This API can be used for creating merchant facing applications powered by the Offset platform.

Headers

There are 3 HTTP Headers used by the Offset Cart API:

Content-Type
X-Auth-Token
X-Session-Id

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

The X-Auth-Token header is used to authenticate with the API server.

The X-Session-Id header is used to identify the current client session for a request in order to maintain state across API calls. To begin a new session obtain a Session Id using the Create New Cart Session Endpoint.

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.

Addresses

Resources related to Addresses.

POST /addresses Create New Shipping Address

Parameters

Name	Type	Required	Description
address	string	Required	Street Address
address_2	string	Optional	Unit Number
city	string	Required	City
first_name	string	Required	Receipient First Name
last_name	string	Required	Recipient Last Name
phone	string	Optional	Recipient Phone Number
state	string	Required	State
title	string	Optional	Address Title
zip	string	Required	Zip Code

Examples

Request

POST/addresses

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "title": "ShippingAddress",
    "first_name": "Jane",
    "last_name": "Doe",
    "address": "523 Brown St",
    "city": "Napa",
    "state": "CA",
    "zip": "94559",
    "address_2": "",
    "phone": "707-501-7491"
}

Response

Headers · 200

Content-Type: application/json

Body

"4093"

DELETE /addresses/{id} Delete Shipping Address

Parameters

Name	Type	Required	Description	Example
id	number	Required	Address Id

Examples

Request

DELETE/addresses/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

null

GET /addresses/{id} Get Address Details

Parameters

Name	Type	Required	Description	Example
id	number	Required	Address Id

Examples

Request

GET/addresses/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "4083",
    "hash": "1507db3fe24c85fcaa9d45c17e188f9473a538b7",
    "created": "2015-11-19 15:27:30",
    "title": "ShippingAddress",
    "first_name": "Jane",
    "last_name": "Doe",
    "birthday": "0000-00-00",
    "company": "",
    "phone": "707-501-7491",
    "email": "",
    "address": "523 Brown St",
    "address_2": "",
    "city": "Napa",
    "state": "CA",
    "zip": "94558",
    "zip_ext": "",
    "country": "US",
    "residential": "0",
    "customer_id": "2",
    "default": "0",
    "public": "0"
}

GET /addresses Get List of Shipping Addresses

Examples

Request

GET/addresses

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "21": {
        "id": "21",
        "hash": "2a2bf355a2e592ac2900e92c07c2b88a39e8823f",
        "created": "2016-05-03 22:00:46",
        "title": "Home",
        "first_name": "Example",
        "last_name": "User",
        "birthday": "1990-06-01",
        "company": "750 Group",
        "phone": "",
        "email": "",
        "address": "523 Brown St",
        "address_2": "Ste 750",
        "city": "Napa",
        "state": "CA",
        "zip": "94559",
        "zip_ext": "",
        "country": "US"
    },
    "22": {
        "id": "22",
        "hash": "2a2bf355a2e592ac2900e92c07c2b88a39e8823f",
        "created": "2016-05-03 22:00:46",
        "title": "Work",
        "first_name": "Example",
        "last_name": "User",
        "birthday": "1990-06-01",
        "company": "750 Group",
        "phone": "",
        "email": "",
        "address": "523 Brown St",
        "address_2": "Ste 750",
        "city": "Napa",
        "state": "CA",
        "zip": "94559",
        "zip_ext": "",
        "country": "US"
    }
}

PUT /addresses/{id} Update Shipping Address

Parameters

Name	Type	Required	Description
address	string	Optional	Street Address
address_2	string	Optional	Unit Number
city	string	Optional	City
company	string	Optional	Company Name
first_name	string	Optional	First Name
last_name	string	Optional	Last Name
phone	string	Optional	Phone Number
state	string	Optional	State
title	string	Optional	Address Title
zip	string	Optional	Zip Code
id	number	Required	Address Id

Examples

Request

PUT/addresses/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "title": "ShippingAddress",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "707-501-7491",
    "company": "",
    "address": "523 Brown St",
    "address_2": "",
    "city": "Napa",
    "state": "CA",
    "zip": "94559"
}

Response

Headers · 200

Content-Type: application/json

Body

{
    "ServerFault": {
        "code": 404,
        "message": "Not Found.",
        "details": ""
    }
}

GET /addresses/default Get Default Shipping Address

Examples

Request

GET/addresses/default

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "3977",
    "hash": "9bce06b92cb56db1b364ba4b2dacaefb7df52583",
    "created": "2015-11-19 15:27:30",
    "title": "ShippingAddress",
    "first_name": "Jane",
    "last_name": "Doe",
    "birthday": "0000-00-00",
    "company": "",
    "phone": "7075017491",
    "email": "",
    "address": "2210 Tejas Ave",
    "address_2": "",
    "city": "Napa",
    "state": "CA",
    "zip": "94559",
    "zip_ext": "",
    "country": "US",
    "residential": "0",
    "customer_id": "2",
    "default": "1",
    "public": "0"
}

PUT /addresses/default Set Default Shipping Address

Examples

Request

PUT/addresses/default

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

"4083"

Response

Headers · 200

Content-Type: application/json

Body

null

Authentication

Resources related to Authentication.

POST /auth Authenticate User

Parameters

Name	Type	Required	Description	Example
password	string	Required	Customer Password
username	string	Required	Customer Username

Examples

Request

POST/auth

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "username": "example@750group.com",
    "password": "XXXXXX"
}

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "1",
    "first_name": "John",
    "last_name": "Doe",
    "email": "example@750group.com",
    "status": "Active",
    "state": "CA",
    "order_count": "0",
    "order_total": "0.00",
    "last_order": "0000-00-00 00:00:00",
    "last_order_total": "0.00",
    "created": "2016-04-20 15:53:28",
    "affiliate_id": "XXXXXXXXX",
    "birthday": "1/1/2000",
    "credits": "100.00",
    "phone": "555-555-5555"
}

GET /auth/username/{username} Check if Account Username Exists

Parameters

Name	Type	Required	Description	Example
username	string	Required	Customer Username

Examples

Request

GET/auth/username/{username}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

POST /auth/customer Create New Customer Profile

Examples

Request

POST/auth/customer

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "first_name": "Jane",
    "last_name": "Doe",
    "username": "example@750group.com",
    "password": "XXXXXXXX",
    "state": "CA"
}

Response

Headers · 200

Content-Type: application/json

Body

POST /auth/send_token Email Password Rest Token

Parameters

Name	Type	Required	Description	Example
username	string	Required	Customer Email Address

Examples

Request

POST/auth/send_token

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "username": "example@750group.com"
}

Response

Headers · 200

Content-Type: application/json

Body

true

GET /auth/username/{username}/details Get Account Details By Username

Parameters

Name	Type	Required	Description	Example
username	string	Required	Customer Username

Examples

Request

GET/auth/username/{username}/details

Headers

Content-Type: application/json
X-Auth-Token: XXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "name": "John Doe",
    "status": "Active"
}

POST /auth/reset Reset Password Using Token

Parameters

Name	Type	Required	Description	Example
new_password	string	Required	New Password for Customer Account
token	string	Required	Token returned by Email Password Reset Token method call

Examples

Request

POST/auth/reset

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "token": "XXXXXX",
    "password": "XXXXXXXX"
}

Response

Headers · 200

Content-Type: application/json

Body

true

PUT /auth/password Update Account Password

Examples

Request

PUT/auth/password

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

"XXXXXXXX"

Response

Headers · 200

Content-Type: application/json

Body

true

PUT /auth/username Update Account Username

Examples

Request

PUT/auth/username

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

"ian@figurecommerce.com"

Response

Headers · 200

Content-Type: application/json

Body

true

Cart

Resources related to Cart.

PUT /promo_code/{code} Apply Promo Code to Cart

Parameters

Name	Type	Required	Description	Example
code	string	Required	Promo Code

Examples

Request

PUT/promo_code/{code}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

DELETE / Empty Cart

Examples

Request

DELETE/

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

GET / Get Cart Information

Examples

Request

GET/

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

PUT /discount Override Discount Amount

Parameters

Name	Type	Required	Description	Example
amount	number	Required	Discount Amount

Examples

Request

PUT/discount

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "item_count": "2",
    "subtotal": 101.98,
    "discount": 50,
    "credits": 0,
    "shipping": 25,
    "tax_rate": 0,
    "tax": 0,
    "tip": 0,
    "total": 176.98,
    "processing_fee": 6.88,
    "config": {
        "address_id": "1498",
        "discount_case": "0",
        "discount_group": "10",
        "inventory_location": "Website",
        "manual_address": "",
        "shipping_address": "1801 Old Sonoma Rd",
        "shipping_address_2": "",
        "shipping_birthday": "0000-00-00",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_country": "United States",
        "shipping_email": "ian@offsetpartners.com",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "customer_id": "333",
        "payment_type": "credit",
        "payment_id": "410",
        "club_id": null,
        "ship_method_id": "9",
        "ship_method_address_lock": "0"
    },
    "items": {
        "AA1006": {
            "id": "5",
            "name": "Cardinale Cabernet Sauvignon Napa Valley 2014",
            "sku": "AA1006",
            "price": "50.99",
            "description": "Cardinale Cabernet Sauvignon Napa Valley 2014 ",
            "status": "Active",
            "accolades_01": "",
            "additional_description": "",
            "aging": "",
            "alcohol": "",
            "appellation": "",
            "bin_location": "",
            "blend": "88% Cabernet Sauvignon and 12% Merlot",
            "bottle_count": "1",
            "bottle_display_size": "",
            "bottle_size": "750mL",
            "bottle_size_display": "750mL",
            "brix_at_harvest": "",
            "case_production": "",
            "cost": "187.33",
            "country": "US",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "description_tasting_notes": "",
            "description_vintage_notes": "",
            "description_winemaker_notes": "",
            "discount_eligible": "No",
            "display_size": "750mL",
            "enable_product_channel": "",
            "farming_method": "",
            "featured_product": "No",
            "feed_visibility": "",
            "free_shipping": "",
            "harvest_date": "",
            "image": "",
            "image_alt": "",
            "image_alt_3": "",
            "image_alt_text_00": "",
            "image_alt_text_01": "",
            "image_alt_text_02": "",
            "image_alt_text_03": "",
            "image_alt_text_04": "",
            "image_alt_text_05": "",
            "image_caption_00": "",
            "image_caption_01": "",
            "image_caption_02": "",
            "image_caption_03": "",
            "image_caption_04": "",
            "image_caption_05": "",
            "image_credit_00": "",
            "image_credit_01": "",
            "image_credit_02": "",
            "image_credit_03": "",
            "image_credit_04": "",
            "image_credit_05": "",
            "image_date_00": "",
            "image_date_01": "",
            "image_date_02": "",
            "image_date_03": "",
            "image_date_04": "",
            "image_date_05": "",
            "increment": "1",
            "label": "",
            "location": "Website",
            "max_purchase_quantity": "",
            "min_purchase_quantity": "",
            "new_product": "No",
            "not_availible_message": "",
            "no_comparison": "No",
            "oak": "",
            "offer_source": "",
            "parent_sku": "",
            "ph": "",
            "producer": "",
            "product_allocation_message": "",
            "product_cart_message": "",
            "product_category": "Wine",
            "product_channel": "",
            "product_club_message": "",
            "product_general_message": "",
            "product_open_message": "",
            "purchase_limit": "",
            "region": "California North Coast",
            "release_date": "",
            "residual_sugar": "",
            "retail_price": "0.00",
            "review": "",
            "reviewer": "",
            "score": "",
            "seo_slug": "",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "",
            "soil": "",
            "source": "",
            "stainless": "",
            "starting_quantity": "",
            "status_availability": "Active",
            "stock_status": "In Stock",
            "subtitle": "",
            "sub_region": "",
            "ta": "",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "title_tasting_notes": "",
            "title_vintage_notes": "",
            "title_winemaker_notes": "",
            "upc": "",
            "varietal": "Cabernet Blends",
            "vimeo_video": "",
            "vineyard": "",
            "vintage": "2014",
            "website_visibility": "",
            "weight": "3",
            "winemaker": "Chris Carpenter",
            "wine_type": "",
            "youtube_video": "",
            "categories": {
                "4": {
                    "id": "4",
                    "name": "Bananas",
                    "sort": "3"
                },
                "2": {
                    "id": "2",
                    "name": "Special Bottlings",
                    "sort": "3"
                }
            },
            "quantity": "2",
            "expires": "2023-05-16 23:24:02",
            "session": "Admin-333-71872192",
            "discount": "0.00",
            "discount_type": "",
            "reserve_inventory": "0"
        }
    },
    "shipment": {
        "address": {
            "id": "1498",
            "hash": "5c904e97fdbf5494c97e6c510a94973cde49c1e8",
            "created": "2023-03-29 12:01:11",
            "last_update": "2023-03-29 12:01:36",
            "title": "",
            "salutation": "",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "",
            "phone": "7075017491",
            "email": "ian@offsetpartners.com",
            "address": "1801 Old Sonoma Rd",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "zip_ext": "3714",
            "country": "United States",
            "lat": "38.28764000",
            "long": "-122.29492000",
            "residential": "0",
            "verified": "1",
            "customer_id": "333",
            "default": "1",
            "public": "0"
        }
    },
    "transactions": []
}

PUT /shipping Override Shipping Price

Parameters

Name	Type	Required	Description	Example
amount	number	Required	Shipping Amount

Examples

Request

PUT/shipping

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "item_count": "2",
    "subtotal": 101.98,
    "discount": 0,
    "credits": 0,
    "shipping": 25,
    "tax_rate": 0,
    "tax": 0,
    "tip": 0,
    "total": 126.98,
    "processing_fee": 6.88,
    "config": {
        "address_id": "1498",
        "discount_case": "0",
        "discount_group": "10",
        "inventory_location": "Website",
        "manual_address": "",
        "shipping_address": "1801 Old Sonoma Rd",
        "shipping_address_2": "",
        "shipping_birthday": "0000-00-00",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_country": "United States",
        "shipping_email": "ian@offsetpartners.com",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "customer_id": "333",
        "payment_type": "credit",
        "payment_id": "410",
        "club_id": null,
        "ship_method_id": "9",
        "ship_method_address_lock": "0"
    },
    "items": {
        "AA1006": {
            "id": "5",
            "name": "Cardinale Cabernet Sauvignon Napa Valley 2014",
            "sku": "AA1006",
            "price": "50.99",
            "description": "Cardinale Cabernet Sauvignon Napa Valley 2014 ",
            "status": "Active",
            "accolades_01": "",
            "additional_description": "",
            "aging": "",
            "alcohol": "",
            "appellation": "",
            "bin_location": "",
            "blend": "88% Cabernet Sauvignon and 12% Merlot",
            "bottle_count": "1",
            "bottle_display_size": "",
            "bottle_size": "750mL",
            "bottle_size_display": "750mL",
            "brix_at_harvest": "",
            "case_production": "",
            "cost": "187.33",
            "country": "US",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "description_tasting_notes": "",
            "description_vintage_notes": "",
            "description_winemaker_notes": "",
            "discount_eligible": "No",
            "display_size": "750mL",
            "enable_product_channel": "",
            "farming_method": "",
            "featured_product": "No",
            "feed_visibility": "",
            "free_shipping": "",
            "harvest_date": "",
            "image": "",
            "image_alt": "",
            "image_alt_3": "",
            "image_alt_text_00": "",
            "image_alt_text_01": "",
            "image_alt_text_02": "",
            "image_alt_text_03": "",
            "image_alt_text_04": "",
            "image_alt_text_05": "",
            "image_caption_00": "",
            "image_caption_01": "",
            "image_caption_02": "",
            "image_caption_03": "",
            "image_caption_04": "",
            "image_caption_05": "",
            "image_credit_00": "",
            "image_credit_01": "",
            "image_credit_02": "",
            "image_credit_03": "",
            "image_credit_04": "",
            "image_credit_05": "",
            "image_date_00": "",
            "image_date_01": "",
            "image_date_02": "",
            "image_date_03": "",
            "image_date_04": "",
            "image_date_05": "",
            "increment": "1",
            "label": "",
            "location": "Website",
            "max_purchase_quantity": "",
            "min_purchase_quantity": "",
            "new_product": "No",
            "not_availible_message": "",
            "no_comparison": "No",
            "oak": "",
            "offer_source": "",
            "parent_sku": "",
            "ph": "",
            "producer": "",
            "product_allocation_message": "",
            "product_cart_message": "",
            "product_category": "Wine",
            "product_channel": "",
            "product_club_message": "",
            "product_general_message": "",
            "product_open_message": "",
            "purchase_limit": "",
            "region": "California North Coast",
            "release_date": "",
            "residual_sugar": "",
            "retail_price": "0.00",
            "review": "",
            "reviewer": "",
            "score": "",
            "seo_slug": "",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "",
            "soil": "",
            "source": "",
            "stainless": "",
            "starting_quantity": "",
            "status_availability": "Active",
            "stock_status": "In Stock",
            "subtitle": "",
            "sub_region": "",
            "ta": "",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "title_tasting_notes": "",
            "title_vintage_notes": "",
            "title_winemaker_notes": "",
            "upc": "",
            "varietal": "Cabernet Blends",
            "vimeo_video": "",
            "vineyard": "",
            "vintage": "2014",
            "website_visibility": "",
            "weight": "3",
            "winemaker": "Chris Carpenter",
            "wine_type": "",
            "youtube_video": "",
            "categories": {
                "4": {
                    "id": "4",
                    "name": "Bananas",
                    "sort": "3"
                },
                "2": {
                    "id": "2",
                    "name": "Special Bottlings",
                    "sort": "3"
                }
            },
            "quantity": "2",
            "expires": "2023-05-16 23:24:02",
            "session": "Admin-333-71872192",
            "discount": "0.00",
            "discount_type": "",
            "reserve_inventory": "0"
        }
    },
    "shipment": {
        "address": {
            "id": "1498",
            "hash": "5c904e97fdbf5494c97e6c510a94973cde49c1e8",
            "created": "2023-03-29 12:01:11",
            "last_update": "2023-03-29 12:01:36",
            "title": "",
            "salutation": "",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "",
            "phone": "7075017491",
            "email": "ian@offsetpartners.com",
            "address": "1801 Old Sonoma Rd",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "zip_ext": "3714",
            "country": "United States",
            "lat": "38.28764000",
            "long": "-122.29492000",
            "residential": "0",
            "verified": "1",
            "customer_id": "333",
            "default": "1",
            "public": "0"
        }
    },
    "transactions": []
}

PUT /payment/{id}/select Select Payment Method for Cart

Parameters

Name	Type	Required	Description	Example
id	number	Required	Payment Id

Examples

Request

PUT/payment/{id}/select

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "subtotal": "540.00",
    "credits": 0,
    "discount": "0.00",
    "shipping": "0.00",
    "tax_rate": "10",
    "tax": "54.00",
    "total": "594.00",
    "item_count": "12",
    "items": {
        "12312312312": {
            "session": "ndqojtbleqonj6f41tirpagjr6",
            "sku": "12312312312",
            "quantity": "12",
            "price": "45.00",
            "description": "2014 Rosé Napa Valley",
            "expires": "2016-03-07 00:56:17",
            "reserve_inventory": "0",
            "id": "14",
            "name": "2014 Rosu00e9",
            "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": "16.5",
            "appellation": "Oakville, Napa Valley",
            "blend": "100% Cabernet Sauvignon",
            "bottle_count": "1",
            "bottle_size": "",
            "case_production": "60",
            "cost": "0.00",
            "country": "",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "farming_method": "",
            "featured_product": "Yes",
            "free_shipping": "",
            "harvest_date": "October 19, 2007",
            "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
            "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
            "label": "",
            "max_purchase_quantity": "36",
            "min_purchase_quantity": "",
            "not_availible_message": "",
            "oak": "40% new, 60% 2 year old",
            "ph": "",
            "product_category": "Wine",
            "qb_account": "",
            "qb_class": "",
            "qb_sku": "",
            "region": "",
            "release_date": "September 1, 2012",
            "residual_sugar": "",
            "retail_price": "65.00",
            "review": "Hello",
            "reviewer": "Acme",
            "score": "99",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
            "soil": "",
            "stainless": "",
            "starting_quantity": "99",
            "status_availability": "Active",
            "subtitle": "Napa Valley",
            "sub_region": "",
            "ta": ".06",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "upc": "",
            "varietal": "",
            "vineyard": "Black Hawk",
            "vintage": "2007",
            "winemaker": "Pepe LePepe",
            "wine_type": "RED",
            "categories": null
        }
    },
    "config": {
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "customer_id": "2",
        "address_id": "4093",
        "payment_id": "6",
        "club_id": "",
        "ship_method_id": "3",
        "ship_method_address_lock": "0"
    },
    "shipment": {
        "address": {
            "id": "4093",
            "hash": "a187902adebd6b1aab810511fabcf475e4f5c8e2",
            "created": "2016-03-07 00:28:00",
            "title": "ShippingAddress",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "",
            "phone": "707-501-7491",
            "email": "",
            "address": "523 Brown St",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "zip_ext": "",
            "country": "US",
            "residential": "0",
            "customer_id": "2",
            "default": "0",
            "public": "0"
        }
    }
}

PUT /payment_type/{type} Select Payment Type for Cart

Parameters

Name	Type	Required	Description	Example
type	string	Required	Payment Type (credit \| cash \| check)

Examples

Request

PUT/payment_type/{type}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "subtotal": "0.00",
    "credits": 0,
    "discount": "0.00",
    "shipping": "0.00",
    "tax_rate": 0,
    "tax": 0,
    "total": "0.00",
    "item_count": "",
    "items": [],
    "config": {
        "customer_id": "0",
        "address_id": "",
        "payment_type": "cash",
        "payment_id": "",
        "club_id": "",
        "ship_method_id": "3",
        "ship_method_address_lock": "0"
    },
    "shipment": {
        "address": false
    },
    "checkout_message": "This message to be displayed on checkout screen."
}

PUT /address/{id}/select Select Shipping Address for Cart

Parameters

Name	Type	Required	Description	Example
id	number	Required	Address Id

Examples

Request

PUT/address/{id}/select

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "subtotal": "540.00",
    "credits": 0,
    "discount": "0.00",
    "shipping": "0.00",
    "tax_rate": "10",
    "tax": "54.00",
    "total": "594.00",
    "item_count": "12",
    "items": {
        "12312312312": {
            "session": "ndqojtbleqonj6f41tirpagjr6",
            "sku": "12312312312",
            "quantity": "12",
            "price": "45.00",
            "description": "2014 Rosé Napa Valley",
            "expires": "2016-03-07 00:56:17",
            "reserve_inventory": "0",
            "id": "14",
            "name": "2014 Rosu00e9",
            "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": "16.5",
            "appellation": "Oakville, Napa Valley",
            "blend": "100% Cabernet Sauvignon",
            "bottle_count": "1",
            "bottle_size": "",
            "case_production": "60",
            "cost": "0.00",
            "country": "",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "farming_method": "",
            "featured_product": "Yes",
            "free_shipping": "",
            "harvest_date": "October 19, 2007",
            "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
            "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
            "label": "",
            "max_purchase_quantity": "36",
            "min_purchase_quantity": "",
            "not_availible_message": "",
            "oak": "40% new, 60% 2 year old",
            "ph": "",
            "product_category": "Wine",
            "qb_account": "",
            "qb_class": "",
            "qb_sku": "",
            "region": "",
            "release_date": "September 1, 2012",
            "residual_sugar": "",
            "retail_price": "65.00",
            "review": "Hello",
            "reviewer": "Acme",
            "score": "99",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
            "soil": "",
            "stainless": "",
            "starting_quantity": "99",
            "status_availability": "Active",
            "subtitle": "Napa Valley",
            "sub_region": "",
            "ta": ".06",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "upc": "",
            "varietal": "",
            "vineyard": "Black Hawk",
            "vintage": "2007",
            "winemaker": "Pepe LePepe",
            "wine_type": "RED",
            "categories": null
        }
    },
    "config": {
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "customer_id": "2",
        "address_id": "4093",
        "payment_id": "6",
        "club_id": "",
        "ship_method_id": "3",
        "ship_method_address_lock": "0"
    },
    "shipment": {
        "address": {
            "id": "4093",
            "hash": "a187902adebd6b1aab810511fabcf475e4f5c8e2",
            "created": "2016-03-07 00:28:00",
            "title": "ShippingAddress",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "",
            "phone": "707-501-7491",
            "email": "",
            "address": "523 Brown St",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "zip_ext": "",
            "country": "US",
            "residential": "0",
            "customer_id": "2",
            "default": "0",
            "public": "0"
        }
    }
}

PUT /shipping_method/{id}/select Select Shipping Method for Cart

Parameters

Name	Type	Required	Description	Example
id	number	Required	Shipping Method Id

Examples

Request

PUT/shipping_method/{id}/select

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "subtotal": "540.00",
    "credits": 0,
    "discount": "0.00",
    "shipping": "0.00",
    "tax_rate": "10",
    "tax": "54.00",
    "total": "594.00",
    "item_count": "12",
    "items": {
        "12312312312": {
            "session": "ndqojtbleqonj6f41tirpagjr6",
            "sku": "12312312312",
            "quantity": "12",
            "price": "45.00",
            "description": "2014 Rosé Napa Valley",
            "expires": "2016-03-07 00:56:17",
            "reserve_inventory": "0",
            "id": "14",
            "name": "2014 Rosu00e9",
            "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": "16.5",
            "appellation": "Oakville, Napa Valley",
            "blend": "100% Cabernet Sauvignon",
            "bottle_count": "1",
            "bottle_size": "",
            "case_production": "60",
            "cost": "0.00",
            "country": "",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "farming_method": "",
            "featured_product": "Yes",
            "free_shipping": "",
            "harvest_date": "October 19, 2007",
            "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
            "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
            "label": "",
            "max_purchase_quantity": "36",
            "min_purchase_quantity": "",
            "not_availible_message": "",
            "oak": "40% new, 60% 2 year old",
            "ph": "",
            "product_category": "Wine",
            "qb_account": "",
            "qb_class": "",
            "qb_sku": "",
            "region": "",
            "release_date": "September 1, 2012",
            "residual_sugar": "",
            "retail_price": "65.00",
            "review": "Hello",
            "reviewer": "Acme",
            "score": "99",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
            "soil": "",
            "stainless": "",
            "starting_quantity": "99",
            "status_availability": "Active",
            "subtitle": "Napa Valley",
            "sub_region": "",
            "ta": ".06",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "upc": "",
            "varietal": "",
            "vineyard": "Black Hawk",
            "vintage": "2007",
            "winemaker": "Pepe LePepe",
            "wine_type": "RED",
            "categories": null
        }
    },
    "config": {
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "customer_id": "2",
        "address_id": "3965",
        "payment_id": "",
        "club_id": "",
        "ship_method_id": "10",
        "ship_method_address_lock": "1"
    },
    "shipment": {
        "address": {
            "id": "3965",
            "hash": "bfab412052946c7bc56c67d8d307071444bffb63",
            "created": "2015-11-19 15:27:30",
            "title": "",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "c/o Acme Vineyards",
            "phone": "7075017491",
            "email": "",
            "address": "6484 Winery Street",
            "address_2": "",
            "city": "Yountville",
            "state": "CA",
            "zip": "94599",
            "zip_ext": "",
            "country": "US",
            "residential": "0",
            "customer_id": "",
            "default": "0",
            "public": "0"
        }
    }
}

PUT /config Set Cart Metadata

Parameters

Name	Type	Required	Description	Example
shipping_state	string	Optional

Examples

Request

PUT/config

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "shipping_state": "CA",
    "insurance": "1"
}

Response

Headers · 200

Content-Type: application/json

Body

null

PUT /tip Set Tip Amount

Parameters

Name	Type	Required	Description	Example
amount	number	Required	Tip Amount

Examples

Request

PUT/tip

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "amount": 25
}

Response

Headers · 200

Content-Type: application/json

Body

{
    "subtotal": "540.00",
    "credits": 0,
    "discount": "0.00",
    "shipping": "0.00",
    "tax_rate": "10",
    "tax": "54.00",
    "tip": "25.00",
    "total": "619.00",
    "item_count": "12",
    "items": {
        "12312312312": {
            "session": "ndqojtbleqonj6f41tirpagjr6",
            "sku": "12312312312",
            "quantity": "12",
            "price": "45.00",
            "description": "2014 Rosé Napa Valley",
            "expires": "2016-03-07 00:56:17",
            "reserve_inventory": "0",
            "id": "14",
            "name": "2014 Rosu00e9",
            "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": "16.5",
            "appellation": "Oakville, Napa Valley",
            "blend": "100% Cabernet Sauvignon",
            "bottle_count": "1",
            "bottle_size": "",
            "case_production": "60",
            "cost": "0.00",
            "country": "",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "farming_method": "",
            "featured_product": "Yes",
            "free_shipping": "",
            "harvest_date": "October 19, 2007",
            "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
            "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
            "label": "",
            "max_purchase_quantity": "36",
            "min_purchase_quantity": "",
            "not_availible_message": "",
            "oak": "40% new, 60% 2 year old",
            "ph": "",
            "product_category": "Wine",
            "qb_account": "",
            "qb_class": "",
            "qb_sku": "",
            "region": "",
            "release_date": "September 1, 2012",
            "residual_sugar": "",
            "retail_price": "65.00",
            "review": "Hello",
            "reviewer": "Acme",
            "score": "99",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
            "soil": "",
            "stainless": "",
            "starting_quantity": "99",
            "status_availability": "Active",
            "subtitle": "Napa Valley",
            "sub_region": "",
            "ta": ".06",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "upc": "",
            "varietal": "",
            "vineyard": "Black Hawk",
            "vintage": "2007",
            "winemaker": "Pepe LePepe",
            "wine_type": "RED",
            "categories": null
        }
    },
    "config": {
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "customer_id": "2",
        "address_id": "3965",
        "payment_id": "",
        "club_id": "",
        "ship_method_id": "10",
        "ship_method_address_lock": "1"
    },
    "shipment": {
        "address": {
            "id": "3965",
            "hash": "bfab412052946c7bc56c67d8d307071444bffb63",
            "created": "2015-11-19 15:27:30",
            "title": "",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "c/o Acme Vineyards",
            "phone": "7075017491",
            "email": "",
            "address": "6484 Winery Street",
            "address_2": "",
            "city": "Yountville",
            "state": "CA",
            "zip": "94599",
            "zip_ext": "",
            "country": "US",
            "residential": "0",
            "customer_id": "",
            "default": "0",
            "public": "0"
        }
    }
}

POST /items Add Item to Cart

Parameters

Name	Type	Required	Description	Example
quantity	number	Optional	Quantity to Add
sku	string	Required	Product SKU

Examples

Request

POST/items

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "sku": "12312312312",
    "quantity": "3"
}

Response

Headers · 200

Content-Type: application/json

Body

true

PUT /items/{sku}/price/{price} Override Item Price

Parameters

Name	Type	Required	Description	Example
price	number	Required	Item Price
sku	string	Required	SKU

Examples

Request

PUT/items/{sku}/price/{price}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "item_count": "2",
    "subtotal": 101.98,
    "discount": 0,
    "credits": 0,
    "shipping": 125,
    "tax_rate": 0,
    "tax": 0,
    "tip": 0,
    "total": 226.98,
    "processing_fee": 6.88,
    "config": {
        "address_id": "1498",
        "discount_case": "0",
        "discount_group": "10",
        "inventory_location": "Website",
        "manual_address": "",
        "shipping_address": "1801 Old Sonoma Rd",
        "shipping_address_2": "",
        "shipping_birthday": "0000-00-00",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_country": "United States",
        "shipping_email": "ian@offsetpartners.com",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "customer_id": "333",
        "payment_type": "credit",
        "payment_id": "410",
        "club_id": null,
        "ship_method_id": "9",
        "ship_method_address_lock": "0"
    },
    "items": {
        "AA1006": {
            "id": "5",
            "name": "Cardinale Cabernet Sauvignon Napa Valley 2014",
            "sku": "AA1006",
            "price": "50.99",
            "description": "Cardinale Cabernet Sauvignon Napa Valley 2014 ",
            "status": "Active",
            "accolades_01": "",
            "additional_description": "",
            "aging": "",
            "alcohol": "",
            "appellation": "",
            "bin_location": "",
            "blend": "88% Cabernet Sauvignon and 12% Merlot",
            "bottle_count": "1",
            "bottle_display_size": "",
            "bottle_size": "750mL",
            "bottle_size_display": "750mL",
            "brix_at_harvest": "",
            "case_production": "",
            "cost": "187.33",
            "country": "US",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "description_tasting_notes": "",
            "description_vintage_notes": "",
            "description_winemaker_notes": "",
            "discount_eligible": "No",
            "display_size": "750mL",
            "enable_product_channel": "",
            "farming_method": "",
            "featured_product": "No",
            "feed_visibility": "",
            "free_shipping": "",
            "harvest_date": "",
            "image": "",
            "image_alt": "",
            "image_alt_3": "",
            "image_alt_text_00": "",
            "image_alt_text_01": "",
            "image_alt_text_02": "",
            "image_alt_text_03": "",
            "image_alt_text_04": "",
            "image_alt_text_05": "",
            "image_caption_00": "",
            "image_caption_01": "",
            "image_caption_02": "",
            "image_caption_03": "",
            "image_caption_04": "",
            "image_caption_05": "",
            "image_credit_00": "",
            "image_credit_01": "",
            "image_credit_02": "",
            "image_credit_03": "",
            "image_credit_04": "",
            "image_credit_05": "",
            "image_date_00": "",
            "image_date_01": "",
            "image_date_02": "",
            "image_date_03": "",
            "image_date_04": "",
            "image_date_05": "",
            "increment": "1",
            "label": "",
            "location": "Website",
            "max_purchase_quantity": "",
            "min_purchase_quantity": "",
            "new_product": "No",
            "not_availible_message": "",
            "no_comparison": "No",
            "oak": "",
            "offer_source": "",
            "parent_sku": "",
            "ph": "",
            "producer": "",
            "product_allocation_message": "",
            "product_cart_message": "",
            "product_category": "Wine",
            "product_channel": "",
            "product_club_message": "",
            "product_general_message": "",
            "product_open_message": "",
            "purchase_limit": "",
            "region": "California North Coast",
            "release_date": "",
            "residual_sugar": "",
            "retail_price": "0.00",
            "review": "",
            "reviewer": "",
            "score": "",
            "seo_slug": "",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "",
            "soil": "",
            "source": "",
            "stainless": "",
            "starting_quantity": "",
            "status_availability": "Active",
            "stock_status": "In Stock",
            "subtitle": "",
            "sub_region": "",
            "ta": "",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "title_tasting_notes": "",
            "title_vintage_notes": "",
            "title_winemaker_notes": "",
            "upc": "",
            "varietal": "Cabernet Blends",
            "vimeo_video": "",
            "vineyard": "",
            "vintage": "2014",
            "website_visibility": "",
            "weight": "3",
            "winemaker": "Chris Carpenter",
            "wine_type": "",
            "youtube_video": "",
            "categories": {
                "4": {
                    "id": "4",
                    "name": "Bananas",
                    "sort": "3"
                },
                "2": {
                    "id": "2",
                    "name": "Special Bottlings",
                    "sort": "3"
                }
            },
            "quantity": "2",
            "expires": "2023-05-16 23:24:02",
            "session": "Admin-333-71872192",
            "discount": "0.00",
            "discount_type": "",
            "reserve_inventory": "0"
        }
    },
    "shipment": {
        "address": {
            "id": "1498",
            "hash": "5c904e97fdbf5494c97e6c510a94973cde49c1e8",
            "created": "2023-03-29 12:01:11",
            "last_update": "2023-03-29 12:01:36",
            "title": "",
            "salutation": "",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "",
            "phone": "7075017491",
            "email": "ian@offsetpartners.com",
            "address": "1801 Old Sonoma Rd",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "zip_ext": "3714",
            "country": "United States",
            "lat": "38.28764000",
            "long": "-122.29492000",
            "residential": "0",
            "verified": "1",
            "customer_id": "333",
            "default": "1",
            "public": "0"
        }
    },
    "transactions": []
}

DELETE /items/{sku} Remove Item

Parameters

Name	Type	Required	Description	Example
sku	string	Required	Product SKU

Examples

Request

DELETE/items/{sku}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

PUT /items/{sku}/{quantity} Update Quantity

Parameters

Name	Type	Required	Description	Example
quantity	number	Required	New Quantity
sku	string	Required	Product SKU

Examples

Request

PUT/items/{sku}/{quantity}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

POST /orders Checkout

Parameters

Name	Type	Required	Description
address	string	Optional	Billing Street Address
address_2	string	Optional	Billing Unit Number
city	string	Optional	Billing City
company	string	Optional	Company Name
gift_message	string	Optional	Gift Message
instructions	string	Optional	Shipping Instructions
order_type	string	Optional	Order Type
requested_ship_date	string	Optional	Requested Ship Date
shipping_address	string	Optional	Shipping Street Addresss
shipping_address_2	string	Optional	Shipping Unit Number
shipping_city	string	Optional	Shipping City
shipping_company	string	Optional	Shipping Company Name
shipping_first_name	string	Optional	Shipping First Name
shipping_last_name	string	Optional	Shipping Last Name
shipping_phone	string	Optional	Shipping Phone Number
shipping_state	string	Optional	Shipping State
shipping_zip	string	Optional	Shipping Zip Code
state	string	Optional	Billing State
transaction_id	number	Optional	Transaction Id to Refund (Returns Only)
zip	string	Optional	Billing Zip Code

Examples

Request

POST/orders

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "order_type": "Web",
    "company": "",
    "address": "2210 Tejas Ave",
    "address_2": "",
    "city": "Napa",
    "state": "CA",
    "zip": "94559",
    "shipping_title": "ShippingAddress",
    "shipping_first_name": "Jane",
    "shipping_last_name": "Doe",
    "shipping_phone": "707-501-7491",
    "shipping_company": "",
    "shipping_address": "523 Brown St",
    "shipping_address_2": "",
    "shipping_city": "Napa",
    "shipping_state": "CA",
    "shipping_zip": "94559",
    "requested_ship_date": "2015-03-16",
    "instructions": "Shipping Instructions",
    "gift_message": "Gift Message"
}

Response

Headers · 200

Content-Type: application/json

Body

"4096"

POST /transactions Add Partial Payment

Parameters

Name	Type	Required	Description
check_number	string	Optional	Check Number for Payment Type: check
credits	number	Optional	Credits Amount
discount	number	Optional	Discount Amount
gift_card_code	string	Required	Gift Card Code
payment_id	number	Required	Saved Payment Id
payment_type	string	Required	Payment Type (cash \| check \| credit)
shipping	number	Optional	Shipping Amount
stripe_payment_intent	string	Required	Stripe Payment Intent
tax	number	Optional	Tax Amount
tip	number	Optional	Tip Amount
total	number	Required	Total Amount to Charge

Examples

Request

POST/transactions

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "total": 100.75,
    "tax": 8.75,
    "shipping": 10,
    "tip": 0,
    "credits": 0,
    "discount": 0,
    "payment_id": 410
}

Response

Headers · 200

Content-Type: application/json

Body

{
    "item_count": "3",
    "subtotal": 637.85,
    "discount": 71.99,
    "credits": 0,
    "shipping": 115,
    "tax_rate": 0,
    "tax": -8.75,
    "tip": 0,
    "total": 672.11,
    "processing_fee": 19.79,
    "config": {
        "address_id": "1498",
        "discount_case": "0",
        "discount_group": "10",
        "inventory_location": "Website",
        "manual_address": "",
        "shipping_address": "1801 Old Sonoma Rd",
        "shipping_address_2": "",
        "shipping_birthday": "0000-00-00",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_country": "United States",
        "shipping_email": "ian@offsetpartners.com",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "customer_id": "333",
        "payment_id": "410",
        "club_id": null,
        "ship_method_id": "9",
        "ship_method_address_lock": "0"
    },
    "items": {
        "AA1006": {
            "id": "5",
            "name": "Cardinale Cabernet Sauvignon Napa Valley 2014",
            "sku": "AA1006",
            "price": "239.95",
            "description": "Cardinale Cabernet Sauvignon Napa Valley 2014 ",
            "status": "Active",
            "accolades_01": "",
            "additional_description": "",
            "aging": "",
            "alcohol": "",
            "appellation": "",
            "bin_location": "",
            "blend": "88% Cabernet Sauvignon and 12% Merlot",
            "bottle_count": "1",
            "bottle_display_size": "",
            "bottle_size": "750mL",
            "bottle_size_display": "",
            "brix_at_harvest": "",
            "case_production": "",
            "cost": "187.33",
            "country": "US",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "display_size": "750mL",
            "enable_product_channel": "",
            "farming_method": "",
            "feed_visibility": "",
            "free_shipping": "",
            "harvest_date": "",
            "image": "",
            "image_alt": "",
            "image_alt_3": "",
            "image_alt_text_00": "",
            "image_alt_text_01": "",
            "image_alt_text_02": "",
            "image_alt_text_03": "",
            "image_alt_text_04": "",
            "image_alt_text_05": "",
            "image_caption_00": "",
            "image_caption_01": "",
            "image_caption_02": "",
            "image_caption_03": "",
            "image_caption_04": "",
            "image_caption_05": "",
            "image_credit_00": "",
            "image_credit_01": "",
            "image_credit_02": "",
            "image_credit_03": "",
            "image_credit_04": "",
            "image_credit_05": "",
            "image_date_00": "",
            "image_date_01": "",
            "image_date_02": "",
            "image_date_03": "",
            "image_date_04": "",
            "image_date_05": "",
            "increment": "1",
            "label": "",
            "location": "Website",
            "max_purchase_quantity": "",
            "min_purchase_quantity": "",
            "not_availible_message": "",
            "oak": "",
            "offer_source": "",
            "parent_sku": "",
            "ph": "",
            "producer": "",
            "product_allocation_message": "",
            "product_cart_message": "",
            "product_category": "Wine",
            "product_channel": "",
            "product_club_message": "",
            "product_general_message": "",
            "product_open_message": "",
            "region": "California North Coast",
            "release_date": "",
            "residual_sugar": "",
            "retail_price": "0.00",
            "score": "",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "",
            "soil": "",
            "source": "",
            "stainless": "",
            "status_availability": "Active",
            "stock_status": "In Stock",
            "subtitle": "",
            "sub_region": "",
            "ta": "",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "upc": "",
            "varietal": "Cabernet Blends",
            "vimeo_video": "",
            "vineyard": "",
            "vintage": "2014",
            "weight": "3",
            "winemaker": "Chris Carpenter",
            "wine_type": "",
            "youtube_video": "",
            "categories": {
                "4": {
                    "id": "4",
                    "name": "Bananas",
                    "sort": "3"
                },
                "2": {
                    "id": "2",
                    "name": "Special Bottlings",
                    "sort": "5"
                }
            },
            "quantity": "3",
            "expires": "2023-04-11 12:31:40",
            "session": "Admin-333-65635177",
            "discount": "0.00",
            "discount_type": "",
            "reserve_inventory": "0"
        }
    },
    "shipment": {
        "address": {
            "id": "1498",
            "hash": "5c904e97fdbf5494c97e6c510a94973cde49c1e8",
            "created": "2023-03-29 12:01:11",
            "last_update": "2023-03-29 12:01:36",
            "title": "",
            "salutation": "",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "",
            "phone": "7075017491",
            "email": "ian@offsetpartners.com",
            "address": "1801 Old Sonoma Rd",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "zip_ext": "3714",
            "country": "United States",
            "lat": "38.28764000",
            "long": "-122.29492000",
            "residential": "0",
            "verified": "1",
            "customer_id": "333",
            "default": "1",
            "public": "0"
        }
    },
    "transactions": [
        {
            "id": "6",
            "session": "Admin-333-65635177",
            "customer_id": "333",
            "type": "Credit",
            "gateway": "Stripe",
            "token": "pi_2MvmeBukqU3e0iSq0S0wWiih",
            "total": "100.75",
            "tax": "8.75",
            "shipping": "10.00",
            "tip": "0.00",
            "credits": "0.00",
            "discount": "0.00",
            "created": "2023-04-11 12:14:32"
        }
    ]
}

DELETE /transactions Void All Partial Payments

Examples

Request

DELETE/transactions

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "item_count": "3",
    "subtotal": 719.85,
    "discount": 71.99,
    "credits": 0,
    "shipping": 125,
    "tax_rate": 0,
    "tax": 0,
    "tip": 0,
    "total": 772.86,
    "processing_fee": 22.71,
    "config": {
        "address_id": "1498",
        "discount_case": "0",
        "discount_group": "10",
        "inventory_location": "Website",
        "manual_address": "",
        "shipping_address": "1801 Old Sonoma Rd",
        "shipping_address_2": "",
        "shipping_birthday": "0000-00-00",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_country": "United States",
        "shipping_email": "ian@offsetpartners.com",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "customer_id": "333",
        "payment_id": "410",
        "club_id": null,
        "ship_method_id": "9",
        "ship_method_address_lock": "0"
    },
    "items": {
        "AA1006": {
            "id": "5",
            "name": "Cardinale Cabernet Sauvignon Napa Valley 2014",
            "sku": "AA1006",
            "price": "239.95",
            "description": "Cardinale Cabernet Sauvignon Napa Valley 2014 ",
            "status": "Active",
            "accolades_01": "",
            "additional_description": "",
            "aging": "",
            "alcohol": "",
            "appellation": "",
            "bin_location": "",
            "blend": "88% Cabernet Sauvignon and 12% Merlot",
            "bottle_count": "1",
            "bottle_display_size": "",
            "bottle_size": "750mL",
            "bottle_size_display": "",
            "brix_at_harvest": "",
            "case_production": "",
            "cost": "187.33",
            "country": "US",
            "custom01": "",
            "custom02": "",
            "custom03": "",
            "display_size": "750mL",
            "enable_product_channel": "",
            "farming_method": "",
            "feed_visibility": "",
            "free_shipping": "",
            "harvest_date": "",
            "image": "",
            "image_alt": "",
            "image_alt_3": "",
            "image_alt_text_00": "",
            "image_alt_text_01": "",
            "image_alt_text_02": "",
            "image_alt_text_03": "",
            "image_alt_text_04": "",
            "image_alt_text_05": "",
            "image_caption_00": "",
            "image_caption_01": "",
            "image_caption_02": "",
            "image_caption_03": "",
            "image_caption_04": "",
            "image_caption_05": "",
            "image_credit_00": "",
            "image_credit_01": "",
            "image_credit_02": "",
            "image_credit_03": "",
            "image_credit_04": "",
            "image_credit_05": "",
            "image_date_00": "",
            "image_date_01": "",
            "image_date_02": "",
            "image_date_03": "",
            "image_date_04": "",
            "image_date_05": "",
            "increment": "1",
            "label": "",
            "location": "Website",
            "max_purchase_quantity": "",
            "min_purchase_quantity": "",
            "not_availible_message": "",
            "oak": "",
            "offer_source": "",
            "parent_sku": "",
            "ph": "",
            "producer": "",
            "product_allocation_message": "",
            "product_cart_message": "",
            "product_category": "Wine",
            "product_channel": "",
            "product_club_message": "",
            "product_general_message": "",
            "product_open_message": "",
            "region": "California North Coast",
            "release_date": "",
            "residual_sugar": "",
            "retail_price": "0.00",
            "score": "",
            "shipping_included": "0",
            "shipping_offer_min": "",
            "short_description": "",
            "soil": "",
            "source": "",
            "stainless": "",
            "status_availability": "Active",
            "stock_status": "In Stock",
            "subtitle": "",
            "sub_region": "",
            "ta": "",
            "tasting_notes_pdf": "",
            "tax_exempt": "0",
            "upc": "",
            "varietal": "Cabernet Blends",
            "vimeo_video": "",
            "vineyard": "",
            "vintage": "2014",
            "weight": "3",
            "winemaker": "Chris Carpenter",
            "wine_type": "",
            "youtube_video": "",
            "categories": {
                "4": {
                    "id": "4",
                    "name": "Bananas",
                    "sort": "3"
                },
                "2": {
                    "id": "2",
                    "name": "Special Bottlings",
                    "sort": "5"
                }
            },
            "quantity": "3",
            "expires": "2023-04-11 12:31:40",
            "session": "Admin-333-65635177",
            "discount": "0.00",
            "discount_type": "",
            "reserve_inventory": "0"
        }
    },
    "shipment": {
        "address": {
            "id": "1498",
            "hash": "5c904e97fdbf5494c97e6c510a94973cde49c1e8",
            "created": "2023-03-29 12:01:11",
            "last_update": "2023-03-29 12:01:36",
            "title": "",
            "salutation": "",
            "first_name": "Jane",
            "last_name": "Doe",
            "birthday": "0000-00-00",
            "company": "",
            "phone": "7075017491",
            "email": "ian@offsetpartners.com",
            "address": "1801 Old Sonoma Rd",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "zip_ext": "3714",
            "country": "United States",
            "lat": "38.28764000",
            "long": "-122.29492000",
            "residential": "0",
            "verified": "1",
            "customer_id": "333",
            "default": "1",
            "public": "0"
        }
    },
    "transactions": []
}

Name	Type	Required	Description	Example
name	string	Required	Category Name

Clubs

Resources related to Clubs.

GET /clubs/{id} Get Clubs Details

Parameters

Name	Type	Required	Description	Example
id	number	Required	Club Id

Examples

Request

GET/clubs/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "5",
    "name": "Founders Club",
    "description": "Red. Only. Need we say more? You won't regret this commitment. Look for a case of our finest red selections to arrive at your door in January, May and November. In order to insure that each shipment will showcase seasonally appropriate wines we've asked our in-house chef, Michel Brassica to work with our winemaker to hand-select wines that will pair perfectly with the dishes of the season. Who knows, he might even through in some of his award-winning recipes...",
    "discount": "20",
    "free_shipping": "0",
    "club_confirmation_message": "We greatly appreciate your commitment to support the consumption of legendary red wines. \r\nSalud!\r\n\r\n- The Acme Vineyards Crew",
    "club_info_1": "<ul><li>Shipments 3 times a year:&nbsp;Jan, May &amp; Nov</li><li>Private tastings by appointment</li><li>Exclusive Invites to Special Events</li><li>First access to limited release white wines</li></ul>",
    "club_info_2": "$300 per shipment<br />(tax and shipping not included)",
    "club_info_3": "",
    "order_status": "1",
    "sort": "1"
}

GET /clubs Get List of Clubs

Examples

Request

GET/clubs

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "5": {
        "id": "5",
        "name": "Founders Club",
        "description": "Red. Only. Need we say more? You won't regret this commitment. Look for a case of our finest red selections to arrive at your door in January, May and November. In order to insure that each shipment will showcase seasonally appropriate wines we've asked our in-house chef, Michel Brassica to work with our winemaker to hand-select wines that will pair perfectly with the dishes of the season. Who knows, he might even through in some of his award-winning recipes...",
        "discount": "20",
        "free_shipping": "0",
        "club_confirmation_message": "We greatly appreciate your commitment to support the consumption of legendary red wines. \r\nSalud!\r\n\r\n- The Acme Vineyards Crew",
        "club_info_1": "<ul><li>Shipments 3 times a year:&nbsp;Jan, May &amp; Nov</li><li>Private tastings by appointment</li><li>Exclusive Invites to Special Events</li><li>First access to limited release white wines</li></ul>",
        "club_info_2": "$300 per shipment<br />(tax and shipping not included)",
        "club_info_3": "",
        "sort": "1"
    },
    "4": {
        "id": "4",
        "name": "Acme Refreshing Whites Club",
        "description": "If you've ever had a chance to visit the Napa Valley then you know firsthand that there are fantastic whites being produced right alongside the legendary reds — they are just in slightly shorter supply.  So don't just settle for whatever your local Trader Joe's has on hand  -- sign on to receive a selection of fantastic white wines available only through our exclusive <em>Refreshing Whites Club</em> and we'll be sure that three times a year 12 outstanding bottles will arrive at your doorstep.",
        "discount": "15",
        "free_shipping": "1",
        "club_confirmation_message": "We're so glad you've come to your senses and joined the club!\r\n\r\n- The Acme Vineyards Crew",
        "club_info_1": "<ul><li>Shipments 3 times a year:&nbsp;Jan, May &amp; Nov</li><li>Private tastings by appointment</li><li>Exclusive Invites to Special Events</li><li>First access to limited release white wines</li></ul>",
        "club_info_2": "$200 - $230 per shipment<br />(tax and shipping not included)",
        "club_info_3": "",
        "sort": "2"
    }
}

Config

Resources related to Config.

GET /system_config Get Account Config

Examples

Request

GET/system_config

Headers

Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "admin_email": "betatester@750group.com",
    "amedeo_password": "",
    "amedeo_username": "",
    "aws_ses_verified": "TRUE",
    "cm_api_key": "af737b8ee89e4714079ea2c717cd2ec5fc0b6a81c776d7ae",
    "cm_client_id": "1a6a176082cf2a6290f265e227af9cc4",
    "cm_list_id": "e82af5924ae170d3fc17a94faa3050f4",
    "company_address": "523 Brown Street",
    "company_address_2": "Suite 750",
    "company_city": "Napa",
    "company_email": "hello@acmevineyards.com",
    "company_name": "Acme Vineyards",
    "company_phone": "707-947-3007",
    "company_state": "CA",
    "COMPANY_WEB_DESCRIPTION": "DEMO - Enjoy the wines of Acme Vineyards.",
    "COMPANY_WEB_KEYWORDS": "acme vineyards, acme, vineyards, wines, napa",
    "company_zip": "94559",
    "customer_credit": "",
    "customer_quote_1": "\"Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat.\"<br><strong>—T. Wilder</strong>",
    "customer_quote_2": "\"Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod&nbsp;reprehenderit&nbsp;&nbsp;tempor.\"<br><strong>—T. Caly</strong>",
    "customer_quote_3": "\"incididunt ut labore et dolore magna aliqua. Ut enim ad minim&nbsp;reprehenderit&nbsp;veniam adipisicing.\"<br><strong>—I. Tucker</strong>",
    "customer_quote_4": "\"Excepteur sint occaecat cupidatat non proident, sunt in culpa&nbsp;reprehenderit qui officia deserunt.\"<br><strong>—L. Trefethen</strong>",
    "default_group": "23",
    "enable_advanced": "TRUE",
    "enable_advanced_zones": "TRUE",
    "enable_allocation_button": "FALSE",
    "enable_allocation_button_welcomeoffer": "FALSE",
    "enable_allocation_sales": "FALSE",
    "enable_amedeo": "FALSE",
    "enable_club": "TRUE",
    "enable_cm_history": "TRUE",
    "enable_customer_quotes": "FALSE",
    "enable_ddc": "FALSE",
    "enable_eaglerock": "FALSE",
    "enable_faq": "TRUE",
    "enable_map": "TRUE",
    "enable_microsite": "TRUE",
    "enable_processing": "FALSE",
    "enable_promo": "TRUE",
    "enable_reservations": "FALSE",
    "enable_shipcompliant": "FALSE",
    "enable_shipcompliant_fulfillment": "FALSE",
    "enable_shipcompliant_tax_rates": "FALSE",
    "enable_social_media": "TRUE",
    "enable_special_promotions": "FALSE",
    "enable_twitter_feed": "FALSE",
    "enable_vinfillment": "FALSE",
    "enforce_allocation": "FALSE",
    "extra_info_1": "extra 1",
    "extra_info_2": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo. Adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo.",
    "extra_info_3": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo.",
    "extra_info_4": "Summer shipping now in progress",
    "extra_info_5": "",
    "extra_info_6": "",
    "free_shipping_subtotal_min": "",
    "goal_month": "7500.00",
    "goal_year": "100000",
    "google_analytics_id": "UA-1234",
    "host": "",
    "image_email_header": "http://s3.amazonaws.com/efcheckout/acmev/email_header-70971.gif",
    "image_logo": "//s3.amazonaws.com/efcheckout/acmev/logo-47249.png",
    "invite_email": "",
    "list_customer_channels": "Web\r\nInternal\r\nTasting Room",
    "list_customer_sources": "Friend/Colleague\r\nRestaurant/Shop\r\nPress/Website\r\nEvent/Tasting\r\nHotel/Other Winery\r\nOther\r\nBob’s Buds",
    "list_customer_types": "Waiting List\r\nAllocated",
    "list_sales_agents": "Ian\r\nTyson\r\nTori\r\nLoren",
    "member_since": "June 2011",
    "other_url": "",
    "payment_descriptor": "Acme Vineyards",
    "reason": "",
    "referral_credit": "",
    "reservation_email_confirmation": "",
    "reservation_email_decline": "",
    "reservation_location": "",
    "reservation_type": "",
    "sales_image_1": "//s3.amazonaws.com/efcheckout/acmev/settings/sales_image_1-92359.jpeg",
    "sales_image_2": "//s3.amazonaws.com/efcheckout/acmev/settings/sales_image_2-78556.jpeg",
    "sales_image_3": "//s3.amazonaws.com/efcheckout/acmev/settings/sales_image_3-38639.jpeg",
    "ship_compliant_password": "",
    "ship_compliant_shipment_status": "",
    "ship_compliant_username": "",
    "social_facebook": "750group",
    "social_flickr": "",
    "social_googleplus": "750group",
    "social_instagram": "750group",
    "social_linkedin": "",
    "social_pinterest": "750group",
    "social_tumblr": "750group",
    "social_twitter": "750group",
    "social_youtube": "",
    "website_url": "http://acmev.securecheckout.com"
}

Content

Resources related to Content.

GET /content/{slug} Get CMS Content

Parameters

Name	Type	Required	Description	Example
slug	string	Required	Content Id

Examples

Request

GET/content/{slug}

Headers

Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "title": "About Us",
    "status": "Active",
    "created": "2018-01-12 09:04:02"
}

Customer

Resources related to Customer.

DELETE /customer Cancel Customer Account

Examples

Request

DELETE/customer

Headers

Content-Type: application/json
X-Auth-Token: XXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

GET /customer/groups Get Customer Groups

Examples

Request

GET/customer/groups

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "2",
    "name": "Customer Group I",
    "status": "Active",
    "sort": "0",
    "allocation_message": "",
    "allocation_start": "0000-00-00 00:00:00",
    "checkout_cart_min": "0",
    "allocation_end": "0000-00-00 00:00:00",
    "discount": "0",
    "free_shipping": "0",
    "description": "Updated Customer Group"
}

GET /customer Get Customer Profile

Examples

Request

GET/customer

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "2",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "ian@750group.com",
    "status": "Active",
    "state": "CA",
    "order_count": "69",
    "order_total": "16180.90",
    "last_order": "2015-11-30 15:20:10",
    "last_order_total": "5.50",
    "created": "2012-10-08 12:59:28",
    "address": "2210 Tucker Ave",
    "address_2": "",
    "affiliate_id": "xxxxxxxxxxxxxxxxxxxxxx",
    "birthday": "1986-04-3",
    "city": "Napa",
    "company": "",
    "credits": "0.00",
    "job_title": "",
    "mobile": "",
    "phone": "707-501-7491",
    "user_facebook": "",
    "user_linkedin": "",
    "user_pinterest": "",
    "user_twitter": "",
    "zip": "94559"
}

GET /customer/invite_token Get Invite Token

Examples

Request

GET/customer/invite_token

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

"22daaa7e68413724d037fa9b3a1abb39ed45c757"

PUT /customer Update Customer Profile

Examples

Request

PUT/customer

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

GET /customer/allocation Get Allocation

Examples

Request

GET/customer/allocation

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "AV10NVRB": {
        "sku": "AV10NVRB",
        "min_quantity": "0",
        "max_quantity": "2",
        "quantity": "2",
        "min_wish": "0",
        "max_wish": "6",
        "allocation_start": "2018-01-10 00:00:00",
        "allocation_end": "2018-03-31 23:59:00"
    },
    "AV09NVCS1": {
        "sku": "AV09NVCS1",
        "min_quantity": "0",
        "max_quantity": "6",
        "quantity": "6",
        "min_wish": "0",
        "max_wish": "6",
        "allocation_start": "2018-01-10 00:00:00",
        "allocation_end": "2018-03-31 23:59:00"
    }
}

GET /customer/allocation/messsages Get Allocation Messages

Examples

Request

GET/customer/allocation/messsages

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

[
    {
        "allocation_message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
    }
]

GET /customer/allocation/wish Get Allocation Wishlist

Examples

Request

GET/customer/allocation/wish

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "AV09NVCS1": {
        "sku": "AV09NVCS1",
        "quantity": "4",
        "price": "150.00",
        "description": "2009 Cabernet Sauvignon"
    },
    "AV10NVRB": {
        "sku": "AV10NVRB",
        "quantity": "2",
        "price": "100.00",
        "description": "2015 Pinot Noir"
    }
}

GET /customer/allocation/wishes Get Saved Wishes

Examples

Request

GET/customer/allocation/wishes

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

[
    {
        "AV09NVCS1": {
            "sku": "AV09NVCS1",
            "quantity": "4",
            "price": "150.00",
            "description": "2009 Cabernet Sauvignon"
        },
        "AV10NVRB": {
            "sku": "AV10NVRB",
            "quantity": "2",
            "price": "100.00",
            "description": "2015 Pinot Noir"
        }
    }
]

PUT /customer/allocation/wish/config Set Allocation Wishlist Metadata

Examples

Request

PUT/customer/allocation/wish/config

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "requested_ship_date": "2018-02-14"
}

Response

Headers · 200

Content-Type: application/json

Body

true

PUT /customer/allocation/wish/items/{sku}/{quantity} Update Allocation Wishlist Quantity

Parameters

Name	Type	Required	Description	Example
quantity	number	Required	New Quantity for Sku
sku	string	Required	Product SKU

Examples

Request

PUT/customer/allocation/wish/items/{sku}/{quantity}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

DELETE /customer/clubs/{id} Cancel Club Membership

Parameters

Name	Type	Required	Description	Example
id	number	Required	Club Membership Id

Examples

Request

DELETE/customer/clubs/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

POST /customer/clubs Create New Club Membership

Parameters

Name	Type	Required	Description
address_id	number	Required	Address Id
club_id	number	Required	Club Id
payment_id	number	Required	Payment Id

Examples

Request

POST/customer/clubs

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "club_id": 5,
    "address_id": 27,
    "payment_id": 3142
}

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "471",
    "club_id": "5",
    "name": "Founders Club",
    "discount": "0",
    "free_shipping": "0",
    "address_id": "27",
    "payment_id": "3142",
    "created": "2016-07-22 09:29:10"
}

GET /customer/clubs Get List of Club Memberships

Examples

Request

GET/customer/clubs

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

[
    {
        "id": "471",
        "club_id": "5",
        "name": "Founders Club",
        "discount": "0",
        "free_shipping": "0",
        "address_id": "27",
        "payment_id": "3142",
        "created": "2016-07-22 09:29:10"
    }
]

PUT /customer/clubs/{id} Update Club Membership

Parameters

Name	Type	Required	Description	Example
payment_id	number	Optional	Payment Id
id	number	Required	Club Membership Id

Examples

Request

PUT/customer/clubs/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "address_id": 4093,
    "payment_id": 6
}

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "471",
    "club_id": "5",
    "name": "Founders Club",
    "discount": "0",
    "free_shipping": "0",
    "address_id": "4093",
    "payment_id": "6",
    "created": "2016-07-22 09:29:10"
}

GET /customer/orders Get Customer Order History

Examples

Request

GET/customer/orders

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "361": {
        "id": "361",
        "datestamp": "2015-04-07 01:59:22",
        "status": "",
        "subtotal": "683.00",
        "tax": "54.64",
        "shipping": "0.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "737.64",
        "customer_id": "2",
        "address": "523 Brown St",
        "address_2": "",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "customer_credits": "0.00",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "gift_message": "",
        "instructions": "",
        "item_count": "13",
        "last_name": "Doe",
        "order_id": "361",
        "order_type": "Web",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "requested_ship_date": "2015-03-16",
        "shipping_address": "523 Brown St",
        "shipping_address_2": "",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "3",
        "shipping_method_carrier": "DDC",
        "shipping_method_code": "FXO",
        "shipping_method_name": "Expedited Shipping",
        "shipping_phone": "707-501-7491",
        "shipping_state": "CA",
        "shipping_title": "ShippingAddress",
        "shipping_zip": "94558",
        "ship_status": "Not Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "387",
        "zip": "94559",
        "products": [
            {
                "id": "361",
                "sku": "12312312312",
                "name": "2014 Rosu00e9",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "7",
                "status": "",
                "description": "2014 Rosé Napa Valley",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-04-07 01:59:22"
            },
            {
                "id": "361",
                "sku": "AV10NVRB",
                "name": "2009 Red Blend",
                "type": "",
                "price": "38",
                "discount": "0",
                "quantity": "6",
                "status": "",
                "description": "2009 Red Blend Napa Valley",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRB-3972.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-04-07 01:59:22"
            }
        ]
    },
    "359": {
        "id": "359",
        "datestamp": "2015-04-07 01:12:57",
        "status": "",
        "subtotal": "412.00",
        "tax": "32.96",
        "shipping": "0.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "444.96",
        "customer_id": "2",
        "address": "523 Brown St",
        "address_2": "",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "customer_credits": "0.00",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "gift_message": "",
        "instructions": "",
        "item_count": "8",
        "last_name": "Doe",
        "order_id": "359",
        "order_type": "Web",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "requested_ship_date": "2015-03-16",
        "shipping_address": "354357357",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "3",
        "shipping_method_carrier": "DDC",
        "shipping_method_code": "FXO",
        "shipping_method_name": "Expedited Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_title": "ShippingAddress",
        "shipping_zip": "94599",
        "ship_status": "Not Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "385",
        "zip": "94559",
        "products": [
            {
                "id": "359",
                "sku": "12312312312",
                "name": "2014 Rosu00e9",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "4",
                "status": "",
                "description": "2014 Rosé Napa Valley",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-04-07 01:12:57"
            },
            {
                "id": "359",
                "sku": "AV10NVRB",
                "name": "2009 Red Blend",
                "type": "",
                "price": "38",
                "discount": "0",
                "quantity": "4",
                "status": "",
                "description": "2009 Red Blend Napa Valley",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRB-3972.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-04-07 01:12:57"
            }
        ]
    },
    "342": {
        "id": "342",
        "datestamp": "2015-04-07 00:51:10",
        "status": "",
        "subtotal": "780.00",
        "tax": "62.40",
        "shipping": "0.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "842.40",
        "customer_id": "2",
        "address": "523 Brown St",
        "address_2": "",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "1111",
        "credit_type": "Visa",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "gift_message": "",
        "instructions": "",
        "item_count": "12",
        "last_name": "Doe",
        "order_id": "342",
        "order_type": "Web",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "requested_ship_date": "2015-03-16",
        "shipping_address": "523 Brown St",
        "shipping_address_2": "",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "3",
        "shipping_method_carrier": "DDC",
        "shipping_method_code": "FXO",
        "shipping_method_name": "Expedited Shipping",
        "shipping_phone": "707-501-7491",
        "shipping_state": "CA",
        "shipping_title": "ShippingAddress",
        "shipping_zip": "94558",
        "ship_status": "Not Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "369",
        "zip": "94559",
        "products": [
            {
                "id": "342",
                "sku": "12312312312",
                "name": "2014 Rosu00e9",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "12",
                "status": "",
                "description": "2014 Rosé Napa Valley",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-04-07 00:51:10"
            }
        ]
    },
    "328": {
        "id": "328",
        "datestamp": "2015-03-13 03:40:01",
        "status": "",
        "subtotal": "915.00",
        "tax": "62.22",
        "shipping": "0.00",
        "discount": "137.25",
        "credits": "240.00",
        "refund": "0.00",
        "total": "599.97",
        "customer_id": "2",
        "address": "523 Brown St",
        "address_2": "",
        "address_id": "3913",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "customer_credits": "240.00",
        "discount_customer": "0.15",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "item_count": "12",
        "last_name": "Doe",
        "order_id": "328",
        "order_type": "Admin",
        "payment_id": "118",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "sales_agent": "Jane Doe",
        "sale_credit": "...",
        "shipping_address": "354357357",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "12",
        "shipping_method_carrier": "UPS",
        "shipping_method_code": "UPSGND",
        "shipping_method_name": "Intergalactic Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "353",
        "zip": "94559",
        "products": [
            {
                "id": "328",
                "sku": "12312312312",
                "name": "2011 Cabernet Sauvignon",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "3",
                "status": "",
                "description": "2011 Cabernet Sauvignon Napa Valley",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-03-13 03:40:01"
            },
            {
                "id": "328",
                "sku": "123123213123123213",
                "name": "2014 Reserve Cabernet Sauvignon",
                "type": "",
                "price": "80",
                "discount": "0",
                "quantity": "1",
                "status": "",
                "description": "2014 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-03-13 03:40:01"
            },
            {
                "id": "328",
                "sku": "212nvcs",
                "name": "2012 Reserve Cabernet Sauvignon",
                "type": "",
                "price": "80",
                "discount": "0",
                "quantity": "6",
                "status": "",
                "description": "2012 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-03-13 03:40:01"
            },
            {
                "id": "328",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon",
                "type": "",
                "price": "80",
                "discount": "0",
                "quantity": "2",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRCS-3914.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-03-13 03:40:01"
            }
        ],
        "packages": []
    },
    "311": {
        "id": "311",
        "datestamp": "2015-01-23 11:11:00",
        "status": "",
        "subtotal": "900.00",
        "tax": "67.20",
        "shipping": "0.00",
        "discount": "60.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "907.20",
        "customer_id": "2",
        "address": "523 Brown St",
        "address_2": "",
        "address_id": "3977",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "1",
        "item_count": "12",
        "last_name": "Doe",
        "order_id": "311",
        "order_type": "Club",
        "override_discount": "60.00",
        "payment_id": "118",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "6484 Winery Street",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "c/o Acme Vineyards",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "10",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "WILLCALL",
        "shipping_method_name": "Winery Pickup",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "320",
        "zip": "94559",
        "products": [
            {
                "id": "311",
                "sku": "12312312312",
                "name": "2011 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "4",
                "status": "",
                "description": "2011 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-01-23 11:11:00"
            },
            {
                "id": "311",
                "sku": "123123213123123213",
                "name": "2014 Reserve Cabernet Sauvignon ",
                "type": "",
                "price": "80",
                "discount": "0",
                "quantity": "4",
                "status": "",
                "description": "2014 Reserve Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-01-23 11:11:00"
            },
            {
                "id": "311",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon ",
                "type": "",
                "price": "80",
                "discount": "0",
                "quantity": "4",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2015-01-23 11:11:00"
            }
        ],
        "packages": []
    },
    "282": {
        "id": "282",
        "datestamp": "2014-11-11 15:37:16",
        "status": "",
        "subtotal": "390.00",
        "tax": "0.00",
        "shipping": "0.00",
        "discount": "90.00",
        "credits": "0.00",
        "refund": "24.00",
        "total": "300.00",
        "customer_id": "2",
        "address": "523 Brown St",
        "address_2": "",
        "address_id": "3977",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "1111",
        "credit_type": "Visa",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "1",
        "item_count": "6",
        "last_name": "Doe",
        "order_id": "282",
        "order_type": "Club",
        "override_discount": "90",
        "payment_id": "119",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "6484 Winery Street",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "c/o Acme Vineyards",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "10",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "WILLCALL",
        "shipping_method_name": "Winery Pickup",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "281",
        "zip": "94559",
        "products": [
            {
                "id": "282",
                "sku": "12312312312",
                "name": "2011 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "6",
                "status": "",
                "description": "2011 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-11-11 15:37:16"
            }
        ],
        "packages": []
    },
    "276": {
        "id": "276",
        "datestamp": "2014-10-23 10:55:34",
        "status": "",
        "subtotal": "600.00",
        "tax": "40.80",
        "shipping": "40.00",
        "discount": "90.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "590.80",
        "customer_id": "2",
        "address": "523 Brown St",
        "address_2": "",
        "address_id": "3913",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "customer_credits": "0.00",
        "discount_customer": "0.15",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "item_count": "6",
        "last_name": "Doe",
        "order_id": "276",
        "order_type": "Club",
        "payment_id": "118",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "sales_agent": "Tyson Caly",
        "shipping_address": "354357357",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "4",
        "shipping_method_carrier": "WCS",
        "shipping_method_code": "FXG",
        "shipping_method_name": "Ground Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "274",
        "zip": "94559",
        "products": [
            {
                "id": "276",
                "sku": "322345345",
                "name": "2011 Reserve Cabernet Sauvignon",
                "type": "",
                "price": "100",
                "discount": "0",
                "quantity": "6",
                "status": "",
                "description": "2011 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-10-23 10:55:34"
            }
        ],
        "packages": []
    },
    "264": {
        "id": "264",
        "datestamp": "2014-09-17 18:51:19",
        "status": "",
        "subtotal": "495.00",
        "tax": "32.00",
        "shipping": "40.00",
        "discount": "95.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "472.00",
        "customer_id": "2",
        "address": "2210 Tejas Ave",
        "address_2": "",
        "address_id": "3977",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "",
        "item_count": "6",
        "last_name": "Doe",
        "order_id": "264",
        "order_type": "Club",
        "override_discount": "95.00",
        "payment_id": "94",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "2210 Tejas Ave",
        "shipping_address_2": "",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "4",
        "shipping_method_carrier": "WCS",
        "shipping_method_code": "FXG",
        "shipping_method_name": "Ground Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "261",
        "zip": "94559",
        "products": [
            {
                "id": "264",
                "sku": "AV09NVCS1",
                "name": "2009 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "3",
                "status": "",
                "description": "2009 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-09-17 18:51:19"
            },
            {
                "id": "264",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon ",
                "type": "",
                "price": "100",
                "discount": "0",
                "quantity": "3",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-09-17 18:51:19"
            }
        ],
        "packages": []
    },
    "255": {
        "id": "255",
        "datestamp": "2014-09-12 16:41:17",
        "status": "",
        "subtotal": "2760.00",
        "tax": "220.80",
        "shipping": "0.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "2980.80",
        "customer_id": "2",
        "address": "6484 Washington St.",
        "address_2": "",
        "address_id": "3977",
        "birthday": "1986-04-3",
        "city": "Yountville",
        "company": "",
        "credit_number": "1111",
        "credit_type": "Visa",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "1",
        "item_count": "36",
        "last_name": "Doe",
        "order_id": "255",
        "order_type": "Club",
        "override_discount": "",
        "payment_id": "92",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "6484 Winery Street",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "c/o Acme Vineyards",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "10",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "WILLCALL",
        "shipping_method_name": "Winery Pickup",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "251",
        "zip": "94599",
        "products": [
            {
                "id": "255",
                "sku": "12312312312",
                "name": "2011 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "12",
                "status": "",
                "description": "2011 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-09-12 16:41:17"
            },
            {
                "id": "255",
                "sku": "AV09NVCS1",
                "name": "2009 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "12",
                "status": "",
                "description": "2009 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-09-12 16:41:17"
            },
            {
                "id": "255",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon ",
                "type": "",
                "price": "100",
                "discount": "0",
                "quantity": "12",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-09-12 16:41:17"
            }
        ],
        "packages": []
    },
    "236": {
        "id": "236",
        "datestamp": "2014-08-07 11:56:54",
        "status": "",
        "subtotal": "230.00",
        "tax": "18.40",
        "shipping": "25.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "273.40",
        "customer_id": "2",
        "address": "2210 Tejas Ave",
        "address_2": "",
        "address_id": "3977",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "",
        "item_count": "3",
        "last_name": "Doe",
        "order_id": "236",
        "order_type": "Club",
        "override_discount": "",
        "payment_id": "94",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "2210 Tejas Ave",
        "shipping_address_2": "",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "4",
        "shipping_method_carrier": "WCS",
        "shipping_method_code": "FXG",
        "shipping_method_name": "Ground Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "229",
        "zip": "94559",
        "products": [
            {
                "id": "236",
                "sku": "12312312312",
                "name": "2011 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "1",
                "status": "",
                "description": "2011 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-08-07 11:56:54"
            },
            {
                "id": "236",
                "sku": "AV09NVCS1",
                "name": "2009 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "1",
                "status": "",
                "description": "2009 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-08-07 11:56:54"
            },
            {
                "id": "236",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon ",
                "type": "",
                "price": "100",
                "discount": "0",
                "quantity": "1",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-08-07 11:56:54"
            }
        ],
        "packages": []
    },
    "228": {
        "id": "228",
        "datestamp": "2014-08-01 10:55:15",
        "status": "",
        "subtotal": "495.00",
        "tax": "39.60",
        "shipping": "0.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "534.60",
        "customer_id": "2",
        "address": "6484 Washington St.",
        "address_2": "",
        "address_id": "3977",
        "birthday": "1986-04-3",
        "city": "Yountville",
        "company": "",
        "credit_number": "1111",
        "credit_type": "Visa",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "1",
        "item_count": "6",
        "last_name": "Doe",
        "order_id": "228",
        "order_type": "Club",
        "override_discount": "",
        "payment_id": "92",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "6484 Winery Street",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "c/o Acme Vineyards",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "10",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "WILLCALL",
        "shipping_method_name": "Winery Pickup",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "220",
        "zip": "94599",
        "products": [
            {
                "id": "228",
                "sku": "AV09NVCS1",
                "name": "2009 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "3",
                "status": "",
                "description": "2009 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-08-01 10:55:15"
            },
            {
                "id": "228",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon ",
                "type": "",
                "price": "100",
                "discount": "0",
                "quantity": "3",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-08-01 10:55:15"
            }
        ],
        "packages": []
    },
    "223": {
        "id": "223",
        "datestamp": "2014-07-25 12:18:08",
        "status": "",
        "subtotal": "720.00",
        "tax": "52.80",
        "shipping": "0.00",
        "discount": "60.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "712.80",
        "customer_id": "2",
        "address": "6484 Washington St.",
        "address_2": "",
        "address_id": "3913",
        "birthday": "1986-04-3",
        "city": "Yountville",
        "company": "",
        "credit_number": "1111",
        "credit_type": "Visa",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "1",
        "item_count": "10",
        "last_name": "Doe",
        "order_id": "223",
        "order_type": "Club",
        "override_discount": "60.00",
        "payment_id": "92",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "354357357",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "4",
        "shipping_method_carrier": "WCS",
        "shipping_method_code": "FXG",
        "shipping_method_name": "Ground Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "214",
        "zip": "94599",
        "products": [
            {
                "id": "223",
                "sku": "454646878",
                "name": "2012 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "6",
                "status": "",
                "description": "2012 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-25 12:18:08"
            },
            {
                "id": "223",
                "sku": "555",
                "name": "2011 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "2",
                "status": "",
                "description": "2011 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-25 12:18:08"
            },
            {
                "id": "223",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon ",
                "type": "",
                "price": "100",
                "discount": "0",
                "quantity": "2",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-25 12:18:08"
            }
        ],
        "packages": []
    },
    "210": {
        "id": "210",
        "datestamp": "2014-07-16 00:45:50",
        "status": "",
        "subtotal": "650.00",
        "tax": "44.20",
        "shipping": "60.00",
        "discount": "97.50",
        "credits": "0.00",
        "refund": "0.00",
        "total": "656.70",
        "customer_id": "2",
        "address": "6484 Washington St.",
        "address_2": "",
        "address_id": "3977",
        "birthday": "1986-04-3",
        "city": "Yountville",
        "company": "",
        "credit_number": "1111",
        "credit_type": "Visa",
        "customer_credits": "0.00",
        "discount_customer": "0.15",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "item_count": "10",
        "last_name": "Doe",
        "order_id": "210",
        "order_type": "Admin",
        "payment_id": "92",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "requested_ship_date": "07/30/2014",
        "sales_agent": "Tyson Caly",
        "shipping_address": "2210 Tejas Ave",
        "shipping_address_2": "",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "4",
        "shipping_method_carrier": "WCS",
        "shipping_method_code": "FXG",
        "shipping_method_name": "Ground Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "201",
        "zip": "94599",
        "products": [
            {
                "id": "210",
                "sku": "AV09NVCS1",
                "name": "2009 Cabernet Sauvignon",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "10",
                "status": "",
                "description": "2009 Cabernet Sauvignon Napa Valley",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV09NVCS1-1204.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-16 00:45:50"
            }
        ],
        "packages": []
    },
    "202": {
        "id": "202",
        "datestamp": "2014-07-13 15:40:00",
        "status": "",
        "subtotal": "490.00",
        "tax": "0.00",
        "shipping": "0.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "490.00",
        "customer_id": "2",
        "address": "6484 Washington St.",
        "address_2": "",
        "address_id": "3913",
        "birthday": "1986-04-3",
        "city": "Yountville",
        "company": "",
        "credit_number": "1111",
        "credit_type": "Visa",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "1",
        "item_count": "7",
        "last_name": "Doe",
        "order_id": "202",
        "order_type": "Club",
        "override_discount": "",
        "payment_id": "92",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "354357357",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "4",
        "shipping_method_carrier": "WCS",
        "shipping_method_code": "FXG",
        "shipping_method_name": "Ground Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_exempt": "1",
        "tax_rate": "0",
        "transaction_id": "193",
        "zip": "94599",
        "products": [
            {
                "id": "202",
                "sku": "AV09NVCS1",
                "name": "2009 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "6",
                "status": "",
                "description": "2009 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-13 15:40:00"
            },
            {
                "id": "202",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon ",
                "type": "",
                "price": "100",
                "discount": "0",
                "quantity": "1",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-13 15:40:00"
            }
        ],
        "packages": []
    },
    "196": {
        "id": "196",
        "datestamp": "2014-07-09 20:15:10",
        "status": "",
        "subtotal": "130.00",
        "tax": "8.80",
        "shipping": "0.00",
        "discount": "20.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "118.80",
        "customer_id": "2",
        "address": "2210 Tejas Ave",
        "address_2": "",
        "address_id": "3977",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "free_shipping": "1",
        "item_count": "2",
        "last_name": "Doe",
        "order_id": "196",
        "order_type": "Club",
        "override_discount": "20.00",
        "payment_id": "94",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "2210 Tejas Ave",
        "shipping_address_2": "",
        "shipping_city": "Napa",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "4",
        "shipping_method_carrier": "WCS",
        "shipping_method_code": "FXG",
        "shipping_method_name": "Ground Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_zip": "94559",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "188",
        "zip": "94559",
        "products": [
            {
                "id": "196",
                "sku": "454646878",
                "name": "2012 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "1",
                "status": "",
                "description": "2012 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-09 20:15:10"
            },
            {
                "id": "196",
                "sku": "AV09NVCS1",
                "name": "2009 Cabernet Sauvignon ",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "1",
                "status": "",
                "description": "2009 Cabernet Sauvignon ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-09 20:15:10"
            }
        ],
        "packages": []
    },
    "195": {
        "id": "195",
        "datestamp": "2014-07-08 22:41:20",
        "status": "",
        "subtotal": "790.00",
        "tax": "53.72",
        "shipping": "60.00",
        "discount": "118.50",
        "credits": "0.00",
        "refund": "0.00",
        "total": "785.22",
        "customer_id": "2",
        "address": "2210 Tejas Ave",
        "address_2": "",
        "address_id": "3913",
        "birthday": "1986-04-3",
        "city": "Napa",
        "company": "",
        "credit_number": "8431",
        "credit_type": "American Express",
        "customer_credits": "0.00",
        "discount_customer": "0.15",
        "email": "ian@750group.com",
        "first_name": "Jane",
        "gift_message": "",
        "instructions": "",
        "item_count": "10",
        "last_name": "Doe",
        "order_id": "195",
        "payment_id": "94",
        "payment_status": "Paid",
        "phone": "707-501-7491",
        "shipping_address": "354357357",
        "shipping_address_2": "",
        "shipping_city": "Yountville",
        "shipping_company": "",
        "shipping_first_name": "Jane",
        "shipping_last_name": "Doe",
        "shipping_method": "3",
        "shipping_method_carrier": "WCS",
        "shipping_method_code": "FXO",
        "shipping_method_id": "3",
        "shipping_method_name": "Expedited Shipping",
        "shipping_phone": "7075017491",
        "shipping_state": "CA",
        "shipping_title": "ShippingAddress",
        "shipping_zip": "94599",
        "ship_status": "Shipped",
        "state": "CA",
        "tax_rate": "8",
        "transaction_id": "187",
        "zip": "94559",
        "products": [
            {
                "id": "195",
                "sku": "AV09NVCS1",
                "name": "2009 Cabernet Sauvignon",
                "type": "",
                "price": "65",
                "discount": "0",
                "quantity": "6",
                "status": "",
                "description": "2009 Cabernet Sauvignon Napa Valley",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV09NVCS1-1204.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-08 22:41:20"
            },
            {
                "id": "195",
                "sku": "AV10NVRCS",
                "name": "2010 Reserve Cabernet Sauvignon",
                "type": "",
                "price": "100",
                "discount": "0",
                "quantity": "4",
                "status": "",
                "description": "2010 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve",
                "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRCS-3914.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2014-07-08 22:41:20"
            }
        ],
        "packages": []
    }
}

GET /customer/orders/{id} Get Order Detail

Parameters

Name	Type	Required	Description	Example
id	number	Required	Order Id

Examples

Request

GET/customer/orders/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{"id":"361","datestamp":"2015-04-07 01:59:22","status":"","subtotal":"683.00","tax":"54.64","shipping":"0.00","discount":"0.00","credits":"0.00","refund":"0.00","total":"737.64","customer_id":"2","address":"523 Brown St","address_2":"","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","customer_credits":"0.00","email":"ian@750group.com","first_name":"Jane","gift_message":"","instructions":"","item_count":"13","last_name":"Doe","order_id":"361","order_type":"Web","payment_status":"Paid","phone":"707-501-7491","requested_ship_date":"2015-03-16","shipping_address":"523 Brown St","shipping_address_2":"","shipping_city":"Napa","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"3","shipping_method_carrier":"DDC","shipping_method_code":"FXO","shipping_method_name":"Expedited Shipping","shipping_phone":"707-501-7491","shipping_state":"CA","shipping_title":"ShippingAddress","shipping_zip":"94558","ship_status":"Not Shipped","state":"CA","tax_rate":"8","transaction_id":"387","zip":"94559","products":[{"id":"361","sku":"12312312312","name":"2014 Rosu00e9","type":"","price":"65","discount":"0","quantity":"7","status":"","description":"2014 Ros\u00e9 Napa Valley","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/12312312312-1725.jpg","stock_status":"","shipped":"0","created":"2015-04-07 01:59:22"},{"id":"361","sku":"AV10NVRB","name":"2009 Red Blend","type":"","price":"38","discount":"0","quantity":"6","status":"","description":"2009 Red Blend Napa Valley","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/AV10NVRB-3972.jpg","stock_status":"","shipped":"0","created":"2015-04-07 01:59:22"}]},"359":{"id":"359","datestamp":"2015-04-07 01:12:57","status":"","subtotal":"412.00","tax":"32.96","shipping":"0.00","discount":"0.00","credits":"0.00","refund":"0.00","total":"444.96","customer_id":"2","address":"523 Brown St","address_2":"","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","customer_credits":"0.00","email":"ian@750group.com","first_name":"Jane","gift_message":"","instructions":"","item_count":"8","last_name":"Doe","order_id":"359","order_type":"Web","payment_status":"Paid","phone":"707-501-7491","requested_ship_date":"2015-03-16","shipping_address":"354357357","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"3","shipping_method_carrier":"DDC","shipping_method_code":"FXO","shipping_method_name":"Expedited Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_title":"ShippingAddress","shipping_zip":"94599","ship_status":"Not Shipped","state":"CA","tax_rate":"8","transaction_id":"385","zip":"94559","products":[{"id":"359","sku":"12312312312","name":"2014 Rosu00e9","type":"","price":"65","discount":"0","quantity":"4","status":"","description":"2014 Ros\u00e9 Napa Valley","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/12312312312-1725.jpg","stock_status":"","shipped":"0","created":"2015-04-07 01:12:57"},{"id":"359","sku":"AV10NVRB","name":"2009 Red Blend","type":"","price":"38","discount":"0","quantity":"4","status":"","description":"2009 Red Blend Napa Valley","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/AV10NVRB-3972.jpg","stock_status":"","shipped":"0","created":"2015-04-07 01:12:57"}]},"342":{"id":"342","datestamp":"2015-04-07 00:51:10","status":"","subtotal":"780.00","tax":"62.40","shipping":"0.00","discount":"0.00","credits":"0.00","refund":"0.00","total":"842.40","customer_id":"2","address":"523 Brown St","address_2":"","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"1111","credit_type":"Visa","email":"ian@750group.com","first_name":"Jane","gift_message":"","instructions":"","item_count":"12","last_name":"Doe","order_id":"342","order_type":"Web","payment_status":"Paid","phone":"707-501-7491","requested_ship_date":"2015-03-16","shipping_address":"523 Brown St","shipping_address_2":"","shipping_city":"Napa","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"3","shipping_method_carrier":"DDC","shipping_method_code":"FXO","shipping_method_name":"Expedited Shipping","shipping_phone":"707-501-7491","shipping_state":"CA","shipping_title":"ShippingAddress","shipping_zip":"94558","ship_status":"Not Shipped","state":"CA","tax_rate":"8","transaction_id":"369","zip":"94559","products":[{"id":"342","sku":"12312312312","name":"2014 Rosu00e9","type":"","price":"65","discount":"0","quantity":"12","status":"","description":"2014 Ros\u00e9 Napa Valley","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/12312312312-1725.jpg","stock_status":"","shipped":"0","created":"2015-04-07 00:51:10"}]},"328":{"id":"328","datestamp":"2015-03-13 03:40:01","status":"","subtotal":"915.00","tax":"62.22","shipping":"0.00","discount":"137.25","credits":"240.00","refund":"0.00","total":"599.97","customer_id":"2","address":"523 Brown St","address_2":"","address_id":"3913","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","customer_credits":"240.00","discount_customer":"0.15","email":"ian@750group.com","first_name":"Jane","item_count":"12","last_name":"Doe","order_id":"328","order_type":"Admin","payment_id":"118","payment_status":"Paid","phone":"707-501-7491","sales_agent":"Jane Doe","sale_credit":"...","shipping_address":"354357357","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"12","shipping_method_carrier":"UPS","shipping_method_code":"UPSGND","shipping_method_name":"Intergalactic Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"353","zip":"94559","products":[{"id":"328","sku":"12312312312","name":"2011 Cabernet Sauvignon","type":"","price":"65","discount":"0","quantity":"3","status":"","description":"2011 Cabernet Sauvignon Napa Valley","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/12312312312-1725.jpg","stock_status":"","shipped":"0","created":"2015-03-13 03:40:01"},{"id":"328","sku":"123123213123123213","name":"2014 Reserve Cabernet Sauvignon","type":"","price":"80","discount":"0","quantity":"1","status":"","description":"2014 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve","image":"","stock_status":"","shipped":"0","created":"2015-03-13 03:40:01"},{"id":"328","sku":"212nvcs","name":"2012 Reserve Cabernet Sauvignon","type":"","price":"80","discount":"0","quantity":"6","status":"","description":"2012 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve","image":"","stock_status":"","shipped":"0","created":"2015-03-13 03:40:01"},{"id":"328","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon","type":"","price":"80","discount":"0","quantity":"2","status":"","description":"2010 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/AV10NVRCS-3914.jpg","stock_status":"","shipped":"0","created":"2015-03-13 03:40:01"}],"packages":[]},"311":{"id":"311","datestamp":"2015-01-23 11:11:00","status":"","subtotal":"900.00","tax":"67.20","shipping":"0.00","discount":"60.00","credits":"0.00","refund":"0.00","total":"907.20","customer_id":"2","address":"523 Brown St","address_2":"","address_id":"3977","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","email":"ian@750group.com","first_name":"Jane","free_shipping":"1","item_count":"12","last_name":"Doe","order_id":"311","order_type":"Club","override_discount":"60.00","payment_id":"118","payment_status":"Paid","phone":"707-501-7491","shipping_address":"6484 Winery Street","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"c\/o Acme Vineyards","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"10","shipping_method_carrier":"custom","shipping_method_code":"WILLCALL","shipping_method_name":"Winery Pickup","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"320","zip":"94559","products":[{"id":"311","sku":"12312312312","name":"2011 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"4","status":"","description":"2011 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2015-01-23 11:11:00"},{"id":"311","sku":"123123213123123213","name":"2014 Reserve Cabernet Sauvignon ","type":"","price":"80","discount":"0","quantity":"4","status":"","description":"2014 Reserve Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2015-01-23 11:11:00"},{"id":"311","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon ","type":"","price":"80","discount":"0","quantity":"4","status":"","description":"2010 Reserve Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2015-01-23 11:11:00"}],"packages":[]},"282":{"id":"282","datestamp":"2014-11-11 15:37:16","status":"","subtotal":"390.00","tax":"0.00","shipping":"0.00","discount":"90.00","credits":"0.00","refund":"24.00","total":"300.00","customer_id":"2","address":"523 Brown St","address_2":"","address_id":"3977","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"1111","credit_type":"Visa","email":"ian@750group.com","first_name":"Jane","free_shipping":"1","item_count":"6","last_name":"Doe","order_id":"282","order_type":"Club","override_discount":"90","payment_id":"119","payment_status":"Paid","phone":"707-501-7491","shipping_address":"6484 Winery Street","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"c\/o Acme Vineyards","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"10","shipping_method_carrier":"custom","shipping_method_code":"WILLCALL","shipping_method_name":"Winery Pickup","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"281","zip":"94559","products":[{"id":"282","sku":"12312312312","name":"2011 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"6","status":"","description":"2011 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-11-11 15:37:16"}],"packages":[]},"276":{"id":"276","datestamp":"2014-10-23 10:55:34","status":"","subtotal":"600.00","tax":"40.80","shipping":"40.00","discount":"90.00","credits":"0.00","refund":"0.00","total":"590.80","customer_id":"2","address":"523 Brown St","address_2":"","address_id":"3913","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","customer_credits":"0.00","discount_customer":"0.15","email":"ian@750group.com","first_name":"Jane","item_count":"6","last_name":"Doe","order_id":"276","order_type":"Club","payment_id":"118","payment_status":"Paid","phone":"707-501-7491","sales_agent":"Tyson Caly","shipping_address":"354357357","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"4","shipping_method_carrier":"WCS","shipping_method_code":"FXG","shipping_method_name":"Ground Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"274","zip":"94559","products":[{"id":"276","sku":"322345345","name":"2011 Reserve Cabernet Sauvignon","type":"","price":"100","discount":"0","quantity":"6","status":"","description":"2011 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve","image":"","stock_status":"","shipped":"0","created":"2014-10-23 10:55:34"}],"packages":[]},"264":{"id":"264","datestamp":"2014-09-17 18:51:19","status":"","subtotal":"495.00","tax":"32.00","shipping":"40.00","discount":"95.00","credits":"0.00","refund":"0.00","total":"472.00","customer_id":"2","address":"2210 Tejas Ave","address_2":"","address_id":"3977","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","email":"ian@750group.com","first_name":"Jane","free_shipping":"","item_count":"6","last_name":"Doe","order_id":"264","order_type":"Club","override_discount":"95.00","payment_id":"94","payment_status":"Paid","phone":"707-501-7491","shipping_address":"2210 Tejas Ave","shipping_address_2":"","shipping_city":"Napa","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"4","shipping_method_carrier":"WCS","shipping_method_code":"FXG","shipping_method_name":"Ground Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94559","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"261","zip":"94559","products":[{"id":"264","sku":"AV09NVCS1","name":"2009 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"3","status":"","description":"2009 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-09-17 18:51:19"},{"id":"264","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon ","type":"","price":"100","discount":"0","quantity":"3","status":"","description":"2010 Reserve Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-09-17 18:51:19"}],"packages":[]},"255":{"id":"255","datestamp":"2014-09-12 16:41:17","status":"","subtotal":"2760.00","tax":"220.80","shipping":"0.00","discount":"0.00","credits":"0.00","refund":"0.00","total":"2980.80","customer_id":"2","address":"6484 Washington St.","address_2":"","address_id":"3977","birthday":"1986-04-3","city":"Yountville","company":"","credit_number":"1111","credit_type":"Visa","email":"ian@750group.com","first_name":"Jane","free_shipping":"1","item_count":"36","last_name":"Doe","order_id":"255","order_type":"Club","override_discount":"","payment_id":"92","payment_status":"Paid","phone":"707-501-7491","shipping_address":"6484 Winery Street","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"c\/o Acme Vineyards","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"10","shipping_method_carrier":"custom","shipping_method_code":"WILLCALL","shipping_method_name":"Winery Pickup","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"251","zip":"94599","products":[{"id":"255","sku":"12312312312","name":"2011 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"12","status":"","description":"2011 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-09-12 16:41:17"},{"id":"255","sku":"AV09NVCS1","name":"2009 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"12","status":"","description":"2009 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-09-12 16:41:17"},{"id":"255","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon ","type":"","price":"100","discount":"0","quantity":"12","status":"","description":"2010 Reserve Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-09-12 16:41:17"}],"packages":[]},"236":{"id":"236","datestamp":"2014-08-07 11:56:54","status":"","subtotal":"230.00","tax":"18.40","shipping":"25.00","discount":"0.00","credits":"0.00","refund":"0.00","total":"273.40","customer_id":"2","address":"2210 Tejas Ave","address_2":"","address_id":"3977","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","email":"ian@750group.com","first_name":"Jane","free_shipping":"","item_count":"3","last_name":"Doe","order_id":"236","order_type":"Club","override_discount":"","payment_id":"94","payment_status":"Paid","phone":"707-501-7491","shipping_address":"2210 Tejas Ave","shipping_address_2":"","shipping_city":"Napa","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"4","shipping_method_carrier":"WCS","shipping_method_code":"FXG","shipping_method_name":"Ground Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94559","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"229","zip":"94559","products":[{"id":"236","sku":"12312312312","name":"2011 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"1","status":"","description":"2011 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-08-07 11:56:54"},{"id":"236","sku":"AV09NVCS1","name":"2009 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"1","status":"","description":"2009 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-08-07 11:56:54"},{"id":"236","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon ","type":"","price":"100","discount":"0","quantity":"1","status":"","description":"2010 Reserve Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-08-07 11:56:54"}],"packages":[]},"228":{"id":"228","datestamp":"2014-08-01 10:55:15","status":"","subtotal":"495.00","tax":"39.60","shipping":"0.00","discount":"0.00","credits":"0.00","refund":"0.00","total":"534.60","customer_id":"2","address":"6484 Washington St.","address_2":"","address_id":"3977","birthday":"1986-04-3","city":"Yountville","company":"","credit_number":"1111","credit_type":"Visa","email":"ian@750group.com","first_name":"Jane","free_shipping":"1","item_count":"6","last_name":"Doe","order_id":"228","order_type":"Club","override_discount":"","payment_id":"92","payment_status":"Paid","phone":"707-501-7491","shipping_address":"6484 Winery Street","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"c\/o Acme Vineyards","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"10","shipping_method_carrier":"custom","shipping_method_code":"WILLCALL","shipping_method_name":"Winery Pickup","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"220","zip":"94599","products":[{"id":"228","sku":"AV09NVCS1","name":"2009 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"3","status":"","description":"2009 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-08-01 10:55:15"},{"id":"228","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon ","type":"","price":"100","discount":"0","quantity":"3","status":"","description":"2010 Reserve Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-08-01 10:55:15"}],"packages":[]},"223":{"id":"223","datestamp":"2014-07-25 12:18:08","status":"","subtotal":"720.00","tax":"52.80","shipping":"0.00","discount":"60.00","credits":"0.00","refund":"0.00","total":"712.80","customer_id":"2","address":"6484 Washington St.","address_2":"","address_id":"3913","birthday":"1986-04-3","city":"Yountville","company":"","credit_number":"1111","credit_type":"Visa","email":"ian@750group.com","first_name":"Jane","free_shipping":"1","item_count":"10","last_name":"Doe","order_id":"223","order_type":"Club","override_discount":"60.00","payment_id":"92","payment_status":"Paid","phone":"707-501-7491","shipping_address":"354357357","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"4","shipping_method_carrier":"WCS","shipping_method_code":"FXG","shipping_method_name":"Ground Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"214","zip":"94599","products":[{"id":"223","sku":"454646878","name":"2012 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"6","status":"","description":"2012 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-07-25 12:18:08"},{"id":"223","sku":"555","name":"2011 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"2","status":"","description":"2011 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-07-25 12:18:08"},{"id":"223","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon ","type":"","price":"100","discount":"0","quantity":"2","status":"","description":"2010 Reserve Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-07-25 12:18:08"}],"packages":[]},"210":{"id":"210","datestamp":"2014-07-16 00:45:50","status":"","subtotal":"650.00","tax":"44.20","shipping":"60.00","discount":"97.50","credits":"0.00","refund":"0.00","total":"656.70","customer_id":"2","address":"6484 Washington St.","address_2":"","address_id":"3977","birthday":"1986-04-3","city":"Yountville","company":"","credit_number":"1111","credit_type":"Visa","customer_credits":"0.00","discount_customer":"0.15","email":"ian@750group.com","first_name":"Jane","item_count":"10","last_name":"Doe","order_id":"210","order_type":"Admin","payment_id":"92","payment_status":"Paid","phone":"707-501-7491","requested_ship_date":"07\/30\/2014","sales_agent":"Tyson Caly","shipping_address":"2210 Tejas Ave","shipping_address_2":"","shipping_city":"Napa","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"4","shipping_method_carrier":"WCS","shipping_method_code":"FXG","shipping_method_name":"Ground Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94559","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"201","zip":"94599","products":[{"id":"210","sku":"AV09NVCS1","name":"2009 Cabernet Sauvignon","type":"","price":"65","discount":"0","quantity":"10","status":"","description":"2009 Cabernet Sauvignon Napa Valley","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/AV09NVCS1-1204.jpg","stock_status":"","shipped":"0","created":"2014-07-16 00:45:50"}],"packages":[]},"202":{"id":"202","datestamp":"2014-07-13 15:40:00","status":"","subtotal":"490.00","tax":"0.00","shipping":"0.00","discount":"0.00","credits":"0.00","refund":"0.00","total":"490.00","customer_id":"2","address":"6484 Washington St.","address_2":"","address_id":"3913","birthday":"1986-04-3","city":"Yountville","company":"","credit_number":"1111","credit_type":"Visa","email":"ian@750group.com","first_name":"Jane","free_shipping":"1","item_count":"7","last_name":"Doe","order_id":"202","order_type":"Club","override_discount":"","payment_id":"92","payment_status":"Paid","phone":"707-501-7491","shipping_address":"354357357","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"4","shipping_method_carrier":"WCS","shipping_method_code":"FXG","shipping_method_name":"Ground Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_exempt":"1","tax_rate":"0","transaction_id":"193","zip":"94599","products":[{"id":"202","sku":"AV09NVCS1","name":"2009 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"6","status":"","description":"2009 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-07-13 15:40:00"},{"id":"202","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon ","type":"","price":"100","discount":"0","quantity":"1","status":"","description":"2010 Reserve Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-07-13 15:40:00"}],"packages":[]},"196":{"id":"196","datestamp":"2014-07-09 20:15:10","status":"","subtotal":"130.00","tax":"8.80","shipping":"0.00","discount":"20.00","credits":"0.00","refund":"0.00","total":"118.80","customer_id":"2","address":"2210 Tejas Ave","address_2":"","address_id":"3977","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","email":"ian@750group.com","first_name":"Jane","free_shipping":"1","item_count":"2","last_name":"Doe","order_id":"196","order_type":"Club","override_discount":"20.00","payment_id":"94","payment_status":"Paid","phone":"707-501-7491","shipping_address":"2210 Tejas Ave","shipping_address_2":"","shipping_city":"Napa","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"4","shipping_method_carrier":"WCS","shipping_method_code":"FXG","shipping_method_name":"Ground Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_zip":"94559","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"188","zip":"94559","products":[{"id":"196","sku":"454646878","name":"2012 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"1","status":"","description":"2012 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-07-09 20:15:10"},{"id":"196","sku":"AV09NVCS1","name":"2009 Cabernet Sauvignon ","type":"","price":"65","discount":"0","quantity":"1","status":"","description":"2009 Cabernet Sauvignon ","image":"","stock_status":"","shipped":"0","created":"2014-07-09 20:15:10"}],"packages":[]},"195":{"id":"195","datestamp":"2014-07-08 22:41:20","status":"","subtotal":"790.00","tax":"53.72","shipping":"60.00","discount":"118.50","credits":"0.00","refund":"0.00","total":"785.22","customer_id":"2","address":"2210 Tejas Ave","address_2":"","address_id":"3913","birthday":"1986-04-3","city":"Napa","company":"","credit_number":"8431","credit_type":"American Express","customer_credits":"0.00","discount_customer":"0.15","email":"ian@750group.com","first_name":"Jane","gift_message":"","instructions":"","item_count":"10","last_name":"Doe","order_id":"195","payment_id":"94","payment_status":"Paid","phone":"707-501-7491","shipping_address":"354357357","shipping_address_2":"","shipping_city":"Yountville","shipping_company":"","shipping_first_name":"Jane","shipping_last_name":"Doe","shipping_method":"3","shipping_method_carrier":"WCS","shipping_method_code":"FXO","shipping_method_id":"3","shipping_method_name":"Expedited Shipping","shipping_phone":"7075017491","shipping_state":"CA","shipping_title":"ShippingAddress","shipping_zip":"94599","ship_status":"Shipped","state":"CA","tax_rate":"8","transaction_id":"187","zip":"94559","products":[{"id":"195","sku":"AV09NVCS1","name":"2009 Cabernet Sauvignon","type":"","price":"65","discount":"0","quantity":"6","status":"","description":"2009 Cabernet Sauvignon Napa Valley","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/AV09NVCS1-1204.jpg","stock_status":"","shipped":"0","created":"2014-07-08 22:41:20"},{"id":"195","sku":"AV10NVRCS","name":"2010 Reserve Cabernet Sauvignon","type":"","price":"100","discount":"0","quantity":"4","status":"","description":"2010 Reserve Cabernet Sauvignon Napa Valley, Small Lot Reserve","image":"\/\/s3.amazonaws.com\/efcheckout\/acmev\/product\/AV10NVRCS-3914.jpg","stock_status":"","shipped":"0","created":"2014-07-08 22:41:20"}],"packages":[]}

GiftCard

Resources related to GiftCard.

GET /gift_cards/{code} Get Gift Card by Code

Parameters

Name	Type	Required	Description	Example
code	string	Required	Gift Card Code

Examples

Request

GET/gift_cards/{code}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{"balance": 100.00, "code": "ABC-123-XYZ-987", status": "Active"}

Inventory

Resources related to Inventory.

GET /inventory Get Available Inventory

Examples

Request

GET/inventory

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "AV09NVCS": "0",
    "AV09NVCS1": -3,
    "AV09NVCH": "0",
    "AV10NVRB": 3,
    "AV08NVCH": "0",
    "AV10NVRCS": 3983,
    "asdfasdf": "1000",
    "875433": "999",
    "2011asdfasdfsad": "994",
    "12312312312": 11971,
    "123124214": "894",
    "11111": "997",
    "454646878": "467",
    "555": "840",
    "5398": "76",
    "asdfasdfasdf": "0",
    "78DHU": 38,
    "322345345": "304",
    "a123123123123": "591",
    "asdfasdfasdfadsf": "0",
    "ti6r7r76f": "419",
    "ANNUAL": "10000",
    "5876987": "893",
    "123123213123123213": 599,
    "212nvcs": 651,
    "AV11NVRCS": "499",
    "sdfadfasdfds": "600",
    "asdfasdf323": "12000",
    "asdfasdfasdfas": "9000",
    "as3423423": "6",
    "yyuhjij": "842"
}

Payment

Resources related to Payment.

GET /payment/default Get Default Payment Method

Examples

Request

GET/payment/default

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "6",
    "account_token": "cus_6wjTTC7pSoC6da",
    "payment_token": "card_6wjTDZSCFXFoqj",
    "credit_type": "Visa",
    "credit_number": "5125",
    "credit_expires_month": "7",
    "credit_expires_year": "2018",
    "account_uri": "",
    "card_uri": "",
    "profile_id": "0",
    "payment_profile_id": "0",
    "first_name": "Jane",
    "birthday": "",
    "phone": "",
    "company": "",
    "last_name": "Doe",
    "address": "2210 Tejas Ave",
    "address_2": "",
    "city": "Napa",
    "state": "CA",
    "zip": "94559",
    "customer_id": "2",
    "default": "1",
    "created": "2015-09-08 10:35:41"
}

PUT /payment/default Set Default Payment Method

Examples

Request

PUT/payment/default

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

"4083"

Response

Headers · 200

Content-Type: application/json

Body

true

POST /payment Create Payment Method

Parameters

Name	Type	Required	Description
address	string	Required	Street Address
address_2	string	Optional	Unit Number
card_token	string	Required	Stripe Credit Card Token
city	string	Required	City
credit_expires_month	string	Required	Expires Month ie: 06
credit_expires_year	string	Required	Expires Year ie: 2016
credit_number	string	Required	Last 4 Digits of Credit Card Number
credit_type	string	Required	Credit Card Brand ie: Visa, American Express, etc
first_name	string	Required	Customer First Name
last_name	string	Required	Customer Last Name
phone	string	Optional	Customer Phone Number
state	string	Required	State
stripe_payment_method	string	Required	Stripe Payment Method Id
zip	string	Required	Zip Code

Examples

Request

POST/payment

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{
    "first_name": "Jane",
    "last_name": "Doe",
    "address": "523 Brown St",
    "city": "Napa",
    "state": "CA",
    "zip": "94559",
    "address_2": "",
    "phone": "707-501-7491",
    "card_token": "XXXXXXXXXXXX",
    "credit_type": "American Express",
    "credit_expires_month": "06",
    "credit_expires_year": "2018",
    "credit_number": "1234"
}

Response

Headers · 200

Content-Type: application/json

Body

"4093"

DELETE /payment/{id} Delete Payment Method

Parameters

Name	Type	Required	Description	Example
id	number	Required	Payment Id

Examples

Request

DELETE/payment/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

GET /stripe/elements/payment_intent Get Client Secret for Stripe Elements

Examples

Request

GET/stripe/elements/payment_intent

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

pi_xxxxxxxx_secret_xxxxxxxx

GET /payment Get List of Payment Methods

Examples

Request

GET/payment

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "6": {
        "id": "6",
        "account_token": "cus_6wjTTC7pSoC6da",
        "payment_token": "card_6wjTDZSCFXFoqj",
        "credit_type": "Visa",
        "credit_number": "5125",
        "credit_expires_month": "7",
        "credit_expires_year": "2018",
        "account_uri": "",
        "card_uri": "",
        "profile_id": "0",
        "payment_profile_id": "0",
        "first_name": "Jane",
        "birthday": "",
        "phone": "",
        "company": "",
        "last_name": "Doe",
        "address": "2210 Tejas Ave",
        "address_2": "",
        "city": "Napa",
        "state": "CA",
        "zip": "94559",
        "customer_id": "2",
        "default": "1",
        "created": "2015-09-08 10:35:41"
    }
}

GET /payment/{id} Get Payment Details

Parameters

Name	Type	Required	Description	Example
id	number	Required	Payment Id

Examples

Request

GET/payment/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "6",
    "account_token": "cus_6wjTTC7pSoC6da",
    "payment_token": "card_6wjTDZSCFXFoqj",
    "credit_type": "Visa",
    "credit_number": "5125",
    "credit_expires_month": "7",
    "credit_expires_year": "2018",
    "account_uri": "",
    "card_uri": "",
    "profile_id": "0",
    "payment_profile_id": "0",
    "first_name": "Jane",
    "birthday": "",
    "phone": "",
    "company": "",
    "last_name": "Doe",
    "address": "2210 Tejas Ave",
    "address_2": "",
    "city": "Napa",
    "state": "CA",
    "zip": "94559",
    "customer_id": "2",
    "default": "1",
    "created": "2015-09-08 10:35:41"
}

PUT /payment/{id} Update Payment Method

Parameters

Name	Type	Required	Description	Example
id	number	Required	Payment Id

Examples

Request

PUT/payment/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Body

{"first_name: "John", "last_name": "Doe"}

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "6",
    "account_token": "cus_6wjTTC7pSoC6da",
    "payment_token": "card_6wjTDZSCFXFoqj",
    "credit_type": "Visa",
    "credit_number": "5125",
    "credit_expires_month": "7",
    "credit_expires_year": "2018",
    "account_uri": "",
    "card_uri": "",
    "profile_id": "0",
    "payment_profile_id": "0",
    "first_name": "John",
    "birthday": "",
    "phone": "",
    "company": "",
    "last_name": "Doe",
    "address": "2210 Tejas Ave",
    "address_2": "",
    "city": "Napa",
    "state": "CA",
    "zip": "94559",
    "customer_id": "2",
    "default": "1",
    "created": "2015-09-08 10:35:41"
}

Products

Resources related to Products.

GET /products/featured Get Featured Products

Examples

Request

GET/products/featured

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "3": {
        "id": "3",
        "name": "2009 Cabernet Sauvignon",
        "sku": "AV09NVCS1",
        "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"
    },
    "5": {
        "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"
    },
    "7": {
        "id": "7",
        "name": "2010 Reserve Cabernet Sauvignon",
        "sku": "AV10NVRCS",
        "price": "75.00",
        "description": "",
        "status": "Archived",
        "accolades_01": "",
        "additional_description": "\"This is one of my all-time favorite $100 bottles of wine.\"<br>—Wine Reviewer",
        "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": "46",
        "cost": "60.00",
        "country": "",
        "custom01": "",
        "custom02": "",
        "custom03": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2010",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRCS-3914.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/products/alt/AV10NVRCS-1165.jpg",
        "label": "",
        "max_purchase_quantity": "",
        "min_purchase_quantity": "3",
        "new_product": "Yes",
        "not_availible_message": "Sorry this item is not available for purchase.",
        "no_comparison": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "product_category": "Wine",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 2012",
        "residual_sugar": "",
        "retail_price": "80.00",
        "shipping_offer_min": "",
        "short_description": "",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley, Small Lot Reserve",
        "sub_region": "",
        "ta": "",
        "tasting_notes_pdf": "",
        "tax_exempt": "0",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Sparrow",
        "vintage": "2010",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": {
            "1": {
                "id": "1",
                "name": "New Releases",
                "sort": "1"
            }
        },
        "quantity": "4000"
    },
    "14": {
        "id": "14",
        "name": "2014 Rosé",
        "sku": "12312312312",
        "price": "45",
        "description": "<em>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.</em> <br><br>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.  <strong>Drink now or age for up to 50 years.</strong>",
        "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": "",
        "case_production": "60",
        "cost": "0.00",
        "country": "",
        "custom01": "",
        "custom02": "",
        "custom03": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
        "label": "",
        "max_purchase_quantity": "36",
        "min_purchase_quantity": "",
        "not_availible_message": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "product_category": "Wine",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 1, 2012",
        "residual_sugar": "",
        "retail_price": "65.00",
        "review": "Hello",
        "reviewer": "Acme",
        "score": "99",
        "shipping_included": "0",
        "shipping_offer_min": "",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
        "soil": "",
        "stainless": "",
        "starting_quantity": "99",
        "status_availability": "Active",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": ".06",
        "tasting_notes_pdf": "",
        "tax_exempt": "0",
        "upc": "",
        "varietal": "",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": {
            "1": {
                "id": "1",
                "name": "New Releases",
                "sort": "2"
            }
        },
        "quantity": "12000"
    },
    "17": {
        "id": "17",
        "name": "2012 Cabernet Sauvignon",
        "sku": "454646878",
        "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": "Archived",
        "accolades_01": "",
        "additional_description": "<strong>\"Unreal. A Napa Valley Cab that is truly worthy drinking.\"</strong><br>—Wine Review Online",
        "aging": "18 Months in French Barrels",
        "alcohol": "16.5",
        "appellation": "Oakville, Napa Valley",
        "blend": "100% Cabernet Sauvignon",
        "bottle_count": "3",
        "bottle_size": "",
        "case_production": "60",
        "country": "",
        "custom01": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "max_purchase_quantity": "",
        "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",
        "shipping_offer_min": "",
        "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": "",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "467"
    },
    "20": {
        "id": "20",
        "name": "2011 Cabernet Sauvignon",
        "sku": "555",
        "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": "Archived",
        "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": "",
        "bottle_size": "",
        "case_production": "60",
        "country": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "max_purchase_quantity": "",
        "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",
        "review": "Hellooo",
        "reviewer": "Acme",
        "score": "98",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": ".06",
        "upc": "",
        "varietal": "",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "840"
    },
    "22": {
        "id": "22",
        "name": "2012 Cabernet Sauvignon",
        "sku": "asdfasdfasdf",
        "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": "Archived",
        "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": "",
        "case_production": "60",
        "country": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "max_purchase_quantity": "36",
        "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",
        "review": "Hello",
        "reviewer": "Acme",
        "score": "99",
        "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": "",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": {
            "1": {
                "id": "1",
                "name": "New Releases",
                "sort": "3"
            }
        },
        "quantity": "0"
    },
    "24": {
        "id": "24",
        "name": "2011 Reserve Cabernet Sauvignon",
        "sku": "322345345",
        "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. \r\n\r\nLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "status": "Archived",
        "accolades_01": "",
        "additional_description": "\"This is one of my all-time favorite $100 bottles of wine.\"<br>—Wine Reviewer",
        "aging": "18 Months in French Barrels",
        "alcohol": "16.5",
        "appellation": "Oakville, Napa Valley",
        "blend": "100% Cabernet Sauvignon",
        "bottle_count": "",
        "bottle_size": "",
        "case_production": "46",
        "country": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2010",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "max_purchase_quantity": "",
        "new_product": "Yes",
        "not_availible_message": "Next release coming Spring 2015",
        "no_comparison": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 2012",
        "residual_sugar": "",
        "retail_price": "125.00",
        "shipping_offer_min": "",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley, Small Lot Reserve",
        "sub_region": "",
        "ta": "",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Sparrow",
        "vintage": "2010",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "304"
    },
    "31": {
        "id": "31",
        "name": "2014 Reserve Cabernet Sauvignon",
        "sku": "123123213123123213",
        "price": "80.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. \r\n\r\nLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "\"This is one of my all-time favorite $100 bottles of wine.\"<br>—Wine Reviewer",
        "aging": "18 Months in French Barrels",
        "alcohol": "16.5",
        "appellation": "Oakville, Napa Valley",
        "blend": "100% Cabernet Sauvignon",
        "bottle_count": "5",
        "bottle_size": "750mL",
        "case_production": "46",
        "country": "",
        "custom01": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2010",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "max_purchase_quantity": "",
        "new_product": "Yes",
        "not_availible_message": "Sorry this item is not available for purchase.",
        "no_comparison": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 2012",
        "residual_sugar": "",
        "retail_price": "100.00",
        "shipping_offer_min": "",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley, Small Lot Reserve",
        "sub_region": "",
        "ta": "",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Sparrow",
        "vintage": "2010",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "603"
    },
    "32": {
        "id": "32",
        "name": "2012 Reserve Cabernet Sauvignon",
        "sku": "212nvcs",
        "price": "80.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. \r\n\r\nLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "\"This is one of my all-time favorite $100 bottles of wine.\"<br>—Wine Reviewer",
        "aging": "18 Months in French Barrels",
        "alcohol": "16.5",
        "appellation": "Oakville, Napa Valley",
        "blend": "100% Cabernet Sauvignon",
        "bottle_count": "3",
        "bottle_size": "750mL",
        "case_production": "46",
        "country": "",
        "custom01": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2010",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "max_purchase_quantity": "",
        "new_product": "Yes",
        "not_availible_message": "Sorry this item is not available for purchase.",
        "no_comparison": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 2012",
        "residual_sugar": "",
        "retail_price": "100.00",
        "shipping_offer_min": "",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley, Small Lot Reserve",
        "sub_region": "",
        "ta": "",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Sparrow",
        "vintage": "2010",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "653"
    },
    "33": {
        "id": "33",
        "name": "2011 Reserve Cabernet Sauvignon",
        "sku": "AV11NVRCS",
        "price": "80.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. \r\n\r\nLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "\"This is one of my all-time favorite $100 bottles of wine.\"<br>—Wine Reviewer",
        "aging": "18 Months in French Barrels",
        "alcohol": "16.5",
        "appellation": "Oakville, Napa Valley",
        "blend": "100% Cabernet Sauvignon",
        "bottle_count": "3",
        "bottle_size": "750mL",
        "case_production": "46",
        "country": "",
        "custom01": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2010",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "max_purchase_quantity": "",
        "new_product": "Yes",
        "not_availible_message": "Sorry this item is not available for purchase.",
        "no_comparison": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 2012",
        "residual_sugar": "",
        "retail_price": "100.00",
        "shipping_offer_min": "",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley, Small Lot Reserve",
        "sub_region": "",
        "ta": "",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Sparrow",
        "vintage": "2010",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "499"
    },
    "34": {
        "id": "34",
        "name": "2011 Reserve Cabernet Sauvignon",
        "sku": "sdfadfasdfds",
        "price": "75.00",
        "description": "",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "\"This is one of my all-time favorite $100 bottles of wine.\"<br>—Wine Reviewer",
        "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": "46",
        "cost": "60.00",
        "country": "",
        "custom01": "",
        "custom02": "",
        "custom03": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2010",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "label": "",
        "max_purchase_quantity": "",
        "min_purchase_quantity": "3",
        "new_product": "Yes",
        "not_availible_message": "Sorry this item is not available for purchase.",
        "no_comparison": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "product_category": "Wine",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 2012",
        "residual_sugar": "",
        "retail_price": "80.00",
        "shipping_offer_min": "",
        "short_description": "",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley, Small Lot Reserve",
        "sub_region": "",
        "ta": "",
        "tasting_notes_pdf": "",
        "tax_exempt": "0",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Sparrow",
        "vintage": "2010",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "600"
    },
    "35": {
        "id": "35",
        "name": "2011 Reserve Cabernet Sauvignon",
        "sku": "asdfasdf323",
        "price": "75.00",
        "description": "",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "\"This is one of my all-time favorite $100 bottles of wine.\"<br>—Wine Reviewer",
        "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": "46",
        "cost": "60.00",
        "country": "",
        "custom01": "",
        "custom02": "",
        "custom03": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2010",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "label": "",
        "max_purchase_quantity": "",
        "min_purchase_quantity": "3",
        "new_product": "Yes",
        "not_availible_message": "Sorry this item is not available for purchase.",
        "no_comparison": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "product_category": "Wine",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 2012",
        "residual_sugar": "",
        "retail_price": "80.00",
        "shipping_offer_min": "",
        "short_description": "",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley, Small Lot Reserve",
        "sub_region": "",
        "ta": "",
        "tasting_notes_pdf": "",
        "tax_exempt": "0",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Sparrow",
        "vintage": "2010",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "12000"
    },
    "36": {
        "id": "36",
        "name": "2012 Reserve Cabernet Sauvignon",
        "sku": "asdfasdfasdfas",
        "price": "75.00",
        "description": "",
        "status": "Active",
        "accolades_01": "",
        "additional_description": "\"This is one of my all-time favorite $100 bottles of wine.\"<br>—Wine Reviewer",
        "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": "46",
        "cost": "60.00",
        "country": "",
        "custom01": "",
        "custom02": "",
        "custom03": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2010",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "label": "",
        "max_purchase_quantity": "",
        "min_purchase_quantity": "3",
        "new_product": "Yes",
        "not_availible_message": "Sorry this item is not available for purchase.",
        "no_comparison": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "product_category": "Wine",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 2012",
        "residual_sugar": "",
        "retail_price": "80.00",
        "shipping_offer_min": "",
        "short_description": "",
        "soil": "",
        "starting_quantity": "99",
        "status_availability": "",
        "subtitle": "Napa Valley, Small Lot Reserve",
        "sub_region": "",
        "ta": "",
        "tasting_notes_pdf": "",
        "tax_exempt": "0",
        "upc": "",
        "varietal": "CABERNET_BLENDS",
        "vineyard": "Black Sparrow",
        "vintage": "2010",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "9000"
    },
    "38": {
        "id": "38",
        "name": "2015 Rosé",
        "sku": "yyuhjij",
        "price": "65",
        "description": "<em>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.</em> <br><br>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.  <strong>Drink now or age for up to 50 years.</strong>",
        "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": "",
        "case_production": "60",
        "cost": "0.00",
        "country": "",
        "custom01": "",
        "custom02": "",
        "custom03": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "",
        "image_alt": "",
        "image_alt_3": "",
        "label": "",
        "max_purchase_quantity": "36",
        "min_purchase_quantity": "",
        "not_availible_message": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "product_category": "Wine",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 1, 2012",
        "residual_sugar": "",
        "retail_price": "0.00",
        "review": "Hello",
        "reviewer": "Acme",
        "score": "99",
        "shipping_offer_min": "",
        "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",
        "tasting_notes_pdf": "",
        "tax_exempt": "0",
        "upc": "",
        "varietal": "",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": [],
        "quantity": "842"
    }
}

GET /categories/{id}/first_product Get First Product In Category Queue

Parameters

Name	Type	Required	Description	Example
id	number	Required	Category Id

Examples

Request

GET/categories/{id}/first_product

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "1",
    "name": "2013 Luna Wine Example",
    "sku": "13EXWINE",
    "price": "65",
    "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
    "status": "Active",
    "accolades_01": "",
    "additional_description": "Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
    "aging": "",
    "alcohol": "14.1",
    "appellation": "Napa Valley",
    "best_web": "85.00",
    "blend": "100% Cabernet Sauvignon",
    "bottle_count": "1",
    "bottle_size": "750mL",
    "case_production": "300",
    "country": "",
    "custom01": "",
    "farming_method": "",
    "free_shipping": "",
    "harvest_date": "",
    "image": "//s3.amazonaws.com/efcheckout/apppress/products/13EXWINE-5621.jpg",
    "image_zoom": "//s3.amazonaws.com/efcheckout/apppress/products/zoom/13EXWINE-9604.jpg",
    "location": "",
    "max_purchase_quantity": "36",
    "not_availible_message": "",
    "oak": "100% French",
    "ph": "",
    "qb_account": "",
    "qb_class": "",
    "qb_sku": "",
    "region": "",
    "release_date": "",
    "residual_sugar": "",
    "retail_price": "100.00",
    "shipping_offer_min": "4",
    "short_description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
    "soil": "",
    "source": "",
    "starting_quantity": "1000",
    "status_availability": "Active",
    "subtitle": "",
    "sub_region": "",
    "ta": "",
    "upc": "",
    "varietal": "CABERNET_BLENDS",
    "vineyard": "",
    "vintage": "2013",
    "winemaker": "",
    "wine_type": "RED",
    "categories": {
        "1": {
            "id": "1",
            "name": "Live",
            "sort": "1"
        }
    },
    "quantity": "500",
    "reviews": [
        {
            "score": "93",
            "reviewer": "Grant G.",
            "review": "Irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
        },
        {
            "score": "92",
            "reviewer": "Tyson C.",
            "review": "Consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit."
        }
    ]
}

GET /products/ Get List of Available Products

Examples

Request

GET/products/

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{"3":{"id":"3","name":"2009 Cabernet Sauvignon","sku":"AV09NVCS1","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>u2014Wine 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"},"5":{"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>u2014Wine 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"},"7":{"id":"7","name":"2010 Reserve Cabernet Sauvignon","sku":"AV10NVRCS","price":"75.00","description":"","status":"Archived","accolades_01":"","additional_description":""This is one of my all-time favorite $100 bottles of wine."<br>u2014Wine Reviewer","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":"46","cost":"60.00","country":"","custom01":"","custom02":"","custom03":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2010","image":"//s3.amazonaws.com/efcheckout/acmev/product/AV10NVRCS-3914.jpg","image_alt":"//s3.amazonaws.com/efcheckout/acmev/products/alt/AV10NVRCS-1165.jpg","label":"","max_purchase_quantity":"","min_purchase_quantity":"3","new_product":"Yes","not_availible_message":"Sorry this item is not available for purchase.","no_comparison":"","oak":"40% new, 60% 2 year old","ph":"","product_category":"Wine","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 2012","residual_sugar":"","retail_price":"80.00","shipping_offer_min":"","short_description":"","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley, Small Lot Reserve","sub_region":"","ta":"","tasting_notes_pdf":"","tax_exempt":"0","upc":"","varietal":"CABERNET_BLENDS","vineyard":"Black Sparrow","vintage":"2010","winemaker":"Pepe LePepe","wine_type":"RED","categories":{"1":{"id":"1","name":"New Releases","sort":"1"}},"quantity":"4000"},"14":{"id":"14","name":"2014 Rosu00e9","sku":"12312312312","price":"45","description":"<em>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.</em> <br><br>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.  <strong>Drink now or age for up to 50 years.</strong>","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":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"1","bottle_size":"","case_production":"60","cost":"0.00","country":"","custom01":"","custom02":"","custom03":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2007","image":"//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg","image_alt":"//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg","label":"","max_purchase_quantity":"36","min_purchase_quantity":"","not_availible_message":"","oak":"40% new, 60% 2 year old","ph":"","product_category":"Wine","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 1, 2012","residual_sugar":"","retail_price":"65.00","review":"Hello","reviewer":"Acme","score":"99","shipping_included":"0","shipping_offer_min":"","short_description":"Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.","soil":"","stainless":"","starting_quantity":"99","status_availability":"Active","subtitle":"Napa Valley","sub_region":"","ta":".06","tasting_notes_pdf":"","tax_exempt":"0","upc":"","varietal":"","vineyard":"Black Hawk","vintage":"2007","winemaker":"Pepe LePepe","wine_type":"RED","categories":{"1":{"id":"1","name":"New Releases","sort":"2"}},"quantity":"12000"},"17":{"id":"17","name":"2012 Cabernet Sauvignon","sku":"454646878","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":"Archived","accolades_01":"","additional_description":"<strong>"Unreal. A Napa Valley Cab that is truly worthy drinking."</strong><br>u2014Wine Review Online","aging":"18 Months in French Barrels","alcohol":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"3","bottle_size":"","case_production":"60","country":"","custom01":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2007","image":"","image_alt":"","image_alt_3":"","max_purchase_quantity":"","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","shipping_offer_min":"","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":"","vineyard":"Black Hawk","vintage":"2007","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"467"},"20":{"id":"20","name":"2011 Cabernet Sauvignon","sku":"555","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":"Archived","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":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"","bottle_size":"","case_production":"60","country":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2007","image":"","image_alt":"","image_alt_3":"","max_purchase_quantity":"","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","review":"Hellooo","reviewer":"Acme","score":"98","short_description":"Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley","sub_region":"","ta":".06","upc":"","varietal":"","vineyard":"Black Hawk","vintage":"2007","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"840"},"22":{"id":"22","name":"2012 Cabernet Sauvignon","sku":"asdfasdfasdf","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":"Archived","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":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"1","bottle_size":"","case_production":"60","country":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2007","image":"","image_alt":"","image_alt_3":"","max_purchase_quantity":"36","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","review":"Hello","reviewer":"Acme","score":"99","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":"","vineyard":"Black Hawk","vintage":"2007","winemaker":"Pepe LePepe","wine_type":"RED","categories":{"1":{"id":"1","name":"New Releases","sort":"3"}},"quantity":"0"},"24":{"id":"24","name":"2011 Reserve Cabernet Sauvignon","sku":"322345345","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. rnrnLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.","status":"Archived","accolades_01":"","additional_description":""This is one of my all-time favorite $100 bottles of wine."<br>u2014Wine Reviewer","aging":"18 Months in French Barrels","alcohol":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"","bottle_size":"","case_production":"46","country":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2010","image":"","image_alt":"","image_alt_3":"","max_purchase_quantity":"","new_product":"Yes","not_availible_message":"Next release coming Spring 2015","no_comparison":"","oak":"40% new, 60% 2 year old","ph":"","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 2012","residual_sugar":"","retail_price":"125.00","shipping_offer_min":"","short_description":"Destined to be a classic example of an outstanding vintage from the legendary Napa Valley","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley, Small Lot Reserve","sub_region":"","ta":"","upc":"","varietal":"CABERNET_BLENDS","vineyard":"Black Sparrow","vintage":"2010","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"304"},"31":{"id":"31","name":"2014 Reserve Cabernet Sauvignon","sku":"123123213123123213","price":"80.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. rnrnLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.","status":"Active","accolades_01":"","additional_description":""This is one of my all-time favorite $100 bottles of wine."<br>u2014Wine Reviewer","aging":"18 Months in French Barrels","alcohol":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"5","bottle_size":"750mL","case_production":"46","country":"","custom01":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2010","image":"","image_alt":"","image_alt_3":"","max_purchase_quantity":"","new_product":"Yes","not_availible_message":"Sorry this item is not available for purchase.","no_comparison":"","oak":"40% new, 60% 2 year old","ph":"","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 2012","residual_sugar":"","retail_price":"100.00","shipping_offer_min":"","short_description":"Destined to be a classic example of an outstanding vintage from the legendary Napa Valley","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley, Small Lot Reserve","sub_region":"","ta":"","upc":"","varietal":"CABERNET_BLENDS","vineyard":"Black Sparrow","vintage":"2010","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"603"},"32":{"id":"32","name":"2012 Reserve Cabernet Sauvignon","sku":"212nvcs","price":"80.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. rnrnLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.","status":"Active","accolades_01":"","additional_description":""This is one of my all-time favorite $100 bottles of wine."<br>u2014Wine Reviewer","aging":"18 Months in French Barrels","alcohol":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"3","bottle_size":"750mL","case_production":"46","country":"","custom01":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2010","image":"","image_alt":"","image_alt_3":"","max_purchase_quantity":"","new_product":"Yes","not_availible_message":"Sorry this item is not available for purchase.","no_comparison":"","oak":"40% new, 60% 2 year old","ph":"","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 2012","residual_sugar":"","retail_price":"100.00","shipping_offer_min":"","short_description":"Destined to be a classic example of an outstanding vintage from the legendary Napa Valley","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley, Small Lot Reserve","sub_region":"","ta":"","upc":"","varietal":"CABERNET_BLENDS","vineyard":"Black Sparrow","vintage":"2010","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"653"},"33":{"id":"33","name":"2011 Reserve Cabernet Sauvignon","sku":"AV11NVRCS","price":"80.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. rnrnLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.","status":"Active","accolades_01":"","additional_description":""This is one of my all-time favorite $100 bottles of wine."<br>u2014Wine Reviewer","aging":"18 Months in French Barrels","alcohol":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"3","bottle_size":"750mL","case_production":"46","country":"","custom01":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2010","image":"","image_alt":"","image_alt_3":"","max_purchase_quantity":"","new_product":"Yes","not_availible_message":"Sorry this item is not available for purchase.","no_comparison":"","oak":"40% new, 60% 2 year old","ph":"","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 2012","residual_sugar":"","retail_price":"100.00","shipping_offer_min":"","short_description":"Destined to be a classic example of an outstanding vintage from the legendary Napa Valley","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley, Small Lot Reserve","sub_region":"","ta":"","upc":"","varietal":"CABERNET_BLENDS","vineyard":"Black Sparrow","vintage":"2010","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"499"},"34":{"id":"34","name":"2011 Reserve Cabernet Sauvignon","sku":"sdfadfasdfds","price":"75.00","description":"","status":"Active","accolades_01":"","additional_description":""This is one of my all-time favorite $100 bottles of wine."<br>u2014Wine Reviewer","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":"46","cost":"60.00","country":"","custom01":"","custom02":"","custom03":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2010","image":"","image_alt":"","image_alt_3":"","label":"","max_purchase_quantity":"","min_purchase_quantity":"3","new_product":"Yes","not_availible_message":"Sorry this item is not available for purchase.","no_comparison":"","oak":"40% new, 60% 2 year old","ph":"","product_category":"Wine","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 2012","residual_sugar":"","retail_price":"80.00","shipping_offer_min":"","short_description":"","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley, Small Lot Reserve","sub_region":"","ta":"","tasting_notes_pdf":"","tax_exempt":"0","upc":"","varietal":"CABERNET_BLENDS","vineyard":"Black Sparrow","vintage":"2010","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"600"},"35":{"id":"35","name":"2011 Reserve Cabernet Sauvignon","sku":"asdfasdf323","price":"75.00","description":"","status":"Active","accolades_01":"","additional_description":""This is one of my all-time favorite $100 bottles of wine."<br>u2014Wine Reviewer","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":"46","cost":"60.00","country":"","custom01":"","custom02":"","custom03":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2010","image":"","image_alt":"","image_alt_3":"","label":"","max_purchase_quantity":"","min_purchase_quantity":"3","new_product":"Yes","not_availible_message":"Sorry this item is not available for purchase.","no_comparison":"","oak":"40% new, 60% 2 year old","ph":"","product_category":"Wine","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 2012","residual_sugar":"","retail_price":"80.00","shipping_offer_min":"","short_description":"","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley, Small Lot Reserve","sub_region":"","ta":"","tasting_notes_pdf":"","tax_exempt":"0","upc":"","varietal":"CABERNET_BLENDS","vineyard":"Black Sparrow","vintage":"2010","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"12000"},"36":{"id":"36","name":"2012 Reserve Cabernet Sauvignon","sku":"asdfasdfasdfas","price":"75.00","description":"","status":"Active","accolades_01":"","additional_description":""This is one of my all-time favorite $100 bottles of wine."<br>u2014Wine Reviewer","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":"46","cost":"60.00","country":"","custom01":"","custom02":"","custom03":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2010","image":"","image_alt":"","image_alt_3":"","label":"","max_purchase_quantity":"","min_purchase_quantity":"3","new_product":"Yes","not_availible_message":"Sorry this item is not available for purchase.","no_comparison":"","oak":"40% new, 60% 2 year old","ph":"","product_category":"Wine","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 2012","residual_sugar":"","retail_price":"80.00","shipping_offer_min":"","short_description":"","soil":"","starting_quantity":"99","status_availability":"","subtitle":"Napa Valley, Small Lot Reserve","sub_region":"","ta":"","tasting_notes_pdf":"","tax_exempt":"0","upc":"","varietal":"CABERNET_BLENDS","vineyard":"Black Sparrow","vintage":"2010","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"9000"},"38":{"id":"38","name":"2015 Rosu00e9","sku":"yyuhjij","price":"65","description":"<em>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.</em> <br><br>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.  <strong>Drink now or age for up to 50 years.</strong>","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":"16.5","appellation":"Oakville, Napa Valley","blend":"100% Cabernet Sauvignon","bottle_count":"1","bottle_size":"","case_production":"60","cost":"0.00","country":"","custom01":"","custom02":"","custom03":"","farming_method":"","featured_product":"Yes","free_shipping":"","harvest_date":"October 19, 2007","image":"","image_alt":"","image_alt_3":"","label":"","max_purchase_quantity":"36","min_purchase_quantity":"","not_availible_message":"","oak":"40% new, 60% 2 year old","ph":"","product_category":"Wine","qb_account":"","qb_class":"","qb_sku":"","region":"","release_date":"September 1, 2012","residual_sugar":"","retail_price":"0.00","review":"Hello","reviewer":"Acme","score":"99","shipping_offer_min":"","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","tasting_notes_pdf":"","tax_exempt":"0","upc":"","varietal":"","vineyard":"Black Hawk","vintage":"2007","winemaker":"Pepe LePepe","wine_type":"RED","categories":[],"quantity":"842"}}

GET /categories/{id}/products Get List of Products By Category

Parameters

Name	Type	Required	Description	Example
id	number	Required	Category Id

Examples

Request

GET/categories/{id}/products

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "14": {
        "id": "14",
        "name": "2014 Rosé",
        "sku": "12312312312",
        "price": "45",
        "description": "<em>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.</em> <br><br>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.  <strong>Drink now or age for up to 50 years.</strong>",
        "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": "",
        "case_production": "60",
        "cost": "0.00",
        "country": "",
        "custom01": "",
        "custom02": "",
        "custom03": "",
        "farming_method": "",
        "featured_product": "Yes",
        "free_shipping": "",
        "harvest_date": "October 19, 2007",
        "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
        "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
        "label": "",
        "max_purchase_quantity": "36",
        "min_purchase_quantity": "",
        "not_availible_message": "",
        "oak": "40% new, 60% 2 year old",
        "ph": "",
        "product_category": "Wine",
        "qb_account": "",
        "qb_class": "",
        "qb_sku": "",
        "region": "",
        "release_date": "September 1, 2012",
        "residual_sugar": "",
        "retail_price": "65.00",
        "review": "Hello",
        "reviewer": "Acme",
        "score": "99",
        "shipping_included": "0",
        "shipping_offer_min": "",
        "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
        "soil": "",
        "stainless": "",
        "starting_quantity": "99",
        "status_availability": "Active",
        "subtitle": "Napa Valley",
        "sub_region": "",
        "ta": ".06",
        "tasting_notes_pdf": "",
        "tax_exempt": "0",
        "upc": "",
        "varietal": "",
        "vineyard": "Black Hawk",
        "vintage": "2007",
        "winemaker": "Pepe LePepe",
        "wine_type": "RED",
        "categories": {
            "1": {
                "id": "1",
                "name": "New Releases",
                "sort": "2"
            }
        },
        "quantity": "12000"
    }
}

GET /products/{sku} Get Product by SKU

Parameters

Name	Type	Required	Description	Example
sku	string	Required	Product SKU

Examples

Request

GET/products/{sku}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "14",
    "name": "2014 Rosé",
    "sku": "12312312312",
    "price": "45",
    "description": "<em>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.</em> <br><br>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.  <strong>Drink now or age for up to 50 years.</strong>",
    "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": "",
    "case_production": "60",
    "cost": "0.00",
    "country": "",
    "custom01": "",
    "custom02": "",
    "custom03": "",
    "farming_method": "",
    "featured_product": "Yes",
    "free_shipping": "",
    "harvest_date": "October 19, 2007",
    "image": "//s3.amazonaws.com/efcheckout/acmev/product/12312312312-1725.jpg",
    "image_alt": "//s3.amazonaws.com/efcheckout/acmev/product-alt/AV10NVCS-4211.jpg",
    "label": "",
    "max_purchase_quantity": "36",
    "min_purchase_quantity": "",
    "not_availible_message": "",
    "oak": "40% new, 60% 2 year old",
    "ph": "",
    "product_category": "Wine",
    "qb_account": "",
    "qb_class": "",
    "qb_sku": "",
    "region": "",
    "release_date": "September 1, 2012",
    "residual_sugar": "",
    "retail_price": "65.00",
    "review": "Hello",
    "reviewer": "Acme",
    "score": "99",
    "shipping_included": "0",
    "shipping_offer_min": "",
    "short_description": "Destined to be a classic example of an outstanding vintage from the legendary Napa Valley.",
    "soil": "",
    "stainless": "",
    "starting_quantity": "99",
    "status_availability": "Active",
    "subtitle": "Napa Valley",
    "sub_region": "",
    "ta": ".06",
    "tasting_notes_pdf": "",
    "tax_exempt": "0",
    "upc": "",
    "varietal": "",
    "vineyard": "Black Hawk",
    "vintage": "2007",
    "winemaker": "Pepe LePepe",
    "wine_type": "RED",
    "categories": {
        "1": {
            "id": "1",
            "name": "New Releases",
            "sort": "2"
        }
    },
    "quantity": "12000"
}

Receipt

Resources related to Receipt.

POST /email/receipt/{id} Resend Receipt Email

Parameters

Name	Type	Required	Description	Example
id	number	Required	Order Id

Examples

Request

POST/email/receipt/{id}

Headers

Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "MessageId": "01000188ff6d0c57-83d19069-d96c-43fc-b973-197085030436-000000",
    "RequestId": "aad0544a-bae8-42e8-928b-57e19c79ded0"
}

Sesssion

Resources related to Sesssion.

POST /session Create New Cart Session

Examples

Request

POST/session

Headers

Content-Type: application/json
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

"RtF9KAyTiBCF4yfRy8sNdkoNXyr2ocJ"

DELETE /session Delete Session

Examples

Request

DELETE/session

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

true

ShippingMethods

Resources related to ShippingMethods.

GET /shipping_options Get Available Shipping Options

Examples

Request

GET/shipping_options

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "3": "Expedited Shipping - $0.00",
    "11": "Summer Shipping Ground - $0.00",
    "10": "Winery Pickup - $0.00",
    "14": "Winery Pickup2 - $0.00"
}

GET /shipping_methods/{id} Get Details about Shipping Method

Parameters

Name	Type	Required	Description	Example
id	number	Required	Shipping Method Id

Examples

Request

GET/shipping_methods/{id}

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "id": "3",
    "name": "Expedited Shipping",
    "carrier": "DDC",
    "code": "FXO",
    "status": "Active",
    "ship_compliant_status": "",
    "requested_ship_date": "0000-00-00 00:00:00",
    "sort": "0",
    "optimize": "",
    "address_id": "",
    "shipping_offer": "1",
    "description": "Orders usually arrive within 2-3 business days.",
    "ice_pack": "0",
    "ice_pack_price": "0",
    "data": ""
}

GET /shipping_methods Get List of Shipping Methods

Examples

Request

GET/shipping_methods

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

{
    "3": {
        "id": "3",
        "name": "Expedited Shipping",
        "carrier": "DDC",
        "code": "FXO",
        "status": "Active",
        "ship_compliant_status": "",
        "requested_ship_date": "0000-00-00 00:00:00",
        "sort": "0",
        "optimize": "",
        "address_id": "",
        "shipping_offer": "1",
        "description": "Orders usually arrive within 2-3 business days.",
        "ice_pack": "0",
        "ice_pack_price": "0",
        "data": ""
    }
}

ShippingStates

Resources related to ShippingStates.

GET /states Get Available Shipping States

Examples

Request

GET/states

Headers

Content-Type: application/json
X-Session-Id: XXXXXXXX
X-Auth-Token: XXXXXXXXXXXX

Response

Headers · 200

Content-Type: application/json

Body

[
    "AZ",
    "CA",
    "CO",
    "CT",
    "DC",
    "DE",
    "FL",
    "GA",
    "HI",
    "IA",
    "ID",
    "IL",
    "IN",
    "KS",
    "KY",
    "LA",
    "MD",
    "ME",
    "MI",
    "MN",
    "MO",
    "MS",
    "MT",
    "NC",
    "ND",
    "NE",
    "NH",
    "NJ",
    "NM",
    "NV",
    "NY",
    "OH",
    "OK",
    "OR",
    "RI",
    "SC",
    "SD",
    "TN",
    "TX",
    "VA",
    "VT",
    "WA",
    "WI",
    "WV",
    "WY"
]

Offset Cart API

Headers

Getting Started

Addresses

Authentication

Cart

Categories

Clubs

Config

Content

Customer

GiftCard

Inventory

Payment

Products

Receipt

Sesssion

ShippingMethods

ShippingStates