API Documentation

# Vendors

This is an object representing a vendor. Vendors may be assigned to booths.

# The vendor object

# Attributes

  • id integer - Globally unique identifier for the object
  • organization string - Company/organization name
  • first_name string - First name
  • middle_name string - Optional middle name
  • last_name string - Last name
  • title string - Title of the contact
  • email string - Email address
  • phone string - Phone number
  • phone_cell string - Cell phone number
  • phone_work string - Work phone number
  • phone_home string - Home phone number
  • fax string - Fax number
  • address1 string - Street address
  • address2 string - Optional second line of address
  • city string - City
  • region string - State/Region/Province (two character ISO 3166-2 (opens new window) code) expandable
  • country string - Country (two character ISO 3166-1 alpha-2 (opens new window) code) expandable
  • website string - Website url
  • facebook string - Facebook id or full url
  • twitter string - Twitter id or full url
  • instagram string - Instagram id or full url
  • youtube string - YouTube id or full url
  • yelp string - Yelp id or full url
  • linkedin string - LinkedIn id or full url
  • past_vendor boolean - Has this vendor been a vendor in a past event for this client
  • past_vendor_info string - More information regarding past vendor history
  • electricity_required boolean - Is electricity required at the booth
  • electricity_info string - More information regarding electricity, commonly includes volts/amps
  • gas_required boolean - Is gas required at the booth
  • gas_info string - More information regarding gas
  • water_required boolean - Is water required at the booth
  • water_info string - More information regarding water
  • ice_required boolean - Is ice required at the booth
  • ice_info string - More information regarding ice
  • trailer_required boolean - Is a trailer required
  • trailer_info string - More information regarding trailers
  • truck_required boolean - Is a truck required
  • truck_info string - More information regarding trucks
  • canopy_required boolean - Is a canopy required
  • canopy_info string - More information regarding canopies
  • donation string - Is the vendor providing a donation
  • donation_type string - Type of donation (monetary, in-kind, etc)
  • donation_description string - Donation description
  • donation_value string - Value of donation
  • tax_exempt_number string - A number assigned by a state agency to identify the entity or organization as exempt from state sales taxes (if available)
  • ein_number string - A unique nine-digit number assigned by the Internal Revenue Service to business entities operating in the United States for the purposes of identification
  • sub_total integer - A positive integer representing the sub-total of the vendor in the smallest currency unit (opens new window)
  • registration_fees integer - A positive integer representing the registration fees for the vendor in the smallest currency unit (opens new window)
  • merchant_fees integer - A positive integer representing the merchant fees for the vendor in the smallest currency unit (opens new window)
  • fee_total integer - A positive integer equal to the sum of all fees for the vendor in the smallest currency unit (opens new window)
  • discount_total integer - A positive integer representing the discounted amount for the vendor in the smallest currency unit (opens new window) if a coupon was applied
  • grand_total integer - A positive integer representing the final amount to be charged for the vendor in the smallest currency unit (opens new window)
  • amount_paid integer - A positive integer representing the amount paid by the vendor in the smallest currency unit (opens new window)
  • amount_unpaid integer - A positive integer representing the amount unpaid by the vendor in the smallest currency unit (opens new window)
  • token string - Globally unique identifier for the vendor (UUID)
  • referred_by string - How did the vendor hear about the event
  • transaction_id string - Unique identifier from merchant for the vendor's payment
  • customer_id string - Unique identifier from merchant for the vendor's customer
  • status integer - Status code for the vendor
  • status_name string - Status name for the vendor
  • type integer | object - Vendor type expandable
  • category integer | object - Vendor category expandable
  • booths array - Vendor's booths expandable
  • uploads array - Uploaded files attached to the vendor, if any expandable
  • coupon integer | object - Coupon applied to the vendor, if any expandable
  • currency integer | object - Currency of the vendor's payment expandable
  • client integer | object - ID of the client that this vendor belongs to expandable
  • event integer | object - ID of the event that this vendor belongs to expandable
  • created_at integer - Unix timestamp at which the vendor was created
  • updated_at integer - Unix timestamp at which the vendor was last updated
  • applied_at integer - Unix timestamp at which the vendor applied
  • approved_at integer - Unix timestamp at which the vendor was approved
  • rejected_at integer - Unix timestamp at which the vendor was rejected
  • cancelled_at integer - Unix timestamp at which the vendor was cancelled
  • paid_at integer - Unix timestamp at which the vendor made payment
  • refunded_at integer - Unix timestamp at which the vendor was refunded
  • additional_data string optional - JSON structured data

