Skip to main content

Function: shipmentService()

shipmentService(client): object

Defined in: service/ShipmentService.ts:27

Service for managing shipments and shipment items

Parameters​

client​

GraphQLClient

Returns​

createShipment()​

createShipment(input): Promise<Shipment>

Creates a new shipment *

Parameters​

input​

ShipmentCreateInput

Shipment creation input *

Returns​

Promise<Shipment>

Promise<Shipment> The created shipment

createShipmentItem()​

createShipmentItem(input): Promise&lt;ShipmentItem>

Creates a new shipment item *

Parameters​

input​

ShipmentItemCreateInput

Shipment item creation input *

Returns​

Promise&lt;ShipmentItem>

Promise<ShipmentItem> The created shipment item

deleteShipment()​

deleteShipment(id): Promise&lt;boolean>

Deletes a shipment *

Parameters​

id​

number

Shipment ID *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status

deleteShipmentItem()​

deleteShipmentItem(id): Promise&lt;boolean>

Deletes a shipment item *

Parameters​

id​

number

Shipment item ID *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status

getShipment()​

getShipment(id): Promise&lt;Shipment>

Retrieves a specific shipment *

Parameters​

id​

number

Shipment ID *

Returns​

Promise&lt;Shipment>

Promise<Shipment> Shipment data

getShipmentItem()​

getShipmentItem(id): Promise&lt;ShipmentItem>

Retrieves a specific shipment item *

Parameters​

id​

number

Shipment item ID *

Returns​

Promise&lt;ShipmentItem>

Promise<ShipmentItem> Shipment item data

getShipmentItems()​

getShipmentItems(input?): Promise&lt;ShipmentItemResponse>

Retrieves shipment items with search criteria *

Parameters​

input?​

ShipmentItemSearchInput

Search input parameters *

Returns​

Promise&lt;ShipmentItemResponse>

Promise<ShipmentItemResponse> Shipment items response

getShipments()​

getShipments(input?): Promise&lt;ShipmentResponse>

Retrieves shipments with search criteria *

Parameters​

input?​

ShipmentSearchInput

Search input parameters *

Returns​

Promise&lt;ShipmentResponse>

Promise<ShipmentResponse> Shipments response

updateShipment()​

updateShipment(variables): Promise&lt;Shipment>

Updates an existing shipment *

Parameters​

variables​

ShipmentUpdateVariables

Shipment update input *

Returns​

Promise&lt;Shipment>

Promise<Shipment> The updated shipment

updateShipmentItem()​

updateShipmentItem(variables): Promise&lt;ShipmentItem>

Updates an existing shipment item *

Parameters​

variables​

ShipmentItemUpdateVariables

Shipment item update input *

Returns​

Promise&lt;ShipmentItem>

Promise<ShipmentItem> The updated shipment item