Base URL

https://api.venuerun.com/merchants

Merchants

The merchant API to manage your merchant data from external applications.

This doc was generated by our interal API tester at 11/11/2024, 1:59:24 AM

Endpoints

GET /merchants/:merchantId
POST /merchants/:merchantId

The Merchant Object

Properties

  • Name
    name
    Type
    string
    Description
    Name of the merchant
  • Name
    description
    Type
    string
    Description
    Description of the merchant
  • Name
    address
    Type
    object
    Description
    Address of the merchant
  • Name
    line_1
    Type
    string
    Description
    First line of the address
  • Name
    line_2
    Type
    string
    Description
    Second line of the address
  • Name
    city
    Type
    string
    Description
    City of the address
  • Name
    state
    Type
    string
    Description
    State of the address
  • Name
    postal_code
    Type
    string
    Description
    Postal code of the address
  • Name
    country
    Type
    string
    Description
    Country of the address
  • Name
    timeZone
    Type
    string
    Description
    Time zone of the merchant
  • Name
    email
    Type
    string
    Description
    Email address of the merchant
  • Name
    phone
    Type
    string
    Description
    Phone number of the merchant
  • Name
    website
    Type
    string
    Description
    Website of the merchant
  • Name
    checkoutOptions
    Type
    object
    Description
    Checkout options for the merchant
  • Name
    paymentProcessor
    Type
    string
    Description
    Payment processor to be used
  • Name
    paused
    Type
    boolean
    Description
    Is the checkout process paused
  • Name
    collectTips
    Type
    boolean
    Description
    Should tips be collected
  • Name
    preparationTime
    Type
    number
    Description
    Preparation time for orders
  • Name
    enablePayLater
    Type
    boolean
    Description
    Enable pay later option
  • Name
    restrictUPCItemsToMenuTimes
    Type
    boolean
    Description
    Restrict UPC items to menu times
  • Name
    requireAgeRestriction
    Type
    boolean
    Description
    Require age restriction
  • Name
    ageRestriction
    Type
    number
    Description
    Age restriction
  • Name
    enableGroupOrdering
    Type
    boolean
    Description
    Enable group ordering
  • Name
    fulfillmentTypes
    Type
    object
    Description
    Fulfillment types available
  • Name
    pickup
    Type
    boolean
    Description
    Pickup option
  • Name
    delivery
    Type
    boolean
    Description
    Delivery option
  • Name
    tag
    Type
    boolean
    Description
    Tag option
  • Name
    selfCheckout
    Type
    boolean
    Description
    Self-checkout option
  • Name
    tab
    Type
    boolean
    Description
    Tab option
  • Name
    pickupMethods
    Type
    object
    Description
    Pickup methods available
  • Name
    counter
    Type
    boolean
    Description
    Counter pickup method
  • Name
    table
    Type
    boolean
    Description
    Table pickup method
  • Name
    curbside
    Type
    boolean
    Description
    Curbside pickup method
  • Name
    driveThrough
    Type
    boolean
    Description
    Drive-through pickup method
  • Name
    pickUpPaddingTime
    Type
    number
    Description
    Padding time for pickup
  • Name
    pickupTimeSlotsInterval
    Type
    number
    Description
    Interval for pickup time slots
  • Name
    deliveryFee
    Type
    number
    Description
    Fee for delivery
  • Name
    deliveryRaduis
    Type
    number
    Description
    Maximum delivery distance in miles
  • Name
    anonymousSelfCheckout
    Type
    boolean
    Description
    Enable anonymous self-checkout
  • Name
    tagDeliveryFee
    Type
    number
    Description
    Delivery fee for tagged items
  • Name
    requestedTagKeys
    Type
    array
    Description
    Array of requested tag keys
  • Name
    tagKey
    Type
    string
    Description
    A requested tag key
  • Name
    enableTagMetadataEdit
    Type
    boolean
    Description
    Enable editing of tag metadata
  • Name
    taxRate
    Type
    number
    Description
    Tax rate
  • Name
    currency
    Type
    string
    Description
    Currency type
  • Name
    chargeCustomerProcessingFee
    Type
    boolean
    Description
    Charge customer processing fee
  • Name
    chargePlatformFeeToCustomer
    Type
    boolean
    Description
    Charge platform fee to customer
  • Name
    convenienceFee
    Type
    number
    Description
    Convenience fee
  • Name
    chargeConvenienceFeeForCashTransactions
    Type
    boolean
    Description
    Charge convenience fee for cash transactions
  • Name
    googlePlaceId
    Type
    string read-only
    Description
    Google Place ID.
  • Name
    domain
    Type
    string read-only
    Description
    The domain associated with the merchant
  • Name
    handle
    Type
    string read-only
    Description
    The handle, derived from the body
  • Name
    accountHolder
    Type
    string read-only
    Description
    The user ID of the account holder
  • Name
    users
    Type
    object read-only
    Description
    A mapping of user IDs to their access status
  • Name
    userId
    Type
    boolean read-only
    Description
    A user ID with access status
  • Name
    stripeChargesEnabled:sandbox
    Type
    boolean read-only
    Description
    Indicates if charges are enabled in sandbox mode
  • Name
    stripeChargesEnabled:production
    Type
    boolean read-only
    Description
    Indicates if charges are enabled in production mode
  • Name
    stripeAccountId:sandbox
    Type
    string read-only
    Description
    Stripe account ID for sandbox environment
  • Name
    stripeAccountId:production
    Type
    string read-only
    Description
    Stripe account ID for production environment
  • Name
    stripeTerminalLocationId:sandbox
    Type
    string read-only
    Description
    Stripe terminal location ID for sandbox environment
  • Name
    stripeTerminalLocationId:production
    Type
    string read-only
    Description
    Stripe terminal location ID for production environment
  • Name
    squareMerchantId:sandbox
    Type
    string read-only
    Description
    Square merchant ID for sandbox environment
  • Name
    squareLocationId:sandbox
    Type
    string read-only
    Description
    Square location ID for sandbox environment
  • Name
    squareChargesEnabled:sandbox
    Type
    boolean read-only
    Description
    Indicates if Square charges are enabled in sandbox mode
  • Name
    squareMerchantId:production
    Type
    string read-only
    Description
    Square merchant ID for production environment
  • Name
    squareLocationId:production
    Type
    string read-only
    Description
    Square location ID for production environment
  • Name
    squareChargesEnabled:production
    Type
    boolean read-only
    Description
    Indicates if Square charges are enabled in production mode
  • Name
    textTranslations
    Type
    array
    Description
    Array of text translations
  • Name
    search
    Type
    string
    Description
    Text to search for
  • Name
    replace
    Type
    string
    Description
    Text to replace with
  • Name
    colors
    Type
    object
    Description
    Color scheme for the merchant
  • Name
    primary
    Type
    string
    Description
    Primary color
  • Name
    secondary
    Type
    string
    Description
    Secondary color
  • Name
    success
    Type
    string
    Description
    Success color
  • Name
    error
    Type
    string
    Description
    Error color
  • Name
    info
    Type
    string
    Description
    Info color
  • Name
    splashScreenBackground
    Type
    string
    Description
    Splash screen background color
  • Name
    branding
    Type
    object
    Description
    Branding information
  • Name
    banner
    Type
    string
    Description
    Banner image
  • Name
    icon
    Type
    string
    Description
    Icon image
  • Name
    logo
    Type
    string
    Description
    Logo image
  • Name
    logoDark
    Type
    string
    Description
    Dark mode logo image
  • Name
    fonts
    Type
    object
    Description
    Font settings
  • Name
    headlines
    Type
    string
    Description
    Font for headlines
  • Name
    base
    Type
    string
    Description
    Base font
  • Name
    teleport
    Type
    object
    Description
    Teleport settings
  • Name
    enable
    Type
    boolean
    Description
    Enable teleport
  • Name
    destination
    Type
    string
    Description
    URL where users will be redirected to
  • Name
    links
    Type
    array
    Description
    Links to external resources
  • Name
    title
    Type
    string
    Description
    title of the link
  • Name
    url
    Type
    string
    Description
    url of the link
  • Name
    icon
    Type
    string
    Description
    icon of the link
  • Name
    visible
    Type
    string
    Description
    Is the link visible
  • Name
    type
    Type
    string
    Description
    Link type currently only supports 'DEFAULT'
  • Name
    target
    Type
    string
    Description
    Link target. _self to open in the same tab, _blank to open in a new tab
  • Name
    hours
    Type
    array
    Description
    Operating hours
  • Name
    day
    Type
    string
    Description
    Day of the week
  • Name
    open
    Type
    object
    Description
    Opening time
  • Name
    day
    Type
    number
    Description
    Opening day
  • Name
    time
    Type
    string
    Description
    Opening time in HHMM format
  • Name
    close
    Type
    object
    Description
    Closing time
  • Name
    day
    Type
    number
    Description
    Closing day
  • Name
    time
    Type
    string
    Description
    Closing time in HHMM format
  • Name
    isOpen
    Type
    boolean
    Description
    Is the merchant open on this day
  • Name
    openAllDay
    Type
    boolean
    Description
    Is the merchant open all day