# Statuses

  1. Incomplete - Vendor has started but not submitted an application
  2. Complete - Vendor has submitted an application or has been created in the admin
  3. Approved - Vendor has been approved
  4. Rejected - Vendor has been rejected
  5. Cancelled - Vendor has been cancelled

# Example object

{
    "id": 5932,
    "organization": "ABCD Inc.",
    "first_name": "Joe",
    "middle_name": null,
    "last_name": "Event",
    "title": "President",
    "email": "joe@event.com",
    "phone": "(555) 555-5555",
    "phone_cell": "(555) 555-5554",
    "phone_work": null,
    "phone_home": null,
    "fax": null,
    "address1": "1400 Lincoln Ave",
    "address2": "#7",
    "city": "Los Angeles",
    "postal_code": "90013",
    "region": "CA",
    "country": "US",
    "website": "https://event.com",
    "facebook": "https://www.facebook.com/ABCDfestival/",
    "twitter": null,
    "instagram": "https://www.instagram.com/ABCDfestival/",
    "youtube": null,
    "yelp": null,
    "linkedin": null,
    "sub_total": 10000,
    "registration_fees": 500,
    "merchant_fees": 340,
    "fee_total": 840,
    "discount_total": 0,
    "grand_total": 10840,
    "amount_paid": 10840,
    "amount_unpaid": 0,
    "token": "e5e4de0e-5082-4b53-8f54-833084e01a70",
    "referred_by": "Twitter",
    "transaction_id": "pi_1Dor642eZvKYlo2C96OeaLE5",
    "customer_id": "cus_Jpjiu3VIaWAoTr",
    "status": 3,
    "status_name": "Approved",
    "booths": [
        {
            "id": 51451,
            "name": "Booth H5",
            "number": 5,
            "section": "H",
            "description": null,
            "size": "10 ft by 20 ft",
            "price": 10000,
            "quantity": 1,
            "amount": 10000,
            "category": {
                "id": 481,
                "name": "Main Street Booths",
            },
            "quantity_available": 1,
            "created_at": 1626043169,
            "updated_at": null,
        },
        {...},
    ],
    "uploads": [],
    "coupon": null,
    "currency": 1,
    "client": 735,
    "event": 9614,
    "created_at": 1626043169,
    "updated_at": 1626018869,
    "applied_at": 1626018869,
    "approved_at": 1626019723,
    "rejected_at": null,
    "cancelled_at": null,
    "paid_at": 1626093721,
    "refunded_at": null,
    "test_data": false,
    "additional_data": null
}

# Retrieve a vendor

Retrieves the details of an existing vendor by the unique vendor identifier.

# Parameters

none

# Returns

Returns a vendor if a valid identifier was provided, and returns an error otherwise.

# Example request

# GET /v1/vendors/41941

curl https://api.ee4.events/v1/vendors/41941 \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc:

# Example response

{
    "id": 5932,
    "organization": "ABCD Inc.",
    "first_name": "Joe",
    "middle_name": null,
    "last_name": "Event",
    "title": "President",
    "email": "joe@event.com",
    "phone": "(555) 555-5555",
    "phone_cell": "(555) 555-5554",
    "phone_work": null,
    "phone_home": null,
    "fax": null,
    "address1": "1400 Lincoln Ave",
    "address2": "#7",
    "city": "Los Angeles",
    "postal_code": "90013",
    "region": "CA",
    "country": "US",
    "website": "https://event.com",
    "facebook": "https://www.facebook.com/ABCDfestival/",
    "twitter": null,
    "instagram": "https://www.instagram.com/ABCDfestival/",
    "youtube": null,
    "yelp": null,
    "linkedin": null,
    "sub_total": 10000,
    "registration_fees": 500,
    "merchant_fees": 340,
    "fee_total": 840,
    "discount_total": 0,
    "grand_total": 10840,
    "amount_paid": 10840,
    "amount_unpaid": 0,
    "token": "e5e4de0e-5082-4b53-8f54-833084e01a70",
    "referred_by": "Twitter",
    "transaction_id": "pi_1Dor642eZvKYlo2C96OeaLE5",
    "customer_id": "cus_Jpjiu3VIaWAoTr",
    "status": 3,
    "status_name": "Approved",
    "booths": [
        {
            "id": 51451,
            "name": "Booth H5",
            "number": 5,
            "section": "H",
            "description": null,
            "size": "10 ft by 20 ft",
            "price": 10000,
            "quantity": 1,
            "amount": 10000,
            "category": {
                "id": 481,
                "name": "Main Street Booths",
            },
            "quantity_available": 1,
            "created_at": 1626043169,
            "updated_at": null,
        },
        {...},
    ],
    "uploads": [],
    "coupon": null,
    "currency": 1,
    "client": 735,
    "event": 9614,
    "created_at": 1626043169,
    "updated_at": 1626018869,
    "applied_at": 1626018869,
    "approved_at": 1626019723,
    "rejected_at": null,
    "cancelled_at": null,
    "paid_at": 1626093721,
    "refunded_at": null,
    "test_data": false,
    "additional_data": null
}

