Class OrderSourcesAPI

Order Sources API module - /v-beta/order_sources

Hierarchy

OrderSourcesAPI

Index

Constructors

Properties

Methods

deactivate get list listConnections refresh update

Constructors

constructor

new OrderSourcesAPI(client: AxiosInstance): OrderSourcesAPI
Parameters
- client: AxiosInstance
Returns OrderSourcesAPI
- Defined in javascript/src/order-sources/api.ts:9

Properties

`Private` client

client: AxiosInstance

Methods

deactivate

deactivate(orderSourceId: string): Promise<AxiosResponse<any, any>>
The deactivate method remove a specific connected order source by orderSourceId.
Parameters
- orderSourceId: string
Returns Promise<AxiosResponse<any, any>>
- Defined in javascript/src/order-sources/api.ts:54

get

get(orderSourceId: string): Promise<AxiosResponse<SE.OrderSource, any>>
The get method retrieves a specific order source by orderSourceId.
Parameters
- orderSourceId: string
Returns Promise<AxiosResponse<SE.OrderSource, any>>
- Defined in javascript/src/order-sources/api.ts:32

list

list(): Promise<AxiosResponse<{
orderSources: SE.OrderSource[];
}, any>>
The list method retrieves a list of connected order sources for a given user.

Returns Promise<AxiosResponse<{
orderSources: SE.OrderSource[];
}, any>>
- Defined in javascript/src/order-sources/api.ts:16

listConnections

listConnections(): Promise<AxiosResponse<{
connectableOrderSources: SE.OrderSourceConnection[];
}, any>>
The listConnections method retrieves the list of available order sources to be connected with.

Returns Promise<AxiosResponse<{
connectableOrderSources: SE.OrderSourceConnection[];
}, any>>
- Defined in javascript/src/order-sources/api.ts:23

refresh

refresh(orderSourceId: string): Promise<AxiosResponse<SE.OrderSource, any>>
The refresh method refreshes a specific order source by orderSourceId. This will pull in any new orders since the last order import.
Parameters
- orderSourceId: string
Returns Promise<AxiosResponse<SE.OrderSource, any>>
- Defined in javascript/src/order-sources/api.ts:47

update

update(__namedParameters: SE.OrderSourceEditParams): Promise<AxiosResponse<any, any>>
The update method will allow the user to update a connected Order Source
Parameters
- __namedParameters: SE.OrderSourceEditParams
Returns Promise<AxiosResponse<any, any>>
- Defined in javascript/src/order-sources/api.ts:39

Generated using TypeDoc