ordercloud-javascript-sdk
    Preparing search index...

    Class Buyers

    Index
    As Create Delete Get List ListBuyerSellers Patch Save

    • Returns this

      enables impersonation by calling the subsequent method with the stored impersonation token

      Buyers.As().List() // lists Buyers using the impersonated users' token

    • Create a buyer Check out the docs for more info

      Type Parameters

      • TBuyer extends Buyer<any>

      Parameters

      • buyer: Buyer

        Required fields: Name

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<RequiredDeep<TBuyer>>

    • Delete a buyer Check out the docs for more info

      Parameters

      • buyerID: string

        ID of the buyer.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Retrieve a buyer Check out the docs for more info

      Type Parameters

      • TBuyer extends Buyer<any>

      Parameters

      • buyerID: string

        ID of the buyer.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<RequiredDeep<TBuyer>>

    • List buyers Check out the docs for more info

      Type Parameters

      • TBuyer extends Buyer<any>

      Parameters

      • listOptions: {
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "Name")[];
            sortBy?: (
                | "ID"
                | "Name"
                | "GroupID"
                | "DateCreated"
                | "!ID"
                | "!DateCreated"
                | "!Name"
                | "!GroupID"
            )[];
        } = {}
        • Optionalfilters?: Filters

          An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

        • Optionalpage?: number

          Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

        • OptionalpageSize?: number

          Number of results to return per page.

        • Optionalsearch?: string

          Word or phrase to search for.

        • OptionalsearchOn?: ("ID" | "Name")[]

          Comma-delimited list of fields to search on.

        • OptionalsortBy?: (
              | "ID"
              | "Name"
              | "GroupID"
              | "DateCreated"
              | "!ID"
              | "!DateCreated"
              | "!Name"
              | "!GroupID"
          )[]

          Comma-delimited list of fields to sort by.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<RequiredObjectDeep<ListPage<TBuyer>>>

    • List sellers this buyer can purchase from Check out the docs for more info

      Type Parameters

      Parameters

      • buyerID: string

        ID of the buyer.

      • listOptions: {
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "Name")[];
            sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
        } = {}
        • Optionalfilters?: Filters

          An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

        • Optionalpage?: number

          Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

        • OptionalpageSize?: number

          Number of results to return per page.

        • Optionalsearch?: string

          Word or phrase to search for.

        • OptionalsearchOn?: ("ID" | "Name")[]

          Comma-delimited list of fields to search on.

        • OptionalsortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

          Comma-delimited list of fields to sort by.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<RequiredObjectDeep<ListPage<TBuyerSupplier>>>

    • Create or update a buyer If an object with the same ID already exists, it will be overwritten. Check out the docs for more info

      Type Parameters

      • TBuyer extends Buyer<any>

      Parameters

      • buyerID: string

        ID of the buyer.

      • buyer: Buyer

        Required fields: Name

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<RequiredDeep<TBuyer>>

    Settings
    Member Visibility

    On This Page
    Methods