# Create a vendor

Create a new vendor.

# Parameters

  • currency string | integer - Currency of the vendor, defaults to USD (1) if ommitted
  • client_id integer required - ID of the client that this vendor belongs to
  • event_id integer - ID of the event that this vendor belongs to, defaults to the next upcoming event if ommitted

# Returns

Returns a vendor if creation was successful, and returns an error otherwise.

# Example request

# POST /v1/vendors

curl https://api.ee4.events/v1/vendors \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d client_id=735 \
  -d event_id=9614 \
  -d currency=usd \
  -d price=1000 \
  -d price_door=1500 \
  -d inventory=250 \
  -d enforce_inventory=1 \
  -d name="GA Saturday Ticket" \
  -d abbreviation="GA-SAT" \
  -d number="ABCD-GA-SAT1" \
  -d description="All GA tickets include OPEN BAR, spectacular performances, amazing DJ's and more! Only 250 tickets available." \
  -d type=1 \
  -d bg_color="#ff0000" \
  -d text_color="#ffffff" \
  -d sort_order=1

# Example response

{
    "id": 5932,
    "organization": "ABCD Inc.",
    "first_name": "Joe",
    "middle_name": null,
    "last_name": "Event",
    "title": "President",
    "email": "joe@event.com",
    "phone": "(555) 555-5555",
    "phone_cell": "(555) 555-5554",
    "phone_work": null,
    "phone_home": null,
    "fax": null,
    "address1": "1400 Lincoln Ave",
    "address2": "#7",
    "city": "Los Angeles",
    "postal_code": "90013",
    "region": "CA",
    "country": "US",
    "website": "https://event.com",
    "facebook": "https://www.facebook.com/ABCDfestival/",
    "twitter": null,
    "instagram": "https://www.instagram.com/ABCDfestival/",
    "youtube": null,
    "yelp": null,
    "linkedin": null,
    "sub_total": 10000,
    "registration_fees": 500,
    "merchant_fees": 340,
    "fee_total": 840,
    "discount_total": 0,
    "grand_total": 10840,
    "amount_paid": 10840,
    "amount_unpaid": 0,
    "token": "e5e4de0e-5082-4b53-8f54-833084e01a70",
    "referred_by": "Twitter",
    "transaction_id": "pi_1Dor642eZvKYlo2C96OeaLE5",
    "customer_id": "cus_Jpjiu3VIaWAoTr",
    "status": 3,
    "status_name": "Approved",
    "booths": [
        {
            "id": 51451,
            "name": "Booth H5",
            "number": 5,
            "section": "H",
            "description": null,
            "size": "10 ft by 20 ft",
            "price": 10000,
            "quantity": 1,
            "amount": 10000,
            "category": {
                "id": 481,
                "name": "Main Street Booths",
            },
            "quantity_available": 1,
            "created_at": 1626043169,
            "updated_at": null,
        },
        {...},
    ],
    "uploads": [],
    "coupon": null,
    "currency": 1,
    "client": 735,
    "event": 9614,
    "created_at": 1626043169,
    "updated_at": 1626018869,
    "applied_at": 1626018869,
    "approved_at": 1626019723,
    "rejected_at": null,
    "cancelled_at": null,
    "paid_at": 1626093721,
    "refunded_at": null,
    "test_data": false,
    "additional_data": null
}

# Update a vendor

