Request Offset API Key

Offset Reporting API

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

Welcome to the Offset Reporting API documentation. This API is designed for businesses and developers looking to integrate their systems with our advanced reporting capabilities. The Offset Reporting API provides programmatic access to a wide range of data that offer insights into commerce transactions, enabling users to make informed decisions based on comprehensive data analysis.

Headers

There are 2 HTTP Headers used by the Reporting API:

  • Content-Type
  • X-Auth-Token

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.

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.

Two conventions to know before your first call:

  • start and end dates are UNIX timestamps
  • Pagination is zero-based — the first page is page 0

Thank you for choosing Offset to power your wine business.

Addresses

Resources related to Addresses.

GET /addresses/{id} Get Address
Parameters
NameTypeRequiredDescriptionExample
id number Required Address Id
Examples
Request
GET/addresses/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "3989",
    "hash": "a187902adebd6b1aab810511fabcf475e4f5c8e2",
    "created": "2018-03-05 22:03:28",
    "last_update": "2018-04-20 20:48:32",
    "title": "",
    "first_name": "Jane",
    "last_name": "Doe",
    "birthday": "1985-06-01",
    "company": "Figure Commerce",
    "phone": "7075558520",
    "email": "",
    "address": "523 Brown St",
    "address_2": "",
    "city": "Napa",
    "state": "CA",
    "zip": "94559",
    "zip_ext": "3302",
    "country": "US",
    "lat": "38.29401000",
    "long": "-122.28348000",
    "residential": "1",
    "verified": "1",
    "customer_id": "42",
    "default": "1",
    "public": "0"
}
GET /addresses/{limit}/{page} Get All Addresses
Parameters
NameTypeRequiredDescriptionExample
limit number Required Number of records returned per page
page number Required Page Number
Examples
Request
GET/addresses/{limit}/{page}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "3989": {
        "id": "3989",
        "hash": "a187902adebd6b1aab810511fabcf475e4f5c8e2",
        "created": "2018-03-05 22:03:28",
        "last_update": "2018-04-20 20:48:32",
        "title": "",
        "first_name": "Jane",
        "last_name": "Doe",
        "birthday": "1985-06-01",
        "company": "Figure Commerce",
        "phone": "7075558520",
        "email": "",
        "address": "523 Brown St",
        "address_2": "",
        "city": "Napa",
        "state": "CA",
        "zip": "94559",
        "zip_ext": "3302",
        "country": "US",
        "lat": "38.29401000",
        "long": "-122.28348000",
        "residential": "1",
        "verified": "1",
        "customer_id": "42",
        "default": "1",
        "public": "0"
    }
}

Appointments

Resources related to Appointments. Appointment data is read-only in the Reporting API — to create, update, or delete appointments, use the Offset Management API.

GET /appointments/after/{start} Get All Appointments After Date

Returns all appointments scheduled on or after the given date/time.

Parameters
NameTypeRequiredDescriptionExample
start string Required Appointment Date
Examples
Request
GET/appointments/after/{start}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": 35,
        "customer_id": 1,
        "timestamp": "2020-07-31 11:00:00",
        "status": "Requested",
        "page_source": "Visit",
        "created_by": "Customer",
        "ip_address": "5.42.254.123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@gmail.com",
        "mobile_phone": "7075551234",
        "alternate_date": "01/10/2021",
        "preferred_time": "Morning",
        "appointment_type": "Winery Tour & Tasting",
        "size": "2",
        "guests": "John DoernJane Doe",
        "customer_comments": "I understand the tasting is unavailable to us (as members awaiting allocation), and I hope the Monday appointment is available. Thanks in advance!",
        "name": "Jon Doe",
        "customer_first_name": "Jon",
        "cancellation_reason": "",
        "customer_last_name": "Doe",
        "customer_phone": "7075551234",
        "customer_email": "john.doe@gmail.com",
        "hour": "10:00 AM",
        "endtime": "11:30 AM",
        "host": "",
        "room": "Foyer Lounge",
        "reason": "Waiting List",
        "category": "Consumer Conversion",
        "notes": "Very kind, read the rules and requested a monday morning. Offered the 10am time slot."
    }
]
GET /appointments/before/{end} Get All Appointments Before Date

Returns all appointments scheduled on or before the given date/time.

Parameters
NameTypeRequiredDescriptionExample
end string Required Appointment Date
Examples
Request
GET/appointments/before/{end}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": 35,
        "customer_id": 1,
        "timestamp": "2020-07-31 11:00:00",
        "status": "Requested",
        "page_source": "Visit",
        "created_by": "Customer",
        "ip_address": "5.42.254.123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@gmail.com",
        "mobile_phone": "7075551234",
        "alternate_date": "01/10/2021",
        "preferred_time": "Morning",
        "appointment_type": "Winery Tour & Tasting",
        "size": "2",
        "guests": "John DoernJane Doe",
        "customer_comments": "I understand the tasting is unavailable to us (as members awaiting allocation), and I hope the Monday appointment is available. Thanks in advance!",
        "name": "Jon Doe",
        "customer_first_name": "Jon",
        "cancellation_reason": "",
        "customer_last_name": "Doe",
        "customer_phone": "7075551234",
        "customer_email": "john.doe@gmail.com",
        "hour": "10:00 AM",
        "endtime": "11:30 AM",
        "host": "",
        "room": "Foyer Lounge",
        "reason": "Waiting List",
        "category": "Consumer Conversion",
        "notes": "Very kind, read the rules and requested a monday morning. Offered the 10am time slot."
    }
]
GET /appointments/{start}/{end} Get All Appointments in Date Range

Returns all appointments scheduled between the given start and end date/times.

Parameters
NameTypeRequiredDescriptionExample
end string Required Appointments End Date
start string Required Appointments Start Date
Examples
Request
GET/appointments/{start}/{end}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": 35,
        "customer_id": 1,
        "timestamp": "2020-07-31 11:00:00",
        "status": "Requested",
        "page_source": "Visit",
        "created_by": "Customer",
        "ip_address": "5.42.254.123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@gmail.com",
        "mobile_phone": "7075551234",
        "alternate_date": "01/10/2021",
        "preferred_time": "Morning",
        "appointment_type": "Winery Tour & Tasting",
        "size": "2",
        "guests": "John DoernJane Doe",
        "customer_comments": "I understand the tasting is unavailable to us (as members awaiting allocation), and I hope the Monday appointment is available. Thanks in advance!",
        "name": "Jon Doe",
        "customer_first_name": "Jon",
        "cancellation_reason": "",
        "customer_last_name": "Doe",
        "customer_phone": "7075551234",
        "customer_email": "john.doe@gmail.com",
        "hour": "10:00 AM",
        "endtime": "11:30 AM",
        "host": "",
        "room": "Foyer Lounge",
        "reason": "Waiting List",
        "category": "Consumer Conversion",
        "notes": "Very kind, read the rules and requested a monday morning. Offered the 10am time slot."
    }
]
GET /appointments/{id} Get Appointment

Returns a single appointment by id.

Parameters
NameTypeRequiredDescriptionExample
id number Required Appointment Id
Examples
Request
GET/appointments/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": 35,
    "customer_id": 1,
    "timestamp": "2020-07-31 11:00:00",
    "status": "Requested",
    "page_source": "Visit",
    "created_by": "Customer",
    "ip_address": "5.42.254.123",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@gmail.com",
    "mobile_phone": "7075551234",
    "alternate_date": "01/10/2021",
    "preferred_time": "Morning",
    "appointment_type": "Winery Tour & Tasting",
    "size": "2",
    "guests": "John DoernJane Doe",
    "customer_comments": "I understand the tasting is unavailable to us (as members awaiting allocation), and I hope the Monday appointment is available. Thanks in advance!",
    "name": "Jon Doe",
    "customer_first_name": "Jon",
    "cancellation_reason": "",
    "customer_last_name": "Doe",
    "customer_phone": "7075551234",
    "customer_email": "john.doe@gmail.com",
    "hour": "10:00 AM",
    "endtime": "11:30 AM",
    "host": "",
    "room": "Foyer Lounge",
    "reason": "Waiting List",
    "category": "Consumer Conversion",
    "notes": "Very kind, read the rules and requested a monday morning. Offered the 10am time slot."
}
GET /appointments/customer/{customer_id} Get Appointments By Customer

Returns all tasting-room appointments for a given customer.

Parameters
NameTypeRequiredDescriptionExample
customer_id number Required Customer Id
Examples
Request
GET/appointments/customer/{customer_id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": 35,
        "customer_id": 1,
        "created": "2026-07-01 09:00:00",
        "created_by": "Jane Doe",
        "status": "Confirmed",
        "timestamp": "2026-07-31 10:00:00",
        "hour": "10:00 AM",
        "endtime": "11:30 AM",
        "cancellation_reason": "",
        "notes": "Members awaiting allocation; offered the 10am slot.",
        "name": "John Doe",
        "size": "2",
        "category": "Consumer Conversion",
        "reason": "Waiting List",
        "occasion": "Anniversary",
        "host": "",
        "appointment_type": "Winery Tour & Tasting",
        "location": "Estate",
        "room": "Foyer Lounge",
        "table": "3",
        "guests": "John Doe\nJane Doe",
        "customer_wines_enjoyed": "Pinot Noir, Chardonnay",
        "customer_other_wineries": "",
        "wine_1": "PN2019",
        "wine_2": "CH2020",
        "customer_first_name": "John",
        "customer_last_name": "Doe",
        "customer_email": "john.doe@gmail.com",
        "customer_phone": "7075551234"
    }
]
GET /appointments/search/{query} Search Appointments

Searches appointments by a free-text query (for example a guest name or email) and returns the matching appointments. status is one of Requested, Pending, Waitlist, Confirmed, Declined, Cancelled, No Show or Checked In; category is one of Consumer Acquisition, Consumer Conversion, Consumer Retention, Trade or Industry. Up to 20 product SKUs may be attached as wine_1 through wine_20.

