ordercloud-javascript-sdk
    Preparing search index...

    Class OrderReturns

    Index
    Approve As Cancel Complete Create Decline Delete DeleteItem Get List ListApprovals ListEligibleApprovers Patch Save Submit

    • Returns this

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

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

    • Complete an order return Use only when an order return won't have an associated payment. You will not to reopen an order return after completing it. Check out the docs for more info

      Type Parameters

      Parameters

      • returnID: string

        ID of the return.

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

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

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredDeep<TOrderReturn>>

    • Delete an order return Check out the docs for more info

      Parameters

      • returnID: string

        ID of the return.

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

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

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<void>

    • Delete an order return item Check out the docs for more info

      Type Parameters

      Parameters

      • returnID: string

        ID of the return.

      • lineItemID: string

        ID of the line item.

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

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

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredDeep<TOrderReturn>>

    • List order returns Check out the docs for more info

      Type Parameters

      Parameters

      • listOptions: {
            approvable?: boolean;
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "OrderID")[];
            sortBy?: (
                | "ID"
                | "OrderID"
                | "DateCreated"
                | "!ID"
                | "!DateCreated"
                | "!OrderID"
                | "DateSubmitted"
                | "DateApproved"
                | "DateDeclined"
                | "DateCanceled"
                | "DateCompleted"
                | "LastUpdated"
                | "!DateSubmitted"
                | "!DateApproved"
                | "!DateDeclined"
                | "!DateCanceled"
                | "!DateCompleted"
                | "!LastUpdated"
            )[];
        } = {}
        • Optionalapprovable?: boolean

          Only returns orders awaiting the user's approval if true.

        • 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" | "OrderID")[]

          Comma-delimited list of fields to search on.

        • OptionalsortBy?: (
              | "ID"
              | "OrderID"
              | "DateCreated"
              | "!ID"
              | "!DateCreated"
              | "!OrderID"
              | "DateSubmitted"
              | "DateApproved"
              | "DateDeclined"
              | "DateCanceled"
              | "DateCompleted"
              | "LastUpdated"
              | "!DateSubmitted"
              | "!DateApproved"
              | "!DateDeclined"
              | "!DateCanceled"
              | "!DateCompleted"
              | "!LastUpdated"
          )[]

          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).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredObjectDeep<ListPage<TOrderReturn>>>

    • List order return approvals Returns all Approvals associated with the Order Return. Check out the docs for more info

      Type Parameters

      Parameters

      • returnID: string

        ID of the return.

      • listOptions: {
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: (
                "Comments"
                | "ApprovalRuleID"
                | "ApprovingGroupID"
                | "Approver"
            )[];
            sortBy?: (
                | "ApprovalRuleID"
                | "ApprovingGroupID"
                | "Approver"
                | "DateCreated"
                | "!DateCreated"
                | "!ApprovingGroupID"
                | "Status"
                | "DateCompleted"
                | "!Status"
                | "!DateCompleted"
                | "!ApprovalRuleID"
                | "!Approver"
            )[];
        } = {}
        • 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?: ("Comments" | "ApprovalRuleID" | "ApprovingGroupID" | "Approver")[]

          Comma-delimited list of fields to search on.

        • OptionalsortBy?: (
              | "ApprovalRuleID"
              | "ApprovingGroupID"
              | "Approver"
              | "DateCreated"
              | "!DateCreated"
              | "!ApprovingGroupID"
              | "Status"
              | "DateCompleted"
              | "!Status"
              | "!DateCompleted"
              | "!ApprovalRuleID"
              | "!Approver"
          )[]

          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).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredObjectDeep<ListPage<TOrderReturnApproval>>>

    • List order return eligible approvers Returns all Users who can approve or decline this order return (but have not done so). Check out the docs for more info

      Type Parameters

      • TUser extends User<any>

      Parameters

      • returnID: string

        ID of the return.

      • listOptions: {
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
            sortBy?: (
                | "ID"
                | "LastName"
                | "FirstName"
                | "Username"
                | "Email"
                | "DateCreated"
                | "!ID"
                | "!DateCreated"
                | "!FirstName"
                | "!LastName"
                | "LastActive"
                | "PasswordLastSetDate"
                | "!Username"
                | "!Email"
                | "!LastActive"
                | "!PasswordLastSetDate"
            )[];
        } = {}
        • 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" | "LastName" | "FirstName" | "Username" | "Email")[]

          Comma-delimited list of fields to search on.

        • OptionalsortBy?: (
              | "ID"
              | "LastName"
              | "FirstName"
              | "Username"
              | "Email"
              | "DateCreated"
              | "!ID"
              | "!DateCreated"
              | "!FirstName"
              | "!LastName"
              | "LastActive"
              | "PasswordLastSetDate"
              | "!Username"
              | "!Email"
              | "!LastActive"
              | "!PasswordLastSetDate"
          )[]

          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).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredObjectDeep<ListPage<TUser>>>

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

      Type Parameters

      Parameters

      • returnID: string

        ID of the return.

      • orderReturn: OrderReturn

        Required fields: OrderID

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

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

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredDeep<TOrderReturn>>

    Settings
    Member Visibility

    On This Page
    Methods