Class IntegrationEvents

Hierarchy

IntegrationEvents

Index

Properties

impersonating

Methods

As Calculate Create Delete EstimateShipping Get GetWorksheet List Patch Save SelectShipmethods

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Calculate

Calculate<TOrderWorksheet>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderWorksheet>>
Calculate an order. Check out the docs for more info
Type Parameters
- TOrderWorksheet extends OrderWorksheet<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, TOrderWorksheet>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderWorksheet>>
- Defined in api/IntegrationEvents.ts:178

Create

Create<TIntegrationEvent>(integrationEvent: IntegrationEvent, requestOptions?: RequestOptions): Promise<RequiredDeep<TIntegrationEvent>>
Create a new integration event. 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
- TIntegrationEvent extends IntegrationEvent
Parameters
- integrationEvent: IntegrationEvent
  
  Required fields: CustomImplementationUrl, Name, HashKey
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TIntegrationEvent>>
- Defined in api/IntegrationEvents.ts:70

Delete

Delete(integrationEventID: string, requestOptions?: RequestOptions): Promise<void>
Delete an integration event. Check out the docs for more info
Parameters
- integrationEventID: string
  
  ID of the integration event.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/IntegrationEvents.ts:134

EstimateShipping

EstimateShipping<TOrderWorksheet>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderWorksheet>>
Estimate shipping cost. Check out the docs for more info
Type Parameters
- TOrderWorksheet extends OrderWorksheet<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, TOrderWorksheet>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderWorksheet>>
- Defined in api/IntegrationEvents.ts:200

Get

Get<TIntegrationEvent>(integrationEventID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TIntegrationEvent>>
Get a single integration event. Check out the docs for more info
Type Parameters
- TIntegrationEvent extends IntegrationEvent
Parameters
- integrationEventID: string
  
  ID of the integration event.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TIntegrationEvent>>
- Defined in api/IntegrationEvents.ts:91

GetWorksheet

GetWorksheet<TOrderWorksheet>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderWorksheet>>
Get a single order worksheet. Check out the docs for more info
Type Parameters
- TOrderWorksheet extends OrderWorksheet<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, TOrderWorksheet>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderWorksheet>>
- Defined in api/IntegrationEvents.ts:245

List

List<TIntegrationEvent>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "EventType")[];
    sortBy?: ("ID" | "Name" | "EventType" | "!ID" | "!Name" | "!EventType")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TIntegrationEvent>>>
Get a list of integration events. Check out the docs for more info
Type Parameters
- TIntegrationEvent extends IntegrationEvent
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "EventType")[];
      sortBy?: ("ID" | "Name" | "EventType" | "!ID" | "!Name" | "!EventType")[];
  } = {}
  - 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" | "Name" | "EventType")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "EventType" | "!ID" | "!Name" | "!EventType")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TIntegrationEvent>>>
- Defined in api/IntegrationEvents.ts:49

Patch

Patch<TIntegrationEvent>(integrationEventID: string, integrationEvent: PartialObjectDeep<IntegrationEvent>, requestOptions?: RequestOptions): Promise<RequiredDeep<TIntegrationEvent>>
Partially update an integration event. Check out the docs for more info
Type Parameters
- TIntegrationEvent extends IntegrationEvent
Parameters
- integrationEventID: string
  
  ID of the integration event.
- integrationEvent: PartialObjectDeep<IntegrationEvent>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TIntegrationEvent>>
- Defined in api/IntegrationEvents.ts:156

Save

Save<TIntegrationEvent>(integrationEventID: string, integrationEvent: IntegrationEvent, requestOptions?: RequestOptions): Promise<RequiredDeep<TIntegrationEvent>>
Create or update an integration event. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TIntegrationEvent extends IntegrationEvent
Parameters
- integrationEventID: string
  
  ID of the integration event.
- integrationEvent: IntegrationEvent
  
  Required fields: CustomImplementationUrl, Name, HashKey
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TIntegrationEvent>>
- Defined in api/IntegrationEvents.ts:113

SelectShipmethods

SelectShipmethods<TOrderWorksheet>(direction: OrderDirection, orderID: string, orderShipMethodSelection: OrderShipMethodSelection, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderWorksheet>>
Select a ship method. Check out the docs for more info
Type Parameters
- TOrderWorksheet extends OrderWorksheet<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, TOrderWorksheet>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- orderShipMethodSelection: OrderShipMethodSelection
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderWorksheet>>
- Defined in api/IntegrationEvents.ts:223

Class IntegrationEvents

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns IntegrationEvents

Calculate

Type Parameters

TOrderWorksheet extends OrderWorksheet<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, TOrderWorksheet>

Parameters

direction: OrderDirection

orderID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderWorksheet>>

Create

Type Parameters

TIntegrationEvent extends IntegrationEvent

Parameters

integrationEvent: IntegrationEvent

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TIntegrationEvent>>

Delete

Parameters

integrationEventID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

EstimateShipping

Type Parameters

TOrderWorksheet extends OrderWorksheet<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, TOrderWorksheet>

Parameters

direction: OrderDirection

orderID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderWorksheet>>

Get

Type Parameters

TIntegrationEvent extends IntegrationEvent

Parameters

integrationEventID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TIntegrationEvent>>

GetWorksheet

Type Parameters

TOrderWorksheet extends OrderWorksheet<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, TOrderWorksheet>

Parameters

direction: OrderDirection

orderID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderWorksheet>>

List

Type Parameters

TIntegrationEvent extends IntegrationEvent

Parameters

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

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name" | "EventType")[]

Optional sortBy?: ("ID" | "Name" | "EventType" | "!ID" | "!Name" | "!EventType")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TIntegrationEvent>>>

Patch

Type Parameters

TIntegrationEvent extends IntegrationEvent

Parameters

integrationEventID: string

integrationEvent: PartialObjectDeep<IntegrationEvent>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TIntegrationEvent>>

Save

Type Parameters

TIntegrationEvent extends IntegrationEvent

Parameters

`Private` impersonating

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

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

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

`Optional` sortBy?: ("ID" | "Name" | "EventType" | "!ID" | "!Name" | "!EventType")[]