Class SalesOrderShipmentsAPI

Sales Order Shipments API module - /v-beta/shipments

Hierarchy

SalesOrderShipmentsAPI

Index

Constructors

Properties

Methods

create get list listShipmentsByExternalOrderId update

Constructors

constructor

new SalesOrderShipmentsAPI(client: AxiosInstance): SalesOrderShipmentsAPI
Parameters
- client: AxiosInstance
Returns SalesOrderShipmentsAPI
- Defined in javascript/src/sales-order-shipments/api.ts:117

Properties

`Private` client

client: AxiosInstance

Methods

create

create(salesOrderId: string, shipment: Partial<SE.SalesOrderShipment>): Promise<AxiosResponse<SE.SalesOrderShipment, any>>
The create method creates a new shipment for a sales order.
Parameters
- salesOrderId: string
- shipment: Partial<SE.SalesOrderShipment>
Returns Promise<AxiosResponse<SE.SalesOrderShipment, any>>
- Defined in javascript/src/sales-order-shipments/api.ts:147

get

get(shipmentId: string): Promise<AxiosResponse<SE.SalesOrderShipment, any>>
The get method retrieves a specific sales order shipment by shipmentId.
Parameters
- shipmentId: string
Returns Promise<AxiosResponse<SE.SalesOrderShipment, any>>
- Defined in javascript/src/sales-order-shipments/api.ts:140

list

list(body: ListSalesOrderShipmentBody): Promise<AxiosResponse<ListSalesOrderShipmentsResult, any>>
The list method retrieves a list of sales order shipments for a given user.
Parameters
- body: ListSalesOrderShipmentBody
Returns Promise<AxiosResponse<ListSalesOrderShipmentsResult, any>>
- Defined in javascript/src/sales-order-shipments/api.ts:124

listShipmentsByExternalOrderId

listShipmentsByExternalOrderId(externalOrderId: string): Promise<AxiosResponse<ListSalesOrderShipmentsResult, any>>
The listShipmentsByExternalOrderId method retrieves a list of shipments associated to a sales order that matches externalOrderId
Parameters
- externalOrderId: string
Returns Promise<AxiosResponse<ListSalesOrderShipmentsResult, any>>
- Defined in javascript/src/sales-order-shipments/api.ts:133

update

update(shipmentId: string, shipment: Partial<SE.SalesOrderShipment>): Promise<AxiosResponse<SE.SalesOrderShipment, any>>
The update method updates a specific sales order shipment by shipmentId.
Parameters
- shipmentId: string
- shipment: Partial<SE.SalesOrderShipment>
Returns Promise<AxiosResponse<SE.SalesOrderShipment, any>>
- Defined in javascript/src/sales-order-shipments/api.ts:157

Generated using TypeDoc