Parameters
NameTypeRequiredDescriptionExample
query string Required Search query, e.g. a guest name or email
Examples
Request
GET/appointments/search/{query}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": 35,
        "customer_id": 1,
        "created": "2026-07-01 09:00:00",
        "created_by": "Jane Doe",
        "status": "Confirmed",
        "timestamp": "2026-07-31 10:00:00",
        "hour": "10:00 AM",
        "endtime": "11:30 AM",
        "cancellation_reason": "",
        "notes": "Members awaiting allocation; offered the 10am slot.",
        "name": "John Doe",
        "size": "2",
        "category": "Consumer Conversion",
        "reason": "Waiting List",
        "occasion": "Anniversary",
        "host": "",
        "appointment_type": "Winery Tour & Tasting",
        "location": "Estate",
        "room": "Foyer Lounge",
        "table": "3",
        "guests": "John Doe\nJane Doe",
        "customer_wines_enjoyed": "Pinot Noir, Chardonnay",
        "customer_other_wineries": "",
        "wine_1": "PN2019",
        "wine_2": "CH2020",
        "customer_first_name": "John",
        "customer_last_name": "Doe",
        "customer_email": "john.doe@gmail.com",
        "customer_phone": "7075551234"
    }
]

Categories

Resources related to Categories.

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

ClubMembers

Resources related to ClubMembers.

GET /club-members Get All Club Memberships
Examples
Request
GET/club-members
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "2906",
        "club_id": "2",
        "customer": {
            "id": "25441",
            "first_name": "Andrew",
            "last_name": "Smith",
            "email": "amith@example.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",
            "last_update": "2020-09-20 18:14:24",
            "created": "2020-09-20 18:14:38",
            "active_account": "Yes",
            "agreed_to_mailing_list": "Yes",
            "agreed_to_terms_privacy": "Yes",
            "birthday": "1978-07-15",
            "consent_date": "2020-09-20",
            "consent_time": "18:13:35",
            "consent_token": "L7roMuj9mYgWGPJ0Tf",
            "created_by": "Customer",
            "customer_source": "Web",
            "customer_type": "Mailing List",
            "is_eu": "No",
            "mailing_city": "Carlsbad",
            "mailing_country": "US",
            "mailing_state": "CA",
            "mailing_zip": "92011",
            "mail_marketing_opt_in": "Yes",
            "marketing_opt_in": "Yes",
            "mobile_phone": "5559874321",
            "page_source": "Club",
            "phone": "5559874321",
            "score": "0",
            "signup_browser": "Safari",
            "signup_browser_device_type": "Mobile Phone",
            "signup_browser_platform": "iOS",
            "signup_browser_version": "0.0",
            "signup_ip_address": "72.173.65.42",
            "signup_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.2 Mobile/15E148 Safari/604.1",
            "website_source": "https://www.sommselect.com"
        },
        "address": {
            "id": "20849",
            "hash": "982aa178faab13c6376dd5f849234f3fcf02bbb0",
            "created": "2020-09-20 18:15:57",
            "last_update": "2020-09-20 18:15:42",
            "title": "",
            "salutation": "Mr.",
            "first_name": "Andrew",
            "last_name": "Smith",
            "birthday": "1978-07-17",
            "company": "",
            "phone": "5559874321",
            "email": "asmith@example.com",
            "address": "421 Fourth St",
            "address_2": "",
            "city": "Carlsbad",
            "state": "CA",
            "zip": "92011",
            "zip_ext": "1382",
            "country": "US",
            "lat": "47.59518000",
            "long": "-120.66152000",
            "residential": "0",
            "verified": "1",
            "customer_id": "25441",
            "default": "1",
            "public": "0"
        },
        "payment": {
            "id": "23744",
            "fingerprint": "",
            "account_token": "cus_I6OdAnnnBBcw6V",
            "payment_token": "card_0HWBq3ukqU3e0iSqqNEnfoVf",
            "credit_type": "American Express",
            "credit_number": "1013",
            "credit_expires_month": "6",
            "credit_expires_year": "2023",
            "profile_id": "0",
            "payment_profile_id": "0",
            "first_name": "Andrew",
            "birthday": "",
            "phone": "",
            "company": "",
            "last_name": "Smith",
            "address": "421 Fourth St",
            "address_2": "",
            "city": "Carlsbad",
            "state": "CA",
            "zip": "92011",
            "country": "US",
            "customer_id": "25441",
            "default": "1",
            "created": "2020-09-27 19:11:54",
            "last_update": "0000-00-00 00:00:00"
        },
        "authorization": "",
        "error": "",
        "amount": "0",
        "total": "0",
        "created": "2020-09-27 19:14:51"
    },
    {
        "id": "2905",
        "club_id": "4",
        "customer": {
            "id": "2542",
            "first_name": "William",
            "last_name": "Williamstein",
            "email": "example@hotmail.com",
            "status": "Active",
            "state": "CA",
            "order_count": "1",
            "order_total": "34.00",
            "last_order": "2020-09-27 00:00:00",
            "last_order_total": "34.00",
            "last_update": "2020-09-27 17:44:18",
            "created": "2020-09-27 17:41:31",
            "active_account": "Yes",
            "agreed_to_mailing_list": "Yes",
            "agreed_to_terms_privacy": "Yes",
            "birthday": "1987-02-20",
            "consent_date": "2020-09-27",
            "consent_time": "17:40:37",
            "consent_token": "QGKq2EHATJrhyPLkw4",
            "created_by": "Customer",
            "customer_source": "Web",
            "customer_type": "Mailing List",
            "is_eu": "No",
            "mailing_city": "Napa",
            "mailing_country": "US",
            "mailing_state": "CA",
            "mailing_zip": "94559",
            "mail_marketing_opt_in": "Yes",
            "marketing_opt_in": "Yes",
            "mobile_phone": "5551239876",
            "page_source": "Club",
            "phone": "example@hotmail.com",
            "score": "0",
            "signup_browser": "Chrome",
            "signup_browser_device_type": "Tablet",
            "signup_browser_platform": "iOS",
            "signup_browser_version": "0.0",
            "signup_ip_address": "199.66.65.241",
            "signup_user_agent": "Mozilla/5.0 (iPad; CPU OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/85.0.4183.109 Mobile/15E148 Safari/604.1",
            "website_source": "https://www.sommselect.com"
        },
        "address": {
            "id": "21030",
            "hash": "07722a8d21d89a26ab76640df71eeabb9b18fe1c",
            "created": "2020-09-27 17:42:13",
            "last_update": "2020-09-27 17:42:01",
            "title": "",
            "salutation": "Mr.",
            "first_name": "William",
            "last_name": "Williamstein",
            "birthday": "1987-02-20",
            "company": "Prefix *",
            "phone": "5551239876",
            "email": "example@hotmail.com",
            "address": "888 Professor Ln",
            "address_2": "",
            "city": "Oswego",
            "state": "IL",
            "zip": "60543",
            "zip_ext": "2002",
            "country": "US",
            "lat": "41.68245000",
            "long": "-88.32405000",
            "residential": "1",
            "verified": "1",
            "customer_id": "2542",
            "default": "1",
            "public": "0"
        },
        "payment": {
            "id": "23744",
            "fingerprint": "",
            "account_token": "cus_xxxx",
            "payment_token": "card_xxxx",
            "credit_type": "Visa",
            "credit_number": "7999",
            "credit_expires_month": "08",
            "credit_expires_year": "2023",
            "profile_id": "0",
            "payment_profile_id": "0",
            "first_name": "William",
            "birthday": "",
            "phone": "",
            "company": "",
            "last_name": "Williamstein",
            "address": "888 Professor Ln",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "country": "US",
            "customer_id": "2542",
            "default": "1",
            "created": "2020-09-27 17:42:45",
            "last_update": "0000-00-00 00:00:00"
        },
        "authorization": "",
        "error": "",
        "amount": "0",
        "total": "0",
        "created": "2020-09-27 17:43:05"
    }
]
GET /club-members/{id} Get Club Member
Parameters
NameTypeRequiredDescriptionExample
id numeric Required Club Member Id
Examples
Request
GET/club-members/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "2906",
        "club_id": "2",
        "customer": {
            "id": "25441",
            "first_name": "Andrew",
            "last_name": "Smith",
            "email": "amith@example.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",
            "last_update": "2020-09-20 18:14:24",
            "created": "2020-09-20 18:14:38",
            "active_account": "Yes",
            "agreed_to_mailing_list": "Yes",
            "agreed_to_terms_privacy": "Yes",
            "birthday": "1978-07-15",
            "consent_date": "2020-09-20",
            "consent_time": "18:13:35",
            "consent_token": "L7roMuj9mYgWGPJ0Tf",
            "created_by": "Customer",
            "customer_source": "Web",
            "customer_type": "Mailing List",
            "is_eu": "No",
            "mailing_city": "Carlsbad",
            "mailing_country": "US",
            "mailing_state": "CA",
            "mailing_zip": "92011",
            "mail_marketing_opt_in": "Yes",
            "marketing_opt_in": "Yes",
            "mobile_phone": "5559874321",
            "page_source": "Club",
            "phone": "5559874321",
            "score": "0",
            "signup_browser": "Safari",
            "signup_browser_device_type": "Mobile Phone",
            "signup_browser_platform": "iOS",
            "signup_browser_version": "0.0",
            "signup_ip_address": "72.173.65.42",
            "signup_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.1.2 Mobile/15E148 Safari/604.1",
            "website_source": "https://www.sommselect.com"
        },
        "address": {
            "id": "20849",
            "hash": "982aa178faab13c6376dd5f849234f3fcf02bbb0",
            "created": "2020-09-20 18:15:57",
            "last_update": "2020-09-20 18:15:42",
            "title": "",
            "salutation": "Mr.",
            "first_name": "Andrew",
            "last_name": "Smith",
            "birthday": "1978-07-17",
            "company": "",
            "phone": "5559874321",
            "email": "asmith@example.com",
            "address": "421 Fourth St",
            "address_2": "",
            "city": "Carlsbad",
            "state": "CA",
            "zip": "92011",
            "zip_ext": "1382",
            "country": "US",
            "lat": "47.59518000",
            "long": "-120.66152000",
            "residential": "0",
            "verified": "1",
            "customer_id": "25441",
            "default": "1",
            "public": "0"
        },
        "payment": {
            "id": "23744",
            "fingerprint": "",
            "account_token": "cus_I6OdAnnnBBcw6V",
            "payment_token": "card_0HWBq3ukqU3e0iSqqNEnfoVf",
            "credit_type": "American Express",
            "credit_number": "1013",
            "credit_expires_month": "6",
            "credit_expires_year": "2023",
            "profile_id": "0",
            "payment_profile_id": "0",
            "first_name": "Andrew",
            "birthday": "",
            "phone": "",
            "company": "",
            "last_name": "Smith",
            "address": "421 Fourth St",
            "address_2": "",
            "city": "Carlsbad",
            "state": "CA",
            "zip": "92011",
            "country": "US",
            "customer_id": "25441",
            "default": "1",
            "created": "2020-09-27 19:11:54",
            "last_update": "0000-00-00 00:00:00"
        },
        "authorization": "",
        "error": "",
        "amount": "0",
        "total": "0",
        "created": "2020-09-27 19:14:51"
    },
    {
        "id": "2905",
        "club_id": "4",
        "customer": {
            "id": "2542",
            "first_name": "William",
            "last_name": "Williamstein",
            "email": "example@hotmail.com",
            "status": "Active",
            "state": "CA",
            "order_count": "1",
            "order_total": "34.00",
            "last_order": "2020-09-27 00:00:00",
            "last_order_total": "34.00",
            "last_update": "2020-09-27 17:44:18",
            "created": "2020-09-27 17:41:31",
            "active_account": "Yes",
            "agreed_to_mailing_list": "Yes",
            "agreed_to_terms_privacy": "Yes",
            "birthday": "1987-02-20",
            "consent_date": "2020-09-27",
            "consent_time": "17:40:37",
            "consent_token": "QGKq2EHATJrhyPLkw4",
            "created_by": "Customer",
            "customer_source": "Web",
            "customer_type": "Mailing List",
            "is_eu": "No",
            "mailing_city": "Napa",
            "mailing_country": "US",
            "mailing_state": "CA",
            "mailing_zip": "94559",
            "mail_marketing_opt_in": "Yes",
            "marketing_opt_in": "Yes",
            "mobile_phone": "5551239876",
            "page_source": "Club",
            "phone": "example@hotmail.com",
            "score": "0",
            "signup_browser": "Chrome",
            "signup_browser_device_type": "Tablet",
            "signup_browser_platform": "iOS",
            "signup_browser_version": "0.0",
            "signup_ip_address": "199.66.65.241",
            "signup_user_agent": "Mozilla/5.0 (iPad; CPU OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/85.0.4183.109 Mobile/15E148 Safari/604.1",
            "website_source": "https://www.sommselect.com"
        },
        "address": {
            "id": "21030",
            "hash": "07722a8d21d89a26ab76640df71eeabb9b18fe1c",
            "created": "2020-09-27 17:42:13",
            "last_update": "2020-09-27 17:42:01",
            "title": "",
            "salutation": "Mr.",
            "first_name": "William",
            "last_name": "Williamstein",
            "birthday": "1987-02-20",
            "company": "Prefix *",
            "phone": "5551239876",
            "email": "example@hotmail.com",
            "address": "888 Professor Ln",
            "address_2": "",
            "city": "Oswego",
            "state": "IL",
            "zip": "60543",
            "zip_ext": "2002",
            "country": "US",
            "lat": "41.68245000",
            "long": "-88.32405000",
            "residential": "1",
            "verified": "1",
            "customer_id": "2542",
            "default": "1",
            "public": "0"
        },
        "payment": {
            "id": "23744",
            "fingerprint": "",
            "account_token": "cus_xxxx",
            "payment_token": "card_xxxx",
            "credit_type": "Visa",
            "credit_number": "7999",
            "credit_expires_month": "08",
            "credit_expires_year": "2023",
            "profile_id": "0",
            "payment_profile_id": "0",
            "first_name": "William",
            "birthday": "",
            "phone": "",
            "company": "",
            "last_name": "Williamstein",
            "address": "888 Professor Ln",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "country": "US",
            "customer_id": "2542",
            "default": "1",
            "created": "2020-09-27 17:42:45",
            "last_update": "0000-00-00 00:00:00"
        },
        "authorization": "",
        "error": "",
        "amount": "0",
        "total": "0",
        "created": "2020-09-27 17:43:05"
    }
]