Updates vendor properties/cart contents without completing. When payment is ready to be processed, complete the vendor.

# Parameters

  • name string required - Full name of the vendor
  • abbreviation string - Short abbreviation of the vendor name (max length of 10, will be converted to uppercase)
  • number string - Optional vendor number
  • description string - Description of the vendor
  • image string - Optional image to be displayed on the ticket/vendor page
  • price integer required - A positive integer equal to the base price for the vendor in the smallest currency unit (opens new window)
  • vendor_fees integer - A positive integer equal to the vendor fees for the vendor in the smallest currency unit (opens new window)
  • shipping_fees integer - A positive integer equal to the shipping fees for the vendor in the smallest currency unit (opens new window)
  • price_door integer - A positive integer equal to the door price for the vendor in the smallest currency unit (opens new window)
  • price_early integer - A positive integer equal to the early-bird price for the vendor in the smallest currency unit (opens new window)
  • price_early_ends_at integer - Unix timestamp on or after which the early-bird price expires and base price takes effect
  • inventory integer - The quantity available to purchase
  • enforce_inventory boolean - Dictates whether the inventory availability by quantity above is enforced or not
  • is_shipped boolean - Dictates whether the vendor is to be shipped
  • starts_at integer - Unix timestamp on or after which the vendor becomes available to purchase
  • ends_at integer - Unix timestamp on or after which the vendor becomes unavailable to purchase
  • enforce_timeframe boolean - Dictates whether the vendor availability by time period above is enforced or not
  • type integer required - Type code of vendor
  • category_id integer required - ID of the category that this vendor belongs to expandable
  • test_data boolean - Indicates whether the vendor is intended to be used only for testing
  • bg_color string - Hexadecimal color of the vendor's background
  • text_color string - Hexadecimal color of the vendor's text
  • sort_order integer - Sort order
  • status integer required - Status code for the vendor
  • currency integer | object - Currency of the vendor expandable
  • additional_data object optional - HTML data to be displayed on the printed ticket
    • additional_data.date_and_time string optional - The date and time of the event for this ticket
    • additional_data.location string optional - The location of the event for this ticket
    • additional_data.body string optional - The body/disclaimer text for this ticket

# Returns

Returns the vendor.

# Example request

# POST /v1/vendors/41941

curl https://api.ee4.events/v1/vendors/41941 \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d price=1750 \
  -d price_door=2000 \
  -d name="GA Sunday Ticket" \
  -d abbreviation="GA-SUN" \
  -d number="ABCD-GA-SUN" \

# Example response

{
    "id": 5932,
    "organization": "ABCD Inc.",
    "first_name": "Joe",
    "middle_name": null,
    "last_name": "Event",
    "title": "President",
    "email": "joe@event.com",
    "phone": "(555) 555-5555",
    "phone_cell": "(555) 555-5554",
    "phone_work": null,
    "phone_home": null,
    "fax": null,
    "address1": "1400 Lincoln Ave",
    "address2": "#7",
    "city": "Los Angeles",
    "postal_code": "90013",
    "region": "CA",
    "country": "US",
    "website": "https://event.com",
    "facebook": "https://www.facebook.com/ABCDfestival/",
    "twitter": null,
    "instagram": "https://www.instagram.com/ABCDfestival/",
    "youtube": null,
    "yelp": null,
    "linkedin": null,
    "sub_total": 10000,
    "registration_fees": 500,
    "merchant_fees": 340,
    "fee_total": 840,
    "discount_total": 0,
    "grand_total": 10840,
    "amount_paid": 10840,
    "amount_unpaid": 0,
    "token": "e5e4de0e-5082-4b53-8f54-833084e01a70",
    "referred_by": "Twitter",
    "transaction_id": "pi_1Dor642eZvKYlo2C96OeaLE5",
    "customer_id": "cus_Jpjiu3VIaWAoTr",
    "status": 3,
    "status_name": "Approved",
    "booths": [
        {
            "id": 51451,
            "name": "Booth H5",
            "number": 5,
            "section": "H",
            "description": null,
            "size": "10 ft by 20 ft",
            "price": 10000,
            "quantity": 1,
            "amount": 10000,
            "category": {
                "id": 481,
                "name": "Main Street Booths",
            },
            "quantity_available": 1,
            "created_at": 1626043169,
            "updated_at": null,
        },
        {...},
    ],
    "uploads": [],
    "coupon": null,
    "currency": 1,
    "client": 735,
    "event": 9614,
    "created_at": 1626043169,
    "updated_at": 1626018869,
    "applied_at": 1626018869,
    "approved_at": 1626019723,
    "rejected_at": null,
    "cancelled_at": null,
    "paid_at": 1626093721,
    "refunded_at": null,
    "test_data": false,
    "additional_data": null
}