Response

{
  accountHolder: "BCmLRQurraf9YXDlrzKFBGQf06D3",
  address: {
    city: "Beloit",
    country: "United States",
    line1: "2301 Cheshire Lane",
    line2: "",
    postal_code: "53511-2377",
    state: "WI",
    zip: "5043"
  },
  branding: {
    banner: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/ICBl2Tc8pbU10Z_0pHbHI.png",
    favicon: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/E2Axa3SMTaSXvEyWfqRzi.ico",
    icon: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/E2Axa3SMTaSXvEyWfqRzi.png",
    logo: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/WtfesJWYI_SRfC2zHYCbW.png",
    logoDark: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/Htdt3hxr9gxgVnF117lcd.png"
  },
  checkoutOptions: {
    ageRestriction: 21,
    anonymousSelfCheckout: false,
    chargeConvenienceFeeForCashTransactions: true,
    chargeCustomerProcessingFee: true,
    chargePlatformFeeToCustomer: true,
    collectTips: true,
    convenienceFee: 3,
    currency: "USD",
    deliveryFee: 2.99,
    deliveryRaduis: 15,
    enableCoupons: true,
    enableGroupOrdering: true,
    enablePayLater: true,
    enableTagMetadataEdit: true,
    forwardOrdersToSquare: false,
    fulfillmentTypes: {
      DELIVERY: true,
      PICKUP: true,
      SELFCHECKOUT: true,
      TAB: true,
      TAG: true
    },
    minimumOrderAmount: 15,
    paused: false,
    paymentProcessor: "STRIPE",
    pickUpPaddingTime: 15,
    pickupMethods: {
      COUNTER: true,
      CURBSIDE: true,
      DRIVE_THROUGH: true,
      TABLE: true
    },
    pickupTimeSlotsInterval: 15,
    preparationTime: 15,
    requestedTagKeys: [],
    requireAgeRestriction: false,
    restrictUPCItemsToMenuTimes: false,
    tagDeliveryFee: 0,
    taxRate: 5.5
  },
  colors: {
    error: "#dc2626",
    info: "#0284c7",
    primary: "#e60000",
    secondary: "#f05153",
    splashScreenBackground: "#212121",
    success: "#059669"
  },
  createdAt: 1469732498,
  deleted: false,
  description: "Sizzling Flavors, Irresistible Eats!",
  domain: "app.grub-grill.com",
  email: "",
  fonts: {
    base: "Default",
    headlines: "Default"
  },
  goals: {
    dailyOrderRevenue: 10000,
    dailyOrderVolume: 100
  },
  googlePlaceId: "",
  handle: "grub-grill",
  hours: [{
      close: {
        day: 0,
        time: "2200"
      },
      day: "Sunday",
      isOpen: true,
      open: {
        day: 0,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 1,
        time: "2200"
      },
      day: "Monday",
      isOpen: true,
      open: {
        day: 1,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 2,
        time: "2200"
      },
      day: "Tuesday",
      isOpen: true,
      open: {
        day: 2,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 3,
        time: "2200"
      },
      day: "Wednesday",
      isOpen: true,
      open: {
        day: 3,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 4,
        time: "2200"
      },
      day: "Thursday",
      isOpen: true,
      open: {
        day: 4,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 5,
        time: "2200"
      },
      day: "Friday",
      isOpen: true,
      open: {
        day: 5,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 6,
        time: "2200"
      },
      day: "Saturday",
      isOpen: true,
      open: {
        day: 6,
        time: "0800"
      },
      openAllDay: true
    }],
  id: "054q775dzyX0nr8Q6bA6",
  language: "en-US",
  links: [],
  locations: {
    _DHqjp9ybTs0fUgdSswPt: {
      enabled: true
    }
  },
  name: "Grub Grill",
  phone: "",
  squareChargesEnabled:production: false,
  squareChargesEnabled:sandbox: true,
  squareLocationId:production: null,
  squareLocationId:sandbox: "L074DZVXKH38M",
  squareMerchantId:production: null,
  squareMerchantId:sandbox: "MLERFZKEEF1Z7",
  status: "ACTIVE",
  stripeAccountId:production: null,
  stripeAccountId:sandbox: "acct_1AyvVSCM9389iSDi",
  stripeChargesEnabled:production: false,
  stripeChargesEnabled:sandbox: true,
  stripeTerminalLocationId:production: null,
  stripeTerminalLocationId:sandbox: null,
  teleport: {
    destination: "",
    enable: false
  },
  textTranslations: [],
  timeZone: "America/Chicago",
  updatedAt: 1731311901,
  users: {
    BCmLRQurraf9YXDlrzKFBGQf06D3: true,
    IdQqfUUruxZKjPUysqHnePU3NNB3: true,
    kFovyJeFj3ZfcY96wkSjKOxsMnE2: true,
    uNpMI89Vg7gfe7h9lV19shwS42a2: true
  },
  website: ""
}