Clubs

Resources related to Clubs.

GET /clubs/{id} Get Club
Parameters
NameTypeRequiredDescriptionExample
id numeric Required Club Id
Examples
Request
GET/clubs/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "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!rnrn- 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"
}
GET /clubs Get List of Clubs
Examples
Request
GET/clubs
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
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"
    }
}

Customers

Resources related to Customers.

GET /customers/{id} Get Customer
Parameters
NameTypeRequiredDescriptionExample
id number Required Customer Id
Examples
Request
GET/customers/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "42",
    "first_name": "John",
    "last_name": "Doe",
    "email": "example@commercebyoffset.com",
    "status": "Active",
    "state": "CA",
    "order_count": "2",
    "order_total": "595.00",
    "credits_total": "0.00",
    "last_order": "2023-06-22 11:48:57",
    "last_order_total": "450.00",
    "last_update": "2023-06-22 11:48:57",
    "created": "2022-04-20 13:58:42",
    "active_account": "Yes",
    "agreed_to_mailing_list": "Yes",
    "agreed_to_terms_privacy": "Yes",
    "birthday": "1978-09-28",
    "consent_date": "2022-04-20",
    "consent_time": "13:58:42",
    "consent_token": "BxxxxH",
    "created_by": "Customer",
    "customer_source": "Web",
    "customer_type": "Mailing List",
    "mailing_address": "1801 Old Sonoma Rd",
    "mailing_address_2": "",
    "mailing_city": "Napa",
    "mailing_company": "Offset Partners",
    "mailing_country": "US",
    "mailing_state": "CA",
    "mailing_zip": "94559",
    "mail_marketing_opt_in": "Yes",
    "marketing_opt_in": "Yes",
    "mobile_phone": "7075550538",
    "page_source": "Sign Up",
    "phone": "7075550538",
    "signup_browser": "Safari",
    "signup_browser_device_type": "Mobile Phone",
    "signup_browser_platform": "iOS",
    "signup_browser_version": "0.0",
    "signup_ip_address": "8.9.84.221",
    "signup_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) GSA/260.0.523280039 Mobile/15E148 Safari/604.1",
    "website_source": "https://www.commercebyoffset.com",
    "addresses": [
        {
            "id": "3942",
            "hash": "a187902adebd6bghofheofs11fabcf475e4f5c8e2",
            "created": "2018-03-05 22:03:28",
            "last_update": "2018-04-20 20:48:32",
            "title": "",
            "first_name": "John",
            "last_name": "Doe",
            "birthday": "1985-06-01",
            "company": "Offset Commerce",
            "phone": "7075558520",
            "email": "",
            "address": "1820 Old Sonoma Rd",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "country": "US",
            "lat": "38.29401000",
            "long": "-122.28348000",
            "residential": "1",
            "verified": "1",
            "customer_id": "42",
            "default": "1"
        }
    ],
    "payment": [
        {
            "id": "9432",
            "fingerprint": "",
            "account_token": "cus_xxxxx",
            "payment_token": "card_xxxxxx",
            "credit_type": "Visa",
            "credit_number": "4242",
            "credit_expires_month": "1",
            "credit_expires_year": "2026",
            "title": "",
            "first_name": "John",
            "last_name": "Doe",
            "company": "",
            "birthday": "",
            "phone": "",
            "address": "1801 Old Sonoma Rd",
            "address_2": "",
            "city": "Napa",
            "state": "CA",
            "zip": "94559",
            "country": "US",
            "customer_id": "42",
            "default": "1",
            "created": "2023-06-22 06:41:25",
            "last_update": "2023-06-22 06:41:49"
        }
    ],
    "groups": [
        {
            "id": "2",
            "name": "Tier 1 Allocation",
            "discount": "0",
            "free_shipping": "0",
            "checkout_cart_min": "0",
            "customer_id": "42"
        },
        {
            "id": "4",
            "name": "Waiting List",
            "discount": "0",
            "free_shipping": "0",
            "checkout_cart_min": "0",
            "customer_id": "42"
        }
    ],
    "tags": [
        "VIP",
        "Reds"
    ]
}
GET /customers/{id}/notes Get Customer Notes
Examples
Request
GET/customers/{id}/notes
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "12345",
        "customer_id": "15678",
        "created": "2025-08-01 09:50:56",
        "type": "Admin",
        "category": "General",
        "user_id": "1234",
        "user_name": "Admin User",
        "message": "Customer Visited Tasting Room"
    },
    {
        "id": "12346",
        "customer_id": "15678",
        "created": "2025-08-01 00:00:00",
        "type": "Admin",
        "category": "General",
        "user_id": "1234",
        "user_name": "Admin User",
        "message": "Customer Enjoyed 2022 Cabernet"
    },
    {
        "id": "12040",
        "customer_id": "15678",
        "created": "2018-10-19 00:00:00",
        "type": "Admin",
        "category": "General",
        "user_id": "1234",
        "user_name": "Admin User",
        "message": "Corporate Tasting group 10-19-2018"
    }
]
GET /customers/last-update/{start}/{end}/{limit}/{page} Get Customers by Last Update Time
Parameters
NameTypeRequiredDescriptionExample
end number Required Unix Time stamp for end of reporting period
limit number Required Number of records returned per page
page number Required Page Number
start number Required Unix Time stamp for beginning of reporting period
Examples
Request
GET/customers/last-update/{start}/{end}/{limit}/{page}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "17": {
        "id": "17",
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "janedoe@commercebyfigure.com",
        "status": "Active",
        "state": "",
        "order_count": "0",
        "order_total": "0.00",
        "last_order": "0000-00-00 00:00:00",
        "last_order_total": "0.00",
        "last_update": "2018-04-17 10:34:59",
        "created": "2018-02-13 09:16:59",
        "active_account": "Yes",
        "created_by": "Website",
        "mail_marketing_opt_in": "Yes",
        "marketing_opt_in": "Yes",
        "phone": "707-555-2821",
        "phone_call_opt_in": "Yes",
        "signup_email_last_sent": "2018-02-13 09:16:59",
        "signup_ip_address": "67.161.61.171"
    },
    "42": {
        "id": "42",
        "first_name": "John",
        "last_name": "Doe",
        "email": "example@commercebyoffset.com",
        "status": "Active",
        "state": "CA",
        "order_count": "2",
        "order_total": "595.00",
        "credits_total": "0.00",
        "last_order": "2023-06-22 11:48:57",
        "last_order_total": "450.00",
        "last_update": "2023-06-22 11:48:57",
        "created": "2022-04-20 13:58:42",
        "active_account": "Yes",
        "agreed_to_mailing_list": "Yes",
        "agreed_to_terms_privacy": "Yes",
        "birthday": "1978-09-28",
        "consent_date": "2022-04-20",
        "consent_time": "13:58:42",
        "consent_token": "BxxxxH",
        "created_by": "Customer",
        "customer_source": "Web",
        "customer_type": "Mailing List",
        "mailing_address": "1801 Old Sonoma Rd",
        "mailing_address_2": "",
        "mailing_city": "Napa",
        "mailing_company": "Offset Partners",
        "mailing_country": "US",
        "mailing_state": "CA",
        "mailing_zip": "94559",
        "mail_marketing_opt_in": "Yes",
        "marketing_opt_in": "Yes",
        "mobile_phone": "7075550538",
        "page_source": "Sign Up",
        "phone": "7075550538",
        "signup_browser": "Safari",
        "signup_browser_device_type": "Mobile Phone",
        "signup_browser_platform": "iOS",
        "signup_browser_version": "0.0",
        "signup_ip_address": "8.9.84.221",
        "signup_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) GSA/260.0.523280039 Mobile/15E148 Safari/604.1",
        "website_source": "https://www.commercebyoffset.com",
        "addresses": [
            {
                "id": "3942",
                "hash": "a187902adebd6bghofheofs11fabcf475e4f5c8e2",
                "created": "2018-03-05 22:03:28",
                "last_update": "2018-04-20 20:48:32",
                "title": "",
                "first_name": "John",
                "last_name": "Doe",
                "birthday": "1985-06-01",
                "company": "Offset Commerce",
                "phone": "7075558520",
                "email": "",
                "address": "1820 Old Sonoma Rd",
                "address_2": "",
                "city": "Napa",
                "state": "CA",
                "zip": "94559",
                "country": "US",
                "lat": "38.29401000",
                "long": "-122.28348000",
                "residential": "1",
                "verified": "1",
                "customer_id": "42",
                "default": "1"
            }
        ],
        "payment": [
            {
                "id": "9432",
                "fingerprint": "",
                "account_token": "cus_xxxxx",
                "payment_token": "card_xxxxxx",
                "credit_type": "Visa",
                "credit_number": "4242",
                "credit_expires_month": "1",
                "credit_expires_year": "2026",
                "title": "",
                "first_name": "John",
                "last_name": "Doe",
                "company": "",
                "birthday": "",
                "phone": "",
                "address": "1801 Old Sonoma Rd",
                "address_2": "",
                "city": "Napa",
                "state": "CA",
                "zip": "94559",
                "country": "US",
                "customer_id": "42",
                "default": "1",
                "created": "2023-06-22 06:41:25",
                "last_update": "2023-06-22 06:41:49"
            }
        ],
        "groups": [
            {
                "id": "2",
                "name": "Tier 1 Allocation",
                "discount": "0",
                "free_shipping": "0",
                "checkout_cart_min": "0",
                "customer_id": "42"
            },
            {
                "id": "4",
                "name": "Waiting List",
                "discount": "0",
                "free_shipping": "0",
                "checkout_cart_min": "0",
                "customer_id": "42"
            }
        ],
        "tags": [
            "VIP",
            "Reds"
        ]
    }
}
GET /customers/created/{start}/{end}/{limit}/{page} Get Customers by Signup Date
Parameters
NameTypeRequiredDescriptionExample
end string Required Date for end of the reporting period
limit number Required Number of records returned per page
page number Required Page Number
start string Required Date for start of the reporting period
Examples
Request
GET/customers/created/{start}/{end}/{limit}/{page}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "17": {
        "id": "17",
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "janedoe@commercebyfigure.com",
        "status": "Active",
        "state": "",
        "order_count": "0",
        "order_total": "0.00",
        "last_order": "0000-00-00 00:00:00",
        "last_order_total": "0.00",
        "last_update": "2018-04-17 10:34:59",
        "created": "2018-02-13 09:16:59",
        "active_account": "Yes",
        "created_by": "Website",
        "mail_marketing_opt_in": "Yes",
        "marketing_opt_in": "Yes",
        "phone": "707-555-2821",
        "phone_call_opt_in": "Yes",
        "signup_email_last_sent": "2018-02-13 09:16:59",
        "signup_ip_address": "67.161.61.171"
    },
    "42": {
        "id": "42",
        "first_name": "John",
        "last_name": "Doe",
        "email": "example@commercebyoffset.com",
        "status": "Active",
        "state": "CA",
        "order_count": "2",
        "order_total": "595.00",
        "credits_total": "0.00",
        "last_order": "2023-06-22 11:48:57",
        "last_order_total": "450.00",
        "last_update": "2023-06-22 11:48:57",
        "created": "2022-04-20 13:58:42",
        "active_account": "Yes",
        "agreed_to_mailing_list": "Yes",
        "agreed_to_terms_privacy": "Yes",
        "birthday": "1978-09-28",
        "consent_date": "2022-04-20",
        "consent_time": "13:58:42",
        "consent_token": "BxxxxH",
        "created_by": "Customer",
        "customer_source": "Web",
        "customer_type": "Mailing List",
        "mailing_address": "1801 Old Sonoma Rd",
        "mailing_address_2": "",
        "mailing_city": "Napa",
        "mailing_company": "Offset Partners",
        "mailing_country": "US",
        "mailing_state": "CA",
        "mailing_zip": "94559",
        "mail_marketing_opt_in": "Yes",
        "marketing_opt_in": "Yes",
        "mobile_phone": "7075550538",
        "page_source": "Sign Up",
        "phone": "7075550538",
        "signup_browser": "Safari",
        "signup_browser_device_type": "Mobile Phone",
        "signup_browser_platform": "iOS",
        "signup_browser_version": "0.0",
        "signup_ip_address": "8.9.84.221",
        "signup_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) GSA/260.0.523280039 Mobile/15E148 Safari/604.1",
        "website_source": "https://www.commercebyoffset.com",
        "addresses": [
            {
                "id": "3942",
                "hash": "a187902adebd6bghofheofs11fabcf475e4f5c8e2",
                "created": "2018-03-05 22:03:28",
                "last_update": "2018-04-20 20:48:32",
                "title": "",
                "first_name": "John",
                "last_name": "Doe",
                "birthday": "1985-06-01",
                "company": "Offset Commerce",
                "phone": "7075558520",
                "email": "",
                "address": "1820 Old Sonoma Rd",
                "address_2": "",
                "city": "Napa",
                "state": "CA",
                "zip": "94559",
                "country": "US",
                "lat": "38.29401000",
                "long": "-122.28348000",
                "residential": "1",
                "verified": "1",
                "customer_id": "42",
                "default": "1"
            }
        ],
        "payment": [
            {
                "id": "9432",
                "fingerprint": "",
                "account_token": "cus_xxxxx",
                "payment_token": "card_xxxxxx",
                "credit_type": "Visa",
                "credit_number": "4242",
                "credit_expires_month": "1",
                "credit_expires_year": "2026",
                "title": "",
                "first_name": "John",
                "last_name": "Doe",
                "company": "",
                "birthday": "",
                "phone": "",
                "address": "1801 Old Sonoma Rd",
                "address_2": "",
                "city": "Napa",
                "state": "CA",
                "zip": "94559",
                "country": "US",
                "customer_id": "42",
                "default": "1",
                "created": "2023-06-22 06:41:25",
                "last_update": "2023-06-22 06:41:49"
            }
        ],
        "groups": [
            {
                "id": "2",
                "name": "Tier 1 Allocation",
                "discount": "0",
                "free_shipping": "0",
                "checkout_cart_min": "0",
                "customer_id": "42"
            },
            {
                "id": "4",
                "name": "Waiting List",
                "discount": "0",
                "free_shipping": "0",
                "checkout_cart_min": "0",
                "customer_id": "42"
            }
        ],
        "tags": [
            "VIP",
            "Reds"
        ]
    }
}
GET /customers/groups/{id} Get Customers In Group
Parameters
NameTypeRequiredDescriptionExample
id number Required Group Id
Examples
Request
GET/customers/groups/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "42": {
        "id": "42",
        "first_name": "John",
        "last_name": "Doe",
        "email": "example@commercebyfigure.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",
        "last_update": "2018-04-18 16:35:48",
        "created": "2018-04-18 16:14:00",
        "signup_email_last_sent": "2018-04-18 16:14:00"
    }
}
GET /customers/notes/created/{start}/{end}/{limit}/{page} Get Customers Notes by Date
Examples
Request
GET/customers/notes/created/{start}/{end}/{limit}/{page}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "12345",
        "customer_id": "15678",
        "created": "2025-08-01 09:50:56",
        "type": "Admin",
        "category": "General",
        "user_id": "1234",
        "user_name": "Admin User",
        "message": "Customer Visited Tasting Room"
    },
    {
        "id": "12346",
        "customer_id": "15678",
        "created": "2025-08-01 00:00:00",
        "type": "Admin",
        "category": "General",
        "user_id": "1234",
        "user_name": "Admin User",
        "message": "Customer Enjoyed 2022 Cabernet"
    }
]

