Skip to main content

Class: ShipmentService

Defined in: service/ShipmentService.ts:125

Backwards-compatible class form. New code should call shipmentService(client).

Constructors​

Constructor​

new ShipmentService(client): ShipmentService

Defined in: service/ShipmentService.ts:127

Parameters​

client​

GraphQLClient

Returns​

ShipmentService

Methods​

createShipment()​

createShipment(input): Promise<Shipment>

Defined in: service/ShipmentService.ts:142

Creates a new shipment

Parameters​

input​

ShipmentCreateInput

Shipment creation input

Returns​

Promise<Shipment>

createShipmentItem()​

createShipmentItem(input): Promise<ShipmentItem>

Defined in: service/ShipmentService.ts:167

Creates a new shipment item

Parameters​

input​

ShipmentItemCreateInput

Shipment item creation input

Returns​

Promise<ShipmentItem>

deleteShipment()​

deleteShipment(id): Promise<boolean>

Defined in: service/ShipmentService.ts:152

Deletes a shipment

Parameters​

id​

number

Shipment ID

Returns​

Promise<boolean>

deleteShipmentItem()​

deleteShipmentItem(id): Promise<boolean>

Defined in: service/ShipmentService.ts:177

Deletes a shipment item

Parameters​

id​

number

Shipment item ID

Returns​

Promise<boolean>

getShipment()​

getShipment(id): Promise<Shipment>

Defined in: service/ShipmentService.ts:132

Retrieves a specific shipment

Parameters​

id​

number

Shipment ID

Returns​

Promise<Shipment>

getShipmentItem()​

getShipmentItem(id): Promise<ShipmentItem>

Defined in: service/ShipmentService.ts:157

Retrieves a specific shipment item

Parameters​

id​

number

Shipment item ID

Returns​

Promise<ShipmentItem>

getShipmentItems()​

getShipmentItems(input?): Promise<ShipmentItemResponse>

Defined in: service/ShipmentService.ts:162

Retrieves shipment items with search criteria

Parameters​

input?​

ShipmentItemSearchInput

Search input parameters

Returns​

Promise<ShipmentItemResponse>

getShipments()​

getShipments(input?): Promise<ShipmentResponse>

Defined in: service/ShipmentService.ts:137

Retrieves shipments with search criteria

Parameters​

input?​

ShipmentSearchInput

Search input parameters

Returns​

Promise<ShipmentResponse>

updateShipment()​

updateShipment(variables): Promise<Shipment>

Defined in: service/ShipmentService.ts:147

Updates an existing shipment

Parameters​

variables​

ShipmentUpdateVariables

Shipment update input

Returns​

Promise<Shipment>

updateShipmentItem()​

updateShipmentItem(variables): Promise<ShipmentItem>

Defined in: service/ShipmentService.ts:172

Updates an existing shipment item

Parameters​

variables​

ShipmentItemUpdateVariables

Shipment item update input

Returns​

Promise<ShipmentItem>