The multi-vendor marketplace feature is only available via Vendo.

Hierarchy

  • default
    • Vendors

Constructors

  • Parameters

    • __namedParameters: EndpointOptions

    Returns Vendors

Methods

  • Returns a list of Vendors in a Spree marketplace.

    Success response schema: Success schema

    Failure response schema: Error schema

    Example:

    const vendors = await client.vendors.list({
    include: 'products'
    })

    Parameters

    • options: ListOptions = {}

    Returns Promise<VendorsResult>

  • Returns a single Vendor in a Spree marketplace.

    Options schema:

    interface options {
    id: string
    }

    Success response schema: Success schema

    Failure response schema: Error schema

    Example:

    const vendor = await client.vendors.show({ id: '123' })
    

    Parameters

    • options: ShowOptions

    Returns Promise<VendorResult>

  • Type Parameters

    • ResponseType = JsonApiResponse

    Parameters

    • method: HttpMethod
    • url: string
    • Optional tokens: IToken
    • Optional params: any
    • Optional responseParsing: ResponseParsing

    Returns Promise<ResultResponse<ResponseType>>

  • The HTTP error code returned by Spree is not indicative of its response shape. This function determines the information provided by Spree and uses everything available.

    Parameters

    • error: default

    Returns ErrorType

  • Parameters

    • error: Error

    Returns default

  • Parameters

    • error: default

    Returns default

  • Parameters

    • tokens: IToken

    Returns {
        [headerName: string]: string;
    }

    • [headerName: string]: string

Properties

fetcher: Fetcher

Generated using TypeDoc