POST/merchants/:merchantId

Update a merchant

This endpoint allows you to update a Merchant

Required parameters

  • Name
    id
    Type
    string
    Description

    id of the Merchant

Optional attributes

  • Name
    name
    Type
    string
    Description
    Name of the merchant
  • Name
    description
    Type
    string
    Description
    Description of the merchant
  • Name
    address
    Type
    object
    Description
    Address of the merchant
  • Name
    line_1
    Type
    string
    Description
    First line of the address
  • Name
    line_2
    Type
    string
    Description
    Second line of the address
  • Name
    city
    Type
    string
    Description
    City of the address
  • Name
    state
    Type
    string
    Description
    State of the address
  • Name
    postal_code
    Type
    string
    Description
    Postal code of the address
  • Name
    country
    Type
    string
    Description
    Country of the address
  • Name
    timeZone
    Type
    string
    Description
    Time zone of the merchant
  • Name
    email
    Type
    string
    Description
    Email address of the merchant
  • Name
    phone
    Type
    string
    Description
    Phone number of the merchant
  • Name
    website
    Type
    string
    Description
    Website of the merchant
  • Name
    checkoutOptions
    Type
    object
    Description
    Checkout options for the merchant
  • Name
    paymentProcessor
    Type
    string
    Description
    Payment processor to be used
  • Name
    paused
    Type
    boolean
    Description
    Is the checkout process paused
  • Name
    collectTips
    Type
    boolean
    Description
    Should tips be collected
  • Name
    preparationTime
    Type
    number
    Description
    Preparation time for orders
  • Name
    enablePayLater
    Type
    boolean
    Description
    Enable pay later option
  • Name
    restrictUPCItemsToMenuTimes
    Type
    boolean
    Description
    Restrict UPC items to menu times
  • Name
    requireAgeRestriction
    Type
    boolean
    Description
    Require age restriction
  • Name
    ageRestriction
    Type
    number
    Description
    Age restriction
  • Name
    enableGroupOrdering
    Type
    boolean
    Description
    Enable group ordering
  • Name
    fulfillmentTypes
    Type
    object
    Description
    Fulfillment types available
  • Name
    pickup
    Type
    boolean
    Description
    Pickup option
  • Name
    delivery
    Type
    boolean
    Description
    Delivery option
  • Name
    tag
    Type
    boolean
    Description
    Tag option
  • Name
    selfCheckout
    Type
    boolean
    Description
    Self-checkout option
  • Name
    tab
    Type
    boolean
    Description
    Tab option
  • Name
    pickupMethods
    Type
    object
    Description
    Pickup methods available
  • Name
    counter
    Type
    boolean
    Description
    Counter pickup method
  • Name
    table
    Type
    boolean
    Description
    Table pickup method
  • Name
    curbside
    Type
    boolean
    Description
    Curbside pickup method
  • Name
    driveThrough
    Type
    boolean
    Description
    Drive-through pickup method
  • Name
    pickUpPaddingTime
    Type
    number
    Description
    Padding time for pickup
  • Name
    pickupTimeSlotsInterval
    Type
    number
    Description
    Interval for pickup time slots
  • Name
    deliveryFee
    Type
    number
    Description
    Fee for delivery
  • Name
    deliveryRaduis
    Type
    number
    Description
    Maximum delivery distance in miles
  • Name
    anonymousSelfCheckout
    Type
    boolean
    Description
    Enable anonymous self-checkout
  • Name
    tagDeliveryFee
    Type
    number
    Description
    Delivery fee for tagged items
  • Name
    requestedTagKeys
    Type
    array
    Description
    Array of requested tag keys
  • Name
    tagKey
    Type
    string
    Description
    A requested tag key
  • Name
    enableTagMetadataEdit
    Type
    boolean
    Description
    Enable editing of tag metadata
  • Name
    taxRate
    Type
    number
    Description
    Tax rate
  • Name
    currency
    Type
    string
    Description
    Currency type
  • Name
    chargeCustomerProcessingFee
    Type
    boolean
    Description
    Charge customer processing fee
  • Name
    chargePlatformFeeToCustomer
    Type
    boolean
    Description
    Charge platform fee to customer
  • Name
    convenienceFee
    Type
    number
    Description
    Convenience fee
  • Name
    chargeConvenienceFeeForCashTransactions
    Type
    boolean
    Description
    Charge convenience fee for cash transactions
  • Name
    textTranslations
    Type
    array
    Description
    Array of text translations
  • Name
    search
    Type
    string
    Description
    Text to search for
  • Name
    replace
    Type
    string
    Description
    Text to replace with
  • Name
    colors
    Type
    object
    Description
    Color scheme for the merchant
  • Name
    primary
    Type
    string
    Description
    Primary color
  • Name
    secondary
    Type
    string
    Description
    Secondary color
  • Name
    success
    Type
    string
    Description
    Success color
  • Name
    error
    Type
    string
    Description
    Error color
  • Name
    info
    Type
    string
    Description
    Info color
  • Name
    splashScreenBackground
    Type
    string
    Description
    Splash screen background color
  • Name
    branding
    Type
    object
    Description
    Branding information
  • Name
    banner
    Type
    string
    Description
    Banner image
  • Name
    icon
    Type
    string
    Description
    Icon image
  • Name
    logo
    Type
    string
    Description
    Logo image
  • Name
    logoDark
    Type
    string
    Description
    Dark mode logo image
  • Name
    fonts
    Type
    object
    Description
    Font settings
  • Name
    headlines
    Type
    string
    Description
    Font for headlines
  • Name
    base
    Type
    string
    Description
    Base font
  • Name
    teleport
    Type
    object
    Description
    Teleport settings
  • Name
    enable
    Type
    boolean
    Description
    Enable teleport
  • Name
    destination
    Type
    string
    Description
    URL where users will be redirected to
  • Name
    links
    Type
    array
    Description
    Links to external resources
  • Name
    title
    Type
    string
    Description
    title of the link
  • Name
    url
    Type
    string
    Description
    url of the link
  • Name
    icon
    Type
    string
    Description
    icon of the link
  • Name
    visible
    Type
    string
    Description
    Is the link visible
  • Name
    type
    Type
    string
    Description
    Link type currently only supports 'DEFAULT'
  • Name
    target
    Type
    string
    Description
    Link target. _self to open in the same tab, _blank to open in a new tab
  • Name
    hours
    Type
    array
    Description
    Operating hours
  • Name
    day
    Type
    string
    Description
    Day of the week
  • Name
    open
    Type
    object
    Description
    Opening time
  • Name
    day
    Type
    number
    Description
    Opening day
  • Name
    time
    Type
    string
    Description
    Opening time in HHMM format
  • Name
    close
    Type
    object
    Description
    Closing time
  • Name
    day
    Type
    number
    Description
    Closing day
  • Name
    time
    Type
    string
    Description
    Closing time in HHMM format
  • Name
    isOpen
    Type
    boolean
    Description
    Is the merchant open on this day
  • Name
    openAllDay
    Type
    boolean
    Description
    Is the merchant open all day