Groups

Resources related to Groups.

GET /groups Get All Groups
Examples
Request
GET/groups
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "1",
        "name": "Mailing List",
        "status": "Active",
        "sort": "1",
        "allocation_message": "<p>Welcome to the Summer Relase</p>",
        "allocation_start": "2020-07-14 21:07:00",
        "allocation_end": "2020-08-15 21:07:00",
        "allocation_title": "2022 Summer Release",
        "checkout_cart_min": 0,
        "checkout_dollar_min": 0,
        "discount": 0,
        "free_shipping": 0,
        "description": "",
        "purchase_message": "<p>Thank you for your Purchase!</p>",
        "allocation": {
            "ABC2020": {
                "sku": "ABC2020",
                "min_quantity": "0",
                "quantity": "6",
                "min_wish": "0",
                "max_wish": "6"
            },
            "ZIN2021": {
                "sku": "ZIN2021",
                "min_quantity": "0",
                "quantity": "12",
                "min_wish": "0",
                "max_wish": "12"
            }
        }
    },
    {
        "id": "2",
        "name": "VIP Group",
        "status": "Active",
        "allocation_message": "",
        "allocation_start": "0000-00-00 00:00:00",
        "allocation_end": "0000-00-00 00:00:00",
        "checkout_cart_min": 0,
        "checkout_dollar_min": 0,
        "discount": 0,
        "free_shipping": 0,
        "description": "VIPS",
        "allocation_title": "",
        "purchase_message": "",
        "allocation": []
    }
]
GET /groups/{id} Get Group
Parameters
NameTypeRequiredDescriptionExample
id number Required Group Id
Examples
Request
GET/groups/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "1",
        "name": "Mailing List",
        "status": "Active",
        "sort": "1",
        "allocation_message": "<p>Welcome to the Summer Relase</p>",
        "allocation_start": "2020-07-14 21:07:00",
        "allocation_end": "2020-08-15 21:07:00",
        "allocation_title": "2022 Summer Release",
        "checkout_cart_min": 0,
        "checkout_dollar_min": 0,
        "discount": 0,
        "free_shipping": 0,
        "description": "",
        "purchase_message": "<p>Thank you for your Purchase!</p>",
        "allocation": {
            "ABC2020": {
                "sku": "ABC2020",
                "min_quantity": "0",
                "quantity": "6",
                "min_wish": "0",
                "max_wish": "6"
            },
            "ZIN2021": {
                "sku": "ZIN2021",
                "min_quantity": "0",
                "quantity": "12",
                "min_wish": "0",
                "max_wish": "12"
            }
        }
    }
]

