Class OrderReturns

Hierarchy

OrderReturns

Index

Properties

Methods

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

Properties

`Private` impersonating

impersonating: boolean = false

Methods

Approve

Approve<TOrderReturn>(returnID: string, approvalInfo: ApprovalInfo, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Approve an order return. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- approvalInfo: ApprovalInfo
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:210

As

As(): OrderReturns
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
OrderReturns.As().List() // lists OrderReturns using the impersonated users' token
```
Returns OrderReturns
- Defined in api/OrderReturns.ts:363

Cancel

Cancel<TOrderReturn>(returnID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Cancel an OrderReturn. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:231

Complete

Complete<TOrderReturn>(returnID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Complete an OrderReturn. 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
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:252

Create

Create<TOrderReturn>(orderReturn: OrderReturn<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Create a new order return. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- orderReturn: OrderReturn<any>
  
  Required fields: OrderID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:75

Decline

Decline<TOrderReturn>(returnID: string, approvalInfo: ApprovalInfo, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Decline an order return. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- approvalInfo: ApprovalInfo
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:274

Delete

Delete(returnID: string, requestOptions?: RequestOptions): Promise<void>
Delete an order return. Check out the docs for more info
Parameters
- returnID: string
  
  ID of the return.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/OrderReturns.ts:139

DeleteItem

DeleteItem<TOrderReturn>(returnID: string, lineItemID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Delete an order return item. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- lineItemID: string
  
  ID of the line item.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:323

Get

Get<TOrderReturn>(returnID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Get a single order return. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:96

List

List<TOrderReturn>(listOptions?: {
    approvable?: boolean;
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "OrderID")[];
    sortBy?: ("ID" | "OrderID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "!DateSubmitted" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!OrderID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TOrderReturn>>>
Get a list of order returns. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- listOptions: {
      approvable?: boolean;
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "OrderID")[];
      sortBy?: ("ID" | "OrderID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "!DateSubmitted" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!OrderID")[];
  } = {}
  - Optional approvable?: boolean
    
    Only returns orders awaiting the user's approval if true.
  - Optional filters?: 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.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "OrderID")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "OrderID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "!DateSubmitted" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!OrderID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TOrderReturn>>>
- Defined in api/OrderReturns.ts:54

ListApprovals

ListApprovals<TOrderReturnApproval>(returnID: string, 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")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TOrderReturnApproval>>>
Get a list of order return approvals. Returns all Approvals associated with the Order Return. Check out the docs for more info
Type Parameters
- TOrderReturnApproval extends OrderReturnApproval<any, TOrderReturnApproval>
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")[];
  } = {}
  - Optional filters?: 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.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("Comments" | "ApprovalRuleID" | "ApprovingGroupID" | "Approver")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ApprovalRuleID" | "ApprovingGroupID" | "Approver" | "DateCreated" | "!DateCreated" | "!ApprovingGroupID" | "Status" | "DateCompleted" | "!Status" | "!DateCompleted" | "!ApprovalRuleID" | "!Approver")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TOrderReturnApproval>>>
- Defined in api/OrderReturns.ts:188

ListEligibleApprovers

ListEligibleApprovers<TUser>(returnID: string, 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" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TUser>>>
Get a list of 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, TUser>
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" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[];
  } = {}
  - Optional filters?: 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.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TUser>>>
- Defined in api/OrderReturns.ts:301

Patch

Patch<TOrderReturn>(returnID: string, orderReturn: PartialObjectDeep<OrderReturn<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Partially update an order return. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- orderReturn: PartialObjectDeep<OrderReturn<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:161

Save

Save<TOrderReturn>(returnID: string, orderReturn: OrderReturn<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
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
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- orderReturn: OrderReturn<any>
  
  Required fields: OrderID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:118

Submit

Submit<TOrderReturn>(returnID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderReturn>>
Submit an order return. Check out the docs for more info
Type Parameters
- TOrderReturn extends OrderReturn<any, TOrderReturn>
Parameters
- returnID: string
  
  ID of the return.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderReturn>>
- Defined in api/OrderReturns.ts:344

Class OrderReturns

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

Approve

Type Parameters

TOrderReturn extends OrderReturn<any, TOrderReturn>

Parameters

returnID: string

approvalInfo: ApprovalInfo

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderReturn>>

As

Description

Example

Returns OrderReturns

Cancel

Type Parameters

TOrderReturn extends OrderReturn<any, TOrderReturn>

Parameters

returnID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderReturn>>

Complete

Type Parameters

TOrderReturn extends OrderReturn<any, TOrderReturn>

Parameters

returnID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderReturn>>

Create

Type Parameters

TOrderReturn extends OrderReturn<any, TOrderReturn>

Parameters

orderReturn: OrderReturn<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderReturn>>

Decline

Type Parameters

TOrderReturn extends OrderReturn<any, TOrderReturn>

Parameters

returnID: string

approvalInfo: ApprovalInfo

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderReturn>>

Delete

Parameters

returnID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteItem

Type Parameters

TOrderReturn extends OrderReturn<any, TOrderReturn>

Parameters

returnID: string

lineItemID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderReturn>>

Get

Type Parameters

TOrderReturn extends OrderReturn<any, TOrderReturn>

Parameters

returnID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderReturn>>

List

Type Parameters

TOrderReturn extends OrderReturn<any, TOrderReturn>

Parameters

Optional approvable?: boolean

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "OrderID")[]

requestOptions: RequestOptions = {}

`Private` impersonating

`Optional` approvable?: boolean

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "OrderID")[]

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("Comments" | "ApprovalRuleID" | "ApprovingGroupID" | "Approver")[]

`Optional` sortBy?: ("ApprovalRuleID" | "ApprovingGroupID" | "Approver" | "DateCreated" | "!DateCreated" | "!ApprovingGroupID" | "Status" | "DateCompleted" | "!Status" | "!DateCompleted" | "!ApprovalRuleID" | "!Approver")[]

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

`Optional` sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[]