Request

POST
/merchants/:merchantsId
await VenueRun.merchant.update({
  name: "Grub Grill",
  description: "Sizzling Flavors, Irresistible Eats!"
});

Response

{
  squareLocationId:production: null,
  language: "en-US",
  stripeAccountId:production: null,
  stripeChargesEnabled:production: false,
  textTranslations: [],
  accountHolder: "BCmLRQurraf9YXDlrzKFBGQf06D3",
  stripeTerminalLocationId:sandbox: null,
  email: "",
  website: "",
  squareMerchantId:production: null,
  deleted: false,
  phone: "",
  stripeTerminalLocationId:production: null,
  squareChargesEnabled:production: false,
  locations: {
    _DHqjp9ybTs0fUgdSswPt: {
      enabled: true
    }
  },
  name: "Grub Grill",
  squareMerchantId:sandbox: "MLERFZKEEF1Z7",
  squareChargesEnabled:sandbox: true,
  squareLocationId:sandbox: "L074DZVXKH38M",
  stripeAccountId:sandbox: "acct_1AyvVSCM9389iSDi",
  stripeChargesEnabled:sandbox: true,
  hours: [{
      isOpen: true,
      day: "Sunday",
      close: {
        time: "2200",
        day: 0
      },
      open: {
        time: "0800",
        day: 0
      },
      openAllDay: true
    }, {
      isOpen: true,
      day: "Monday",
      close: {
        time: "2200",
        day: 1
      },
      open: {
        time: "0800",
        day: 1
      },
      openAllDay: true
    }, {
      isOpen: true,
      day: "Tuesday",
      close: {
        time: "2200",
        day: 2
      },
      open: {
        time: "0800",
        day: 2
      },
      openAllDay: true
    }, {
      isOpen: true,
      day: "Wednesday",
      close: {
        time: "2200",
        day: 3
      },
      open: {
        time: "0800",
        day: 3
      },
      openAllDay: true
    }, {
      isOpen: true,
      day: "Thursday",
      close: {
        time: "2200",
        day: 4
      },
      open: {
        time: "0800",
        day: 4
      },
      openAllDay: true
    }, {
      isOpen: true,
      day: "Friday",
      close: {
        time: "2200",
        day: 5
      },
      open: {
        time: "0800",
        day: 5
      },
      openAllDay: true
    }, {
      isOpen: true,
      day: "Saturday",
      close: {
        time: "2200",
        day: 6
      },
      open: {
        time: "0800",
        day: 6
      },
      openAllDay: true
    }],
  address: {
    zip: "5043",
    country: "United States",
    line2: "",
    city: "Beloit",
    state: "WI",
    postal_code: "53511-2377",
    line1: "2301 Cheshire Lane"
  },
  description: "Sizzling Flavors, Irresistible Eats!",
  handle: "grub-grill",
  googlePlaceId: "",
  branding: {
    banner: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/ICBl2Tc8pbU10Z_0pHbHI.png",
    logoDark: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/Htdt3hxr9gxgVnF117lcd.png",
    logo: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/WtfesJWYI_SRfC2zHYCbW.png",
    favicon: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/E2Axa3SMTaSXvEyWfqRzi.ico",
    icon: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/E2Axa3SMTaSXvEyWfqRzi.png"
  },
  teleport: {
    enable: false,
    destination: ""
  },
  links: [],
  colors: {
    secondary: "#f05153",
    success: "#059669",
    error: "#dc2626",
    info: "#0284c7",
    splashScreenBackground: "#212121",
    primary: "#e60000"
  },
  status: "ACTIVE",
  fonts: {
    base: "Default",
    headlines: "Default"
  },
  timeZone: "America/Chicago",
  checkoutOptions: {
    paused: false,
    requireAgeRestriction: false,
    enableCoupons: true,
    requestedTagKeys: [],
    restrictUPCItemsToMenuTimes: false,
    tagDeliveryFee: 0,
    collectTips: true,
    enablePayLater: true,
    anonymousSelfCheckout: false,
    enableTagMetadataEdit: true,
    deliveryRaduis: 15,
    deliveryFee: 2.99,
    taxRate: 5.5,
    chargeCustomerProcessingFee: true,
    chargeConvenienceFeeForCashTransactions: true,
    convenienceFee: 3,
    chargePlatformFeeToCustomer: true,
    pickupTimeSlotsInterval: 15,
    pickUpPaddingTime: 15,
    ageRestriction: 21,
    enableGroupOrdering: true,
    forwardOrdersToSquare: false,
    minimumOrderAmount: 15,
    preparationTime: 15,
    currency: "USD",
    fulfillmentTypes: {
      SELFCHECKOUT: true,
      TAB: true,
      TAG: true,
      DELIVERY: true,
      PICKUP: true
    },
    pickupMethods: {
      COUNTER: true,
      CURBSIDE: true,
      DRIVE_THROUGH: true,
      TABLE: true
    },
    paymentProcessor: "STRIPE"
  },
  goals: {
    dailyOrderRevenue: 10000,
    dailyOrderVolume: 100
  },
  createdAt: {
    _seconds: 1469732498,
    _nanoseconds: 150000000
  },
  users: {
    BCmLRQurraf9YXDlrzKFBGQf06D3: true,
    IdQqfUUruxZKjPUysqHnePU3NNB3: true,
    uNpMI89Vg7gfe7h9lV19shwS42a2: true,
    kFovyJeFj3ZfcY96wkSjKOxsMnE2: true
  },
  domain: "app.grub-grill.com",
  updatedAt: {
    _seconds: 1731311962,
    _nanoseconds: 291000000
  },
  id: "054q775dzyX0nr8Q6bA6"
}

