Class IntegrationEvents

Index

Methods

As Calculate Create Delete EstimateShipping Get GetWorksheet List Patch Save SelectShipmethods

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
IntegrationEvents.As().List() // lists IntegrationEvents using the impersonated users' token
```
- Defined in api/IntegrationEvents.ts:264

Calculate

Calculate<
    TOrderWorksheet extends
        OrderWorksheet<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
>(
    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,
      any,
  >
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- 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<TOrderWorksheet>>
- Defined in api/IntegrationEvents.ts:178

Create

Create<TIntegrationEvent extends IntegrationEvent>(
integrationEvent: IntegrationEvent,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TIntegrationEvent>>
Create an integration event Check out the docs for more info
Type Parameters
- TIntegrationEvent extends IntegrationEvent
Parameters
- integrationEvent: IntegrationEvent
  Required fields: CustomImplementationUrl, Name, HashKey
- 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<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 = {}
  - 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>
- Defined in api/IntegrationEvents.ts:134

EstimateShipping

EstimateShipping<
    TOrderWorksheet extends
        OrderWorksheet<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
>(
    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,
      any,
  >
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- 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<TOrderWorksheet>>
- Defined in api/IntegrationEvents.ts:200

Get

Get<TIntegrationEvent extends IntegrationEvent>(
integrationEventID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TIntegrationEvent>>
Retrieve an integration event Check out the docs for more info
Type Parameters
- TIntegrationEvent extends IntegrationEvent
Parameters
- integrationEventID: string
  ID of the integration event.
- 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<TIntegrationEvent>>
- Defined in api/IntegrationEvents.ts:91

GetWorksheet

GetWorksheet<
    TOrderWorksheet extends
        OrderWorksheet<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
>(
    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,
      any,
  >
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- 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<TOrderWorksheet>>
- Defined in api/IntegrationEvents.ts:245

List

List<TIntegrationEvent extends IntegrationEvent>(
    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>>>
List 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")[];
  } = {}
  - 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" | "EventType")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "Name" | "EventType" | "!ID" | "!Name" | "!EventType")[]
    
    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<TIntegrationEvent>>>
- Defined in api/IntegrationEvents.ts:49

Patch

Patch<TIntegrationEvent extends IntegrationEvent>(
    integrationEventID: string,
    integrationEvent: PartialDeep<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: PartialDeep<IntegrationEvent>
- 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<TIntegrationEvent>>
- Defined in api/IntegrationEvents.ts:156

Save

Save<TIntegrationEvent extends IntegrationEvent>(
    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 = {}
  - 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<TIntegrationEvent>>
- Defined in api/IntegrationEvents.ts:113

SelectShipmethods

SelectShipmethods<
    TOrderWorksheet extends
        OrderWorksheet<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
>(
    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,
      any,
  >
Parameters
- direction: OrderDirection
  Direction of the order, from the current user's perspective.
- orderID: string
  ID of the order.
- orderShipMethodSelection: OrderShipMethodSelection
- 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<TOrderWorksheet>>
- Defined in api/IntegrationEvents.ts:223

Class IntegrationEvents

Index

Methods

Methods

As

Returns this

Description

Example

Calculate

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TOrderWorksheet>>

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TIntegrationEvent>>

Delete

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<void>

EstimateShipping

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TOrderWorksheet>>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TIntegrationEvent>>

GetWorksheet

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TOrderWorksheet>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

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

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

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredObjectDeep<ListPage<TIntegrationEvent>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TIntegrationEvent>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalrequestType?: string

Optionalsignal?: AbortSignal

Returns Promise<RequiredDeep<TIntegrationEvent>>

SelectShipmethods

Type Parameters

Parameters

OptionalaccessToken?: string

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

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

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal

`Optional`accessToken?: string

`Optional`requestType?: string

`Optional`signal?: AbortSignal