Inventory

Resources related to Inventory.

GET /inventory Get Current Inventory Levels
Examples
Request
GET/inventory
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "ABC-CAB": {
        "sku": "ABC-2015-CAB",
        "quantity": 120,
        "Tastingroom": 70,
        "Website": 50
    },
    "ABC-PINOT": {
        "sku": "ABC-2015-PN",
        "quantity": "480",
        "Tastingroom": 80,
        "Website": 400
    }
}
GET /inventory/transactions/{start}/{end} Get Inventory Movements by Date
Parameters
NameTypeRequiredDescriptionExample
end number Required Date for end of the reporting period
start string Required Date for start of the reporting period
Examples
Request
GET/inventory/transactions/{start}/{end}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "sku": "ABC-2015-CAB",
        "timestamp": "2018-03-14 13:17:07",
        "quantity": -1,
        "order_number": "1",
        "user": "",
        "note": ""
    }
]
GET /inventory/allocated Get Unshipped Inventory
Examples
Request
GET/inventory/allocated
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "ABC-CAB": {
        "sku": "ABC-2022-CAB",
        "total": 366,
        "Tastingroom": 12,
        "Website": 354
    },
    "ABC-PINOT": {
        "sku": "ABC-2022-PN",
        "total": "144",
        "Tastingroom": 24,
        "Website": 120
    }
}

Orders

Resources related to Orders.