# Delete a vendor

Deletes a vendor. It cannot be undone. Existing orders with carts containing this vendor will still display the ordered vendor information for record-keeping.

# Parameters

  • none

# Returns

Returns an object with a deleted parameter on success. If the vendor ID does not exist, this call returns an error.

Unlike other objects, deleted vendors can still be retrieved through the API, in order to be able to track the history of orders while still preventing any further vendors to be purchased.

# Example request

# DELETE /v1/vendors/41941

curl https://api.ee4.events/v1/vendors/41941 \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -X DELETE

# Example response

{
    "id": 41941,
    "object": "vendor",
    "deleted": true
}

# List all vendors

Returns a list of vendors created. The vendors are returned in sorted order, with the most recently created vendors appearing first.

# Parameters

  • limit integer optional - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • category_id string optional - Only return vendors for the category specified by this category ID.
  • ending_before string optional - A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in vendor to fetch the previous page of the list.
  • starting_after string optional - A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in vendor to fetch the next page of the list.
  • event_id integer optional - Only return vendors belonging to the specified event.

# Returns

A dictionary with a data property that contains an array of up to limit vendors, starting after vendor starting_after. Each entry in the array is a separate vendor object. If no more vendors are available, the resulting array will be empty. If you provide a non-existent vendor ID, this call returns an error.

# Example request

# GET /v1/vendors

curl https://api.ee4.events/v1/vendors \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d limit=3 \
  -G

# Example response

{
    "object": "list",
    "url": "/v1/vendors",
    "has_more": false,
    "data": [
        {
            "id": 5932,
            "organization": "ABCD Inc.",
            "first_name": "Joe",
            "middle_name": null,
            "last_name": "Event",
            "title": "President",
            "email": "joe@event.com",
            "phone": "(555) 555-5555",
            "phone_cell": "(555) 555-5554",
            "phone_work": null,
            "phone_home": null,
            "fax": null,
            "address1": "1400 Lincoln Ave",
            "address2": "#7",
            "city": "Los Angeles",
            "postal_code": "90013",
            "region": "CA",
            "country": "US",
            "website": "https://event.com",
            "facebook": "https://www.facebook.com/ABCDfestival/",
            "twitter": null,
            "instagram": "https://www.instagram.com/ABCDfestival/",
            "youtube": null,
            "yelp": null,
            "linkedin": null,
            "sub_total": 10000,
            "registration_fees": 500,
            "merchant_fees": 340,
            "fee_total": 840,
            "discount_total": 0,
            "grand_total": 10840,
            "amount_paid": 10840,
            "amount_unpaid": 0,
            "token": "e5e4de0e-5082-4b53-8f54-833084e01a70",
            "referred_by": "Twitter",
            "transaction_id": "pi_1Dor642eZvKYlo2C96OeaLE5",
            "customer_id": "cus_Jpjiu3VIaWAoTr",
            "status": 3,
            "status_name": "Approved",
            "booths": [
                {
                    "id": 51451,
                    "name": "Booth H5",
                    "number": 5,
                    "section": "H",
                    "description": null,
                    "size": "10 ft by 20 ft",
                    "price": 10000,
                    "quantity": 1,
                    "amount": 10000,
                    "category": {
                        "id": 481,
                        "name": "Main Street Booths",
                    },
                    "quantity_available": 1,
                    "created_at": 1626043169,
                    "updated_at": null,
                },
                {...},
            ],
            "uploads": [],
            "coupon": null,
            "currency": 1,
            "client": 735,
            "event": 9614,
            "created_at": 1626043169,
            "updated_at": 1626018869,
            "applied_at": 1626018869,
            "approved_at": 1626019723,
            "rejected_at": null,
            "cancelled_at": null,
            "paid_at": 1626093721,
            "refunded_at": null,
            "test_data": false,
            "additional_data": null
        },
        {...},
        {...}
    ]
}

←