GET/merchants/:merchantId

Retrive a Merchant

This endpoint allows you to retrieve a Merchant

Required parameters

  • Name
    id
    Type
    string
    Description

    id of the Merchant

Request

GET
/merchants/:merchantsId
const product = await VenueRun.merchant.retrieve();

Response

{
  accountHolder: "BCmLRQurraf9YXDlrzKFBGQf06D3",
  address: {
    city: "Beloit",
    country: "United States",
    line1: "2301 Cheshire Lane",
    line2: "",
    postal_code: "53511-2377",
    state: "WI",
    zip: "5043"
  },
  branding: {
    banner: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/ICBl2Tc8pbU10Z_0pHbHI.png",
    favicon: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/E2Axa3SMTaSXvEyWfqRzi.ico",
    icon: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/E2Axa3SMTaSXvEyWfqRzi.png",
    logo: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/WtfesJWYI_SRfC2zHYCbW.png",
    logoDark: "https://cdn.venuerun.com/054q775dzyX0nr8Q6bA6/brand/Htdt3hxr9gxgVnF117lcd.png"
  },
  checkoutOptions: {
    ageRestriction: 21,
    anonymousSelfCheckout: false,
    chargeConvenienceFeeForCashTransactions: true,
    chargeCustomerProcessingFee: true,
    chargePlatformFeeToCustomer: true,
    collectTips: true,
    convenienceFee: 3,
    currency: "USD",
    deliveryFee: 2.99,
    deliveryRaduis: 15,
    enableCoupons: true,
    enableGroupOrdering: true,
    enablePayLater: true,
    enableTagMetadataEdit: true,
    forwardOrdersToSquare: false,
    fulfillmentTypes: {
      DELIVERY: true,
      PICKUP: true,
      SELFCHECKOUT: true,
      TAB: true,
      TAG: true
    },
    minimumOrderAmount: 15,
    paused: false,
    paymentProcessor: "STRIPE",
    pickUpPaddingTime: 15,
    pickupMethods: {
      COUNTER: true,
      CURBSIDE: true,
      DRIVE_THROUGH: true,
      TABLE: true
    },
    pickupTimeSlotsInterval: 15,
    preparationTime: 15,
    requestedTagKeys: [],
    requireAgeRestriction: false,
    restrictUPCItemsToMenuTimes: false,
    tagDeliveryFee: 0,
    taxRate: 5.5
  },
  colors: {
    error: "#dc2626",
    info: "#0284c7",
    primary: "#e60000",
    secondary: "#f05153",
    splashScreenBackground: "#212121",
    success: "#059669"
  },
  createdAt: 1469732498,
  deleted: false,
  description: "Sizzling Flavors, Irresistible Eats!",
  domain: "app.grub-grill.com",
  email: "",
  fonts: {
    base: "Default",
    headlines: "Default"
  },
  goals: {
    dailyOrderRevenue: 10000,
    dailyOrderVolume: 100
  },
  googlePlaceId: "",
  handle: "grub-grill",
  hours: [{
      close: {
        day: 0,
        time: "2200"
      },
      day: "Sunday",
      isOpen: true,
      open: {
        day: 0,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 1,
        time: "2200"
      },
      day: "Monday",
      isOpen: true,
      open: {
        day: 1,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 2,
        time: "2200"
      },
      day: "Tuesday",
      isOpen: true,
      open: {
        day: 2,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 3,
        time: "2200"
      },
      day: "Wednesday",
      isOpen: true,
      open: {
        day: 3,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 4,
        time: "2200"
      },
      day: "Thursday",
      isOpen: true,
      open: {
        day: 4,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 5,
        time: "2200"
      },
      day: "Friday",
      isOpen: true,
      open: {
        day: 5,
        time: "0800"
      },
      openAllDay: true
    }, {
      close: {
        day: 6,
        time: "2200"
      },
      day: "Saturday",
      isOpen: true,
      open: {
        day: 6,
        time: "0800"
      },
      openAllDay: true
    }],
  id: "054q775dzyX0nr8Q6bA6",
  language: "en-US",
  links: [],
  locations: {
    _DHqjp9ybTs0fUgdSswPt: {
      enabled: true
    }
  },
  name: "Grub Grill",
  phone: "",
  squareChargesEnabled:production: false,
  squareChargesEnabled:sandbox: true,
  squareLocationId:production: null,
  squareLocationId:sandbox: "L074DZVXKH38M",
  squareMerchantId:production: null,
  squareMerchantId:sandbox: "MLERFZKEEF1Z7",
  status: "ACTIVE",
  stripeAccountId:production: null,
  stripeAccountId:sandbox: "acct_1AyvVSCM9389iSDi",
  stripeChargesEnabled:production: false,
  stripeChargesEnabled:sandbox: true,
  stripeTerminalLocationId:production: null,
  stripeTerminalLocationId:sandbox: null,
  teleport: {
    destination: "",
    enable: false
  },
  textTranslations: [],
  timeZone: "America/Chicago",
  updatedAt: 1731311901,
  users: {
    BCmLRQurraf9YXDlrzKFBGQf06D3: true,
    IdQqfUUruxZKjPUysqHnePU3NNB3: true,
    kFovyJeFj3ZfcY96wkSjKOxsMnE2: true,
    uNpMI89Vg7gfe7h9lV19shwS42a2: true
  },
  website: ""
}

Was this page helpful?