GET /orders/{id} Get Order
Parameters
NameTypeRequiredDescriptionExample
id number Required Order Id
Examples
Request
GET/orders/{id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "id": "42",
    "datestamp": "2018-03-23 16:24:15",
    "last_update": "2018-03-23 16:24:15",
    "status": "",
    "subtotal": "45.00",
    "tax": "3.15",
    "shipping": "20.00",
    "discount": "9.00",
    "credits": "0.00",
    "refund": "0.00",
    "total": "59.15",
    "customer_id": "1",
    "address": "",
    "address_2": "",
    "address_id": "3979",
    "birthday": "1982-11-1",
    "city": "",
    "company": "",
    "credit_id": "19",
    "credit_number": "4242",
    "credit_type": "Visa",
    "customer_credits": "0.00",
    "discount_customer": "0.2",
    "email": "example@commercebyfigure.com",
    "first_name": "John",
    "gift_message": "",
    "instructions": "",
    "item_count": "1",
    "last_name": "Doe",
    "order_id": "42",
    "order_type": "Web",
    "payment_status": "Paid",
    "phone": "707-287-6262",
    "salutation": "Mr.",
    "shipping_address": "770 3rd St E",
    "shipping_address_2": "",
    "shipping_city": "Sonoma",
    "shipping_company": "",
    "shipping_first_name": "John",
    "shipping_id": "3979",
    "shipping_last_name": "Doe",
    "shipping_method": "11",
    "shipping_method_carrier": "FedEx",
    "shipping_method_code": "FDXGND",
    "shipping_method_name": "Ground",
    "shipping_phone": "707-287-6262",
    "shipping_state": "CA",
    "shipping_title": "Shipping Address",
    "shipping_zip": "95476",
    "ship_status": "Not Shipped",
    "state": "",
    "tax_rate": "8.75",
    "transaction_id": "36",
    "zip": "",
    "products": [
        {
            "id": "42",
            "sku": "H",
            "name": "2017 Pinot Meunier",
            "type": "",
            "bottle_size": "750mL",
            "retail_price": "0.00",
            "discount": "0.00",
            "discount_type": "",
            "price": "45",
            "quantity": "1",
            "status": "",
            "description": "2017 Pinot Meunier ",
            "image": "",
            "stock_status": "",
            "shipped": "0",
            "created": "2018-03-23 16:24:18"
        }
    ]
}
GET /orders/{id}/notes Get Order Notes
Parameters
NameTypeRequiredDescriptionExample
id number Required Order Id
Examples
Request
GET/orders/{id}/notes
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "518631",
        "order_id": "24102",
        "created": "2025-08-01 12:12:42",
        "type": "Admin",
        "category": "General",
        "user_id": "1334",
        "user_name": "Admin User",
        "message": "$113.40 Payment Added"
    },
    {
        "id": "518630",
        "order_id": "24102",
        "created": "2025-08-07 12:11:37",
        "type": "Admin",
        "category": "General",
        "user_id": "1334",
        "user_name": "Admin user",
        "message": "Customer Requested Wines be Held by UPS"
    }
]
GET /orders/{id}/packages Get Order Packages
Parameters
NameTypeRequiredDescriptionExample
id number Required Order Id
Examples
Request
GET/orders/{id}/packages
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "206776",
        "TrackingNumber": "1ZA12345A899249621",
        "DateShipped": "2020-04-20",
        "ShipToName": "Jane Doe",
        "Weight": "18",
        "ShipMethod": "UPSGND",
        "Carrier": "UPS"
    }
]
GET /orders/created/{start}/{end}/{limit}/{page} Get Orders by Creation Date
Parameters
NameTypeRequiredDescriptionExample
end number Required Date for end of the reporting period
limit number Required Number of records returned per page
page number Required Page Number
start string Required Date for start of the reporting period
Examples
Request
GET/orders/created/{start}/{end}/{limit}/{page}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "1": {
        "id": "1",
        "datestamp": "2018-03-14 13:17:05",
        "last_update": "2018-03-14 14:17:05",
        "status": "",
        "subtotal": "14.99",
        "tax": "0.00",
        "shipping": "30.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "44.99",
        "customer_id": "3",
        "address": "123 Main Street",
        "address_2": "",
        "address_id": "6",
        "city": "Anywhere",
        "credit_number": "8431",
        "credit_type": "American Express",
        "discount_customer": "0",
        "email": "eh@hugel.com",
        "email_template": "",
        "first_name": "Jane",
        "group_id": "1",
        "group_name": "Mailing List",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "1",
        "order_type": "Admin",
        "payment_id": "1",
        "payment_status": "Paid",
        "phone": "",
        "sales_agent": "Sales Agent",
        "sale_credit": "...",
        "shipping_address": "123 Main Street",
        "shipping_address_2": "",
        "shipping_city": "Anywhere",
        "shipping_company": "",
        "shipping_first_name": "Etienne",
        "shipping_last_name": "Hugel",
        "shipping_method": "1",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "UPSGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "(123) 456-7890",
        "shipping_residential": "0",
        "shipping_state": "PA",
        "shipping_zip": "17000",
        "ship_status": "Not Shipped",
        "state": "PA",
        "tax_rate": "0",
        "transaction_id": "1",
        "zip": "17000",
        "products": [
            {
                "id": "1",
                "sku": "12831",
                "name": "Domaine Chêne",
                "type": "",
                "bottle_size": "",
                "retail_price": "14.99",
                "discount": "0.00",
                "discount_type": "",
                "price": "14.99",
                "quantity": "1",
                "status": "",
                "description": "Domaine Chêne ",
                "image": "//s3.amazonaws.com/efcheckout/figureapi/products/12831-9864.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-14 13:17:07"
            }
        ]
    },
    "2": {
        "id": "2",
        "datestamp": "2018-03-23 16:24:15",
        "last_update": "2018-03-23 16:24:15",
        "status": "",
        "subtotal": "45.00",
        "tax": "3.15",
        "shipping": "20.00",
        "discount": "9.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "59.15",
        "customer_id": "1",
        "address": "",
        "address_2": "",
        "address_id": "3979",
        "birthday": "1982-11-1",
        "city": "",
        "company": "",
        "credit_id": "19",
        "credit_number": "4242",
        "credit_type": "Visa",
        "customer_credits": "0.00",
        "discount_customer": "0.2",
        "email": "example@commercebyfigure.com",
        "first_name": "John",
        "gift_message": "",
        "instructions": "",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "42",
        "order_type": "Web",
        "payment_status": "Paid",
        "phone": "707-287-6262",
        "salutation": "Mr.",
        "shipping_address": "770 3rd St E",
        "shipping_address_2": "",
        "shipping_city": "Sonoma",
        "shipping_company": "",
        "shipping_first_name": "John",
        "shipping_id": "3979",
        "shipping_last_name": "Doe",
        "shipping_method": "11",
        "shipping_method_carrier": "FedEx",
        "shipping_method_code": "FDXGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "707-287-6262",
        "shipping_state": "CA",
        "shipping_title": "Shipping Address",
        "shipping_zip": "95476",
        "ship_status": "Not Shipped",
        "state": "",
        "tax_rate": "8.75",
        "transaction_id": "36",
        "zip": "",
        "products": [
            {
                "id": "42",
                "sku": "H",
                "name": "2017 Pinot Meunier",
                "type": "",
                "bottle_size": "750mL",
                "retail_price": "0.00",
                "discount": "0.00",
                "discount_type": "",
                "price": "45",
                "quantity": "1",
                "status": "",
                "description": "2017 Pinot Meunier ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-23 16:24:18"
            }
        ]
    }
}
GET /orders/last-update/{start}/{end}/{limit}/{page} Get Orders by Last Update Time
Parameters
NameTypeRequiredDescriptionExample
end number Required Unix Time stamp for end of reporting period
limit number Required Number of records returned per page
page number Required Page Number
start number Required Unix Time stamp for beginning of reporting period
Examples
Request
GET/orders/last-update/{start}/{end}/{limit}/{page}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "1": {
        "id": "1",
        "datestamp": "2018-03-14 13:17:05",
        "last_update": "2018-03-14 14:17:05",
        "status": "",
        "subtotal": "14.99",
        "tax": "0.00",
        "shipping": "30.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "44.99",
        "customer_id": "3",
        "address": "123 Main Street",
        "address_2": "",
        "address_id": "6",
        "city": "Anywhere",
        "credit_number": "8431",
        "credit_type": "American Express",
        "discount_customer": "0",
        "email": "eh@hugel.com",
        "email_template": "",
        "first_name": "Jane",
        "group_id": "1",
        "group_name": "Mailing List",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "1",
        "order_type": "Admin",
        "payment_id": "1",
        "payment_status": "Paid",
        "phone": "",
        "sales_agent": "Sales Agent",
        "sale_credit": "...",
        "shipping_address": "123 Main Street",
        "shipping_address_2": "",
        "shipping_city": "Anywhere",
        "shipping_company": "",
        "shipping_first_name": "Etienne",
        "shipping_last_name": "Hugel",
        "shipping_method": "1",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "UPSGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "(123) 456-7890",
        "shipping_residential": "0",
        "shipping_state": "PA",
        "shipping_zip": "17000",
        "ship_status": "Not Shipped",
        "state": "PA",
        "tax_rate": "0",
        "transaction_id": "1",
        "zip": "17000",
        "products": [
            {
                "id": "1",
                "sku": "12831",
                "name": "Domaine Chêne",
                "type": "",
                "bottle_size": "",
                "retail_price": "14.99",
                "discount": "0.00",
                "discount_type": "",
                "price": "14.99",
                "quantity": "1",
                "status": "",
                "description": "Domaine Chêne ",
                "image": "//s3.amazonaws.com/efcheckout/figureapi/products/12831-9864.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-14 13:17:07"
            }
        ]
    },
    "2": {
        "id": "2",
        "datestamp": "2018-03-23 16:24:15",
        "last_update": "2018-03-23 16:24:15",
        "status": "",
        "subtotal": "45.00",
        "tax": "3.15",
        "shipping": "20.00",
        "discount": "9.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "59.15",
        "customer_id": "1",
        "address": "",
        "address_2": "",
        "address_id": "3979",
        "birthday": "1982-11-1",
        "city": "",
        "company": "",
        "credit_id": "19",
        "credit_number": "4242",
        "credit_type": "Visa",
        "customer_credits": "0.00",
        "discount_customer": "0.2",
        "email": "example@commercebyfigure.com",
        "first_name": "John",
        "gift_message": "",
        "instructions": "",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "42",
        "order_type": "Web",
        "payment_status": "Paid",
        "phone": "707-287-6262",
        "salutation": "Mr.",
        "shipping_address": "770 3rd St E",
        "shipping_address_2": "",
        "shipping_city": "Sonoma",
        "shipping_company": "",
        "shipping_first_name": "John",
        "shipping_id": "3979",
        "shipping_last_name": "Doe",
        "shipping_method": "11",
        "shipping_method_carrier": "FedEx",
        "shipping_method_code": "FDXGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "707-287-6262",
        "shipping_state": "CA",
        "shipping_title": "Shipping Address",
        "shipping_zip": "95476",
        "ship_status": "Not Shipped",
        "state": "",
        "tax_rate": "8.75",
        "transaction_id": "36",
        "zip": "",
        "products": [
            {
                "id": "42",
                "sku": "H",
                "name": "2017 Pinot Meunier",
                "type": "",
                "bottle_size": "750mL",
                "retail_price": "0.00",
                "discount": "0.00",
                "discount_type": "",
                "price": "45",
                "quantity": "1",
                "status": "",
                "description": "2017 Pinot Meunier ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-23 16:24:18"
            }
        ]
    }
}
GET /orders/type/{order_type}/{start}/{end} Get Orders By Type
Parameters
NameTypeRequiredDescriptionExample
end number Required Date for end of the reporting period
order_type string Required Order Type
start number Required Date for start of the reporting period
Examples
Request
GET/orders/type/{order_type}/{start}/{end}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "1": {
        "id": "1",
        "datestamp": "2018-03-14 13:17:05",
        "last_update": "2018-03-14 14:17:05",
        "status": "",
        "subtotal": "14.99",
        "tax": "0.00",
        "shipping": "30.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "44.99",
        "customer_id": "3",
        "address": "123 Main Street",
        "address_2": "",
        "address_id": "6",
        "city": "Anywhere",
        "credit_number": "8431",
        "credit_type": "American Express",
        "discount_customer": "0",
        "email": "eh@hugel.com",
        "email_template": "",
        "first_name": "Jane",
        "group_id": "1",
        "group_name": "Mailing List",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "1",
        "order_type": "Admin",
        "payment_id": "1",
        "payment_status": "Paid",
        "phone": "",
        "sales_agent": "Sales Agent",
        "sale_credit": "...",
        "shipping_address": "123 Main Street",
        "shipping_address_2": "",
        "shipping_city": "Anywhere",
        "shipping_company": "",
        "shipping_first_name": "Etienne",
        "shipping_last_name": "Hugel",
        "shipping_method": "1",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "UPSGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "(123) 456-7890",
        "shipping_residential": "0",
        "shipping_state": "PA",
        "shipping_zip": "17000",
        "ship_status": "Not Shipped",
        "state": "PA",
        "tax_rate": "0",
        "transaction_id": "1",
        "zip": "17000",
        "products": [
            {
                "id": "1",
                "sku": "12831",
                "name": "Domaine Chêne",
                "type": "",
                "bottle_size": "",
                "retail_price": "14.99",
                "discount": "0.00",
                "discount_type": "",
                "price": "14.99",
                "quantity": "1",
                "status": "",
                "description": "Domaine Chêne ",
                "image": "//s3.amazonaws.com/efcheckout/figureapi/products/12831-9864.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-14 13:17:07"
            }
        ]
    },
    "2": {
        "id": "2",
        "datestamp": "2018-03-23 16:24:15",
        "last_update": "2018-03-23 16:24:15",
        "status": "",
        "subtotal": "45.00",
        "tax": "3.15",
        "shipping": "20.00",
        "discount": "9.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "59.15",
        "customer_id": "1",
        "address": "",
        "address_2": "",
        "address_id": "3979",
        "birthday": "1982-11-1",
        "city": "",
        "company": "",
        "credit_id": "19",
        "credit_number": "4242",
        "credit_type": "Visa",
        "customer_credits": "0.00",
        "discount_customer": "0.2",
        "email": "example@commercebyfigure.com",
        "first_name": "John",
        "gift_message": "",
        "instructions": "",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "42",
        "order_type": "Web",
        "payment_status": "Paid",
        "phone": "707-287-6262",
        "salutation": "Mr.",
        "shipping_address": "770 3rd St E",
        "shipping_address_2": "",
        "shipping_city": "Sonoma",
        "shipping_company": "",
        "shipping_first_name": "John",
        "shipping_id": "3979",
        "shipping_last_name": "Doe",
        "shipping_method": "11",
        "shipping_method_carrier": "FedEx",
        "shipping_method_code": "FDXGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "707-287-6262",
        "shipping_state": "CA",
        "shipping_title": "Shipping Address",
        "shipping_zip": "95476",
        "ship_status": "Not Shipped",
        "state": "",
        "tax_rate": "8.75",
        "transaction_id": "36",
        "zip": "",
        "products": [
            {
                "id": "42",
                "sku": "H",
                "name": "2017 Pinot Meunier",
                "type": "",
                "bottle_size": "750mL",
                "retail_price": "0.00",
                "discount": "0.00",
                "discount_type": "",
                "price": "45",
                "quantity": "1",
                "status": "",
                "description": "2017 Pinot Meunier ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-23 16:24:18"
            }
        ]
    }
}
GET /orders/nav/{start}/{end} Get Orders For Accounting
Parameters
NameTypeRequiredDescriptionExample
end number Required Date for end of the reporting period
start number Required Date for start of the reporting period
Examples
Request
GET/orders/nav/{start}/{end}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "1": {
        "id": "1-104",
        "figure_id": "1",
        "datestamp": "2018-03-14 13:17:05",
        "last_update": "2018-03-14 14:17:05",
        "status": "",
        "subtotal": "14.99",
        "tax": "0.00",
        "shipping": "30.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "44.99",
        "customer_id": "3",
        "address": "123 Main Street",
        "address_2": "",
        "address_id": "6",
        "city": "Anywhere",
        "credit_number": "8431",
        "credit_type": "American Express",
        "discount_customer": "0",
        "email": "eh@hugel.com",
        "email_template": "",
        "first_name": "Jane",
        "group_id": "1",
        "group_name": "Mailing List",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "1",
        "order_type": "Admin",
        "payment_id": "1",
        "payment_status": "Paid",
        "phone": "",
        "sales_agent": "Sales Agent",
        "sale_credit": "...",
        "shipping_address": "123 Main Street",
        "shipping_address_2": "",
        "shipping_city": "Anywhere",
        "shipping_company": "",
        "shipping_first_name": "Etienne",
        "shipping_last_name": "Hugel",
        "shipping_method": "1",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "UPSGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "(123) 456-7890",
        "shipping_residential": "0",
        "shipping_state": "PA",
        "shipping_zip": "17000",
        "ship_status": "Not Shipped",
        "state": "PA",
        "tax_rate": "0",
        "transaction_id": "1",
        "zip": "17000",
        "payments": [
            {
                "id": "104",
                "uri": "ch_0GXXXXXtl",
                "type": "Debit",
                "gateway": "Stripe",
                "status": "",
                "credit_type": "Visa",
                "account_number": "3745",
                "total": "44.99",
                "fees": "-1.25",
                "tax": "0.00",
                "shipping": "30.00",
                "ca_remption_value": "0.00",
                "tip": "0.00",
                "credits": "0.00",
                "discount": "0.00",
                "order_id": "1",
                "customer_id": "3",
                "parent_id": null,
                "parent_amount": "0",
                "created": "2018-03-14 13:17:06"
            }
        ],
        "products": [
            {
                "id": "1",
                "sku": "12831",
                "name": "Domaine Chêne",
                "type": "",
                "bottle_size": "750mL",
                "retail_price": "14.99",
                "discount": "0.00",
                "discount_type": "",
                "price": "14.99",
                "quantity": "1",
                "status": "",
                "description": "Domaine Chêne ",
                "image": "//s3.amazonaws.com/efcheckout/figureapi/products/12831-9864.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-14 13:17:07"
            }
        ]
    },
    "2": {
        "id": "2-107",
        "figure_id": "2",
        "datestamp": "2018-03-23 16:24:15",
        "last_update": "2018-03-23 16:24:15",
        "status": "",
        "subtotal": "45.00",
        "tax": "3.15",
        "shipping": "20.00",
        "discount": "9.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "59.15",
        "customer_id": "44",
        "address": "",
        "address_2": "",
        "address_id": "3979",
        "birthday": "1982-11-1",
        "city": "",
        "company": "",
        "credit_id": "19",
        "credit_number": "4242",
        "credit_type": "Visa",
        "customer_credits": "0.00",
        "discount_customer": "0.2",
        "email": "example@commercebyfigure.com",
        "first_name": "John",
        "gift_message": "",
        "instructions": "",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "2",
        "order_type": "Web",
        "payment_status": "Paid",
        "phone": "707-287-6262",
        "salutation": "Mr.",
        "shipping_address": "770 3rd St E",
        "shipping_address_2": "",
        "shipping_city": "Sonoma",
        "shipping_company": "",
        "shipping_first_name": "John",
        "shipping_id": "3979",
        "shipping_last_name": "Doe",
        "shipping_method": "11",
        "shipping_method_carrier": "FedEx",
        "shipping_method_code": "FDXGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "707-287-6262",
        "shipping_state": "CA",
        "shipping_title": "Shipping Address",
        "shipping_zip": "95476",
        "ship_status": "Not Shipped",
        "state": "",
        "tax_rate": "8.75",
        "transaction_id": "36",
        "zip": "",
        "payments": [
            {
                "id": "107",
                "uri": "ch_0Gp1MTukqU3e0iSqTvMVrzil",
                "type": "Debit",
                "gateway": "Stripe",
                "status": "",
                "credit_type": "Visa",
                "account_number": "3745",
                "total": "59.15",
                "fees": "-11.25",
                "tax": "3.15",
                "shipping": "20.00",
                "ca_remption_value": "0.00",
                "tip": "0.00",
                "credits": "0.00",
                "discount": "0.0",
                "order_id": "2",
                "customer_id": "44",
                "shipment_id": null,
                "parent_id": null,
                "parent_amount": "0",
                "created": "2020-05-31 17:18:43"
            }
        ],
        "products": [
            {
                "id": "2",
                "sku": "H",
                "name": "2017 Pinot Meunier",
                "type": "",
                "bottle_size": "750mL",
                "retail_price": "0.00",
                "discount": "0.00",
                "discount_type": "",
                "price": "36",
                "quantity": "1",
                "status": "",
                "description": "2017 Pinot Meunier ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-23 16:24:18"
            }
        ]
    }
}
GET /orders/product-transactions/{start}/{end} Get Product Transactions by creation date
Parameters
NameTypeRequiredDescriptionExample
end number Required Date for end of the reporting period
start string Required Date for start of the reporting period
Examples
Request
GET/orders/product-transactions/{start}/{end}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "1": {
        "id": "1",
        "datestamp": "2018-03-14 13:17:05",
        "last_update": "2018-03-14 14:17:05",
        "status": "",
        "subtotal": "14.99",
        "tax": "0.00",
        "shipping": "30.00",
        "discount": "0.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "44.99",
        "customer_id": "3",
        "address": "123 Main Street",
        "address_2": "",
        "address_id": "6",
        "city": "Anywhere",
        "credit_number": "8431",
        "credit_type": "American Express",
        "discount_customer": "0",
        "email": "eh@hugel.com",
        "email_template": "",
        "first_name": "Jane",
        "group_id": "1",
        "group_name": "Mailing List",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "1",
        "order_type": "Admin",
        "payment_id": "1",
        "payment_status": "Paid",
        "phone": "",
        "sales_agent": "Sales Agent",
        "sale_credit": "...",
        "shipping_address": "123 Main Street",
        "shipping_address_2": "",
        "shipping_city": "Anywhere",
        "shipping_company": "",
        "shipping_first_name": "Etienne",
        "shipping_last_name": "Hugel",
        "shipping_method": "1",
        "shipping_method_carrier": "custom",
        "shipping_method_code": "UPSGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "(123) 456-7890",
        "shipping_residential": "0",
        "shipping_state": "PA",
        "shipping_zip": "17000",
        "ship_status": "Not Shipped",
        "state": "PA",
        "tax_rate": "0",
        "transaction_id": "1",
        "zip": "17000",
        "products": [
            {
                "id": "1",
                "sku": "12831",
                "name": "Domaine Chêne",
                "type": "",
                "bottle_size": "",
                "retail_price": "14.99",
                "discount": "0.00",
                "discount_type": "",
                "price": "14.99",
                "quantity": "1",
                "status": "",
                "description": "Domaine Chêne ",
                "image": "//s3.amazonaws.com/efcheckout/figureapi/products/12831-9864.jpg",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-14 13:17:07"
            }
        ]
    },
    "2": {
        "id": "2",
        "datestamp": "2018-03-23 16:24:15",
        "last_update": "2018-03-23 16:24:15",
        "status": "",
        "subtotal": "45.00",
        "tax": "3.15",
        "shipping": "20.00",
        "discount": "9.00",
        "credits": "0.00",
        "refund": "0.00",
        "total": "59.15",
        "customer_id": "1",
        "address": "",
        "address_2": "",
        "address_id": "3979",
        "birthday": "1982-11-1",
        "city": "",
        "company": "",
        "credit_id": "19",
        "credit_number": "4242",
        "credit_type": "Visa",
        "customer_credits": "0.00",
        "discount_customer": "0.2",
        "email": "example@commercebyfigure.com",
        "first_name": "John",
        "gift_message": "",
        "instructions": "",
        "item_count": "1",
        "last_name": "Doe",
        "order_id": "42",
        "order_type": "Web",
        "payment_status": "Paid",
        "phone": "707-287-6262",
        "salutation": "Mr.",
        "shipping_address": "770 3rd St E",
        "shipping_address_2": "",
        "shipping_city": "Sonoma",
        "shipping_company": "",
        "shipping_first_name": "John",
        "shipping_id": "3979",
        "shipping_last_name": "Doe",
        "shipping_method": "11",
        "shipping_method_carrier": "FedEx",
        "shipping_method_code": "FDXGND",
        "shipping_method_name": "Ground",
        "shipping_phone": "707-287-6262",
        "shipping_state": "CA",
        "shipping_title": "Shipping Address",
        "shipping_zip": "95476",
        "ship_status": "Not Shipped",
        "state": "",
        "tax_rate": "8.75",
        "transaction_id": "36",
        "zip": "",
        "products": [
            {
                "id": "42",
                "sku": "H",
                "name": "2017 Pinot Meunier",
                "type": "",
                "bottle_size": "750mL",
                "retail_price": "0.00",
                "discount": "0.00",
                "discount_type": "",
                "price": "45",
                "quantity": "1",
                "status": "",
                "description": "2017 Pinot Meunier ",
                "image": "",
                "stock_status": "",
                "shipped": "0",
                "created": "2018-03-23 16:24:18"
            }
        ]
    }
}
GET /orders/notes/created/{start}/{end}/{limit}/{page} Get Order Notes by Date
Parameters
NameTypeRequiredDescriptionExample
end number Required Unix Time stamp for end of reporting period
limit number Required Number of records returned per page
page number Required Page Number
start number Required Unix Time stamp for beginning of reporting period
Examples
Request
GET/orders/notes/created/{start}/{end}/{limit}/{page}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "518631",
        "order_id": "24102",
        "created": "2025-08-01 12:12:42",
        "type": "Admin",
        "category": "General",
        "user_id": "1334",
        "user_name": "Admin User",
        "message": "$113.40 Payment Added"
    },
    {
        "id": "518630",
        "order_id": "24102",
        "created": "2025-08-07 12:11:37",
        "type": "Admin",
        "category": "General",
        "user_id": "1334",
        "user_name": "Admin user",
        "message": "Customer Requested Wines be Held by UPS"
    }
]
GET /orders/payment-transactions/{start}/{end} Get Payment Transactions by creation date
Parameters
NameTypeRequiredDescriptionExample
end number Required Date for end of the reporting period
start string Required Date for start of the reporting period
Examples
Request
GET/orders/payment-transactions/{start}/{end}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
[
    {
        "id": "5551234",
        "uri": "ch_XXXXXXXpagdj",
        "type": "Debit",
        "gateway": "Stripe",
        "status": "",
        "credit_type": "Visa",
        "account_number": "1234",
        "total": "75.00",
        "fees": "-3.50",
        "tax": "15.00",
        "shipping": "10.00",
        "credits": "0.00",
        "discount": "0.00",
        "order_id": "12345678",
        "customer_id": "12345",
        "shipment_id": null,
        "parent_id": null,
        "parent_amount": "0",
        "created": "2020-01-27 18:02:35"
    },
    {
        "id": "5551235",
        "uri": "ch_XXXXXQNBRP",
        "type": "Debit",
        "gateway": "Stripe",
        "status": "",
        "credit_type": "Visa",
        "account_number": "5555",
        "total": "150.00",
        "fees": "-7.00",
        "tax": "30.00",
        "shipping": "20.00",
        "credits": "0.00",
        "discount": "0.00",
        "order_id": "12345679",
        "customer_id": "12347",
        "shipment_id": null,
        "parent_id": null,
        "parent_amount": "0",
        "created": "2020-01-27 20:04:47"
    }
]

