Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GenPackListEndpoint ¶
type GenPackListEndpoint struct{}
Assembles a printable pack-list document for a shipment.
Gathers the shipment's packed line items and shipping cases (with carrier tracking numbers and case weights) together with its parent order's header, bill-to and ship-to parties, terms, and any order lines still back-ordered, and returns them as a single document ready to render. The document is a point-in-time snapshot and is not persisted.
func (*GenPackListEndpoint) Materialize ¶
func (e *GenPackListEndpoint) Materialize() *apiendpoint.APIEndpoint[*GenPackListRequest, *apiresource.PackList]
type GenPackListRequest ¶
type GenPackListRequest struct {
// ID of the shipment to generate the pack list for.
ShipmentID string `json:"shipment_id" validate:"required"`
}
Request to generate a pack list for a shipment.
func (*GenPackListRequest) SchemaExample ¶
func (*GenPackListRequest) SchemaExample() any
type RecordsSvc ¶
type RecordsSvc interface {
GenPackList(ctx context.Context, req *GenPackListRequest) (*apiresource.PackList, *apierror.APIError)
}
func NewRecordsSvc ¶
func NewRecordsSvc(config *RecordsSvcConfig) RecordsSvc
type RecordsSvcConfig ¶
type RecordsSvcConfig struct {
// ShippingClient (required) is the core-service shipping gRPC client.
ShippingClient pb.CoreShippingServiceClient
// SalesClient (required) is the core-service sales gRPC client.
SalesClient pb.CoreSalesServiceClient
// AccountClient (required) is the core-service account gRPC client, used for the account name and presigned logo.
AccountClient pb.CoreServiceClient
}
Source Files
Click to show internal directories.
Click to hide internal directories.