Class SalesOrdersAPI

Sales Orders API module - /v-beta/sales_orders

Hierarchy

SalesOrdersAPI

Index

Constructors

Properties

Methods

get getByExternalId list notifyShipped

Constructors

constructor

new SalesOrdersAPI(client: AxiosInstance): SalesOrdersAPI
Parameters
- client: AxiosInstance
Returns SalesOrdersAPI
- Defined in javascript/src/sales-orders/api.ts:26

Properties

`Private` client

client: AxiosInstance

Methods

get

get(salesOrderId: string): Promise<AxiosResponse<SE.SalesOrder, any>>
The get method retrieves a specific sales order by salesOrderId.
Parameters
- salesOrderId: string
Returns Promise<AxiosResponse<SE.SalesOrder, any>>
- Defined in javascript/src/sales-orders/api.ts:40

getByExternalId

getByExternalId(externalOrderId: string): Promise<AxiosResponse<SE.SalesOrder, any>>
The getByExternalId method retrieves a specific sales order by its externalOrderId.
Parameters
- externalOrderId: string
  
  Id that matches that of the desired sales order.
Returns Promise<AxiosResponse<SE.SalesOrder, any>>
- Defined in javascript/src/sales-orders/api.ts:48

list

list(params?: ListSalesOrdersParams): Promise<AxiosResponse<{
salesOrders: SE.SalesOrder[];
}, any>>
The list method retrieves a list of sales orders.
Parameters
- params: ListSalesOrdersParams = {}
Returns Promise<AxiosResponse<{
salesOrders: SE.SalesOrder[];
}, any>>
- Defined in javascript/src/sales-orders/api.ts:33

notifyShipped

notifyShipped(salesOrderId: string, tracking: SE.SalesOrderTracking): Promise<AxiosResponse<SE.SalesOrder, any>>
The notifyShipped method notifies order source that the order has been shipped. Typically, the order source will then notify the user based on this update from ShipEngine API.
Parameters
- salesOrderId: string
- tracking: SE.SalesOrderTracking
Returns Promise<AxiosResponse<SE.SalesOrder, any>>
- Defined in javascript/src/sales-orders/api.ts:57

Generated using TypeDoc