Products

Resources related to Products.

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

Wishes

Resources related to Wishes.

GET /wishes Get List of Active Wishes
Examples
Request
GET/wishes
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "Wish-245445-wo-742847": {
        "items": {
            "KB20GC76": {
                "session": "Wish-245445-wo-742847",
                "sku": "KB20GC76",
                "retail_price": "100.00",
                "discount": "0.00",
                "discount_type": "",
                "quantity": "1",
                "price": "100.00",
                "description": "2020 Gap’s Crown Vineyard Sonoma Coast Pinot Noir",
                "location": "",
                "expires": "0000-00-00 00:00:00",
                "reserve_inventory": "0"
            },
            "KB20GR76": {
                "session": "Wish-245445-wo-742847",
                "sku": "KB20GR76",
                "retail_price": "100.00",
                "discount": "0.00",
                "discount_type": "",
                "quantity": "1",
                "price": "100.00",
                "description": "2020 Giusti Ranch Russian River Valley Pinot Noir",
                "location": "",
                "expires": "0000-00-00 00:00:00",
                "reserve_inventory": "0"
            }
        },
        "config": {
            "address_id": "999417",
            "customer_id": "999445",
            "discount_case": "0",
            "manual_address": "",
            "order_id": "wo-742847",
            "original_wish_date": "2022-08-03 14:11:06",
            "payment_id": "96973",
            "saved_order": "1",
            "shipping_address": "123 N McDonald Blvd",
            "shipping_address_2": "",
            "shipping_birthday": "02/15/1990",
            "shipping_city": "Petaluma",
            "shipping_company": "",
            "shipping_country": "US",
            "shipping_email": "anicolai@kostabrowne.com",
            "shipping_first_name": "Jon",
            "shipping_last_name": "Doe",
            "shipping_method": "4",
            "shipping_phone": "707-555-4321",
            "shipping_state": "CA",
            "shipping_zip": "94954",
            "tax_city": "Petaluma",
            "tax_county": "Sonoma",
            "tax_jurisdiction": "CA,SONOMA CA BRADLEY BURNS TAX,SONOMA CA COUNTY TAX,CITY OF PETALUMA (SONOMA COUNTY) CA DISTRICT TAX,SONOMA COUNTY CA DISTRICT TAX,SONOMA COUNTY TRANSPORTATION CA DISTRICT TAX",
            "tax_method": "ShipCompliant",
            "tax_state": "CA",
            "tax_zip": "94954-2305",
            "type": "Wish",
            "wish_only": "1"
        }
    },
    "Wish-37322-wo-902185": {
        "items": {
            "KB19CP76": {
                "session": "Wish-37322-wo-902185",
                "sku": "KB19CP76",
                "retail_price": "125.00",
                "discount": "0.00",
                "discount_type": "",
                "quantity": "1",
                "price": "125.00",
                "description": "2019 Cerise Vineyard Anderson Valley Pinot Noir",
                "location": "",
                "expires": "0000-00-00 00:00:00",
                "reserve_inventory": "0"
            },
            "KB19TH76": {
                "session": "Wish-37322-wo-902185",
                "sku": "KB19TH76",
                "retail_price": "125.00",
                "discount": "0.00",
                "discount_type": "",
                "quantity": "1",
                "price": "125.00",
                "description": "2019 Treehouse Vineyard Russian River Valley Pinot Noir",
                "location": "",
                "expires": "0000-00-00 00:00:00",
                "reserve_inventory": "0"
            }
        },
        "config": {
            "address_id": "99289",
            "customer_id": "99922",
            "discount_case": "0",
            "last_error": "Your card has expired.",
            "manual_address": "",
            "order_id": "wo-902185",
            "original_wish_date": "2022-04-26 20:55:30",
            "payment_id": "107257",
            "requested_ship_date": "2022-05-16",
            "saved_order": "1",
            "shipping_address": "3042 Westside Ave",
            "shipping_address_2": "",
            "shipping_birthday": "1965-11-19",
            "shipping_city": "Cleveland",
            "shipping_company": "WEWS",
            "shipping_country": "US",
            "shipping_email": "",
            "shipping_first_name": "John ",
            "shipping_last_name": "Smith",
            "shipping_method": "20",
            "shipping_phone": "2165553768",
            "shipping_state": "OH",
            "shipping_zip": "44115",
            "tax_city": "Cleveland",
            "tax_county": "Cuyahoga",
            "tax_jurisdiction": "",
            "tax_method": "ShipCompliant",
            "tax_state": "OH",
            "tax_zip": "44115-2516",
            "type": "Wish",
            "wish_only": "1"
        }
    }
}
GET /wishes/{session_id} Get Wish By Session Id
Parameters
NameTypeRequiredDescriptionExample
session_id string Required Session Id
Examples
Request
GET/wishes/{session_id}
Headers
Content-Type: application/json
X-Auth-Token: XXXXXXXXX
Response
Headers · 200
Content-Type: application/json
Body
{
    "items": {
        "KB20GC76": {
            "session": "Wish-245445-wo-742847",
            "sku": "KB20GC76",
            "retail_price": "100.00",
            "discount": "0.00",
            "discount_type": "",
            "quantity": "1",
            "price": "100.00",
            "description": "2020 Gap’s Crown Vineyard Sonoma Coast Pinot Noir",
            "location": "",
            "expires": "0000-00-00 00:00:00",
            "reserve_inventory": "0"
        },
        "KB20GR76": {
            "session": "Wish-245445-wo-742847",
            "sku": "KB20GR76",
            "retail_price": "100.00",
            "discount": "0.00",
            "discount_type": "",
            "quantity": "1",
            "price": "100.00",
            "description": "2020 Giusti Ranch Russian River Valley Pinot Noir",
            "location": "",
            "expires": "0000-00-00 00:00:00",
            "reserve_inventory": "0"
        }
    },
    "config": {
        "address_id": "999417",
        "customer_id": "999445",
        "discount_case": "0",
        "manual_address": "",
        "order_id": "wo-742847",
        "original_wish_date": "2022-08-03 14:11:06",
        "payment_id": "96973",
        "saved_order": "1",
        "shipping_address": "123 N McDonald Blvd",
        "shipping_address_2": "",
        "shipping_birthday": "02/15/1990",
        "shipping_city": "Petaluma",
        "shipping_company": "",
        "shipping_country": "US",
        "shipping_email": "anicolai@kostabrowne.com",
        "shipping_first_name": "Jon",
        "shipping_last_name": "Doe",
        "shipping_method": "4",
        "shipping_phone": "707-555-4321",
        "shipping_state": "CA",
        "shipping_zip": "94954",
        "tax_city": "Petaluma",
        "tax_county": "Sonoma",
        "tax_jurisdiction": "CA,SONOMA CA BRADLEY BURNS TAX,SONOMA CA COUNTY TAX,CITY OF PETALUMA (SONOMA COUNTY) CA DISTRICT TAX,SONOMA COUNTY CA DISTRICT TAX,SONOMA COUNTY TRANSPORTATION CA DISTRICT TAX",
        "tax_method": "ShipCompliant",
        "tax_state": "CA",
        "tax_zip": "94954-2305",
        "type": "Wish",
        "wish_only": "1"
    }
}
Public URL copied