pickep

type GetPickShipmentsEndpoint struct{}

type GetPickShipmentsRequest struct {
	// Pick ID.
	PickID string `path:"id" validate:"required"`
	// Search query that filters shipment numbers by substring match.
	Query *string `query:"q"`
	// Maximum number of results to return.
	Limit *int32 `query:"limit"`
	// Number of results to skip.
	Offset *int32 `query:"offset"`
}

type ListPicksEndpoint struct{}

type ListPicksRequest struct {
	apiresource.PaginationRequest
	// Filter by pick status.
	Status *constants.PickStatus `query:"status"`
	// Filter by customer IDs.
	CustomerIDs []string `query:"customer_ids"`
	// Filter by product line IDs.
	//
	// Matches picks that contain at least one line for a product in any of the given product lines.
	ProductLineIDs []string `query:"product_line_ids"`
	// Filter by customer type group IDs.
	//
	// Matches picks whose customer's type group — the account group returned in the customer's `type` field — is one of the given groups.
	CustomerGroupIDs []string `query:"customer_group_ids"`
	// Filter by department IDs.
	//
	// Matches picks assigned to any of the given departments.
	DepartmentIDs []string `query:"department_ids"`
	// Only return picks created on or after this date (`YYYY-MM-DD`).
	StartDate *string `query:"starts_at" validate:"omitempty,date_filter"`
	// Only return picks created before this date (`YYYY-MM-DD`).
	EndDate *string `query:"ends_at" validate:"omitempty,date_filter"`
	// Orders the results: `ship_by_date` puts the soonest delivery commitment first, with picks whose order has no ship-by date last; `created_at` puts the newest pick first.
	Sort constants.PickSort `query:"sort" default:"ship_by_date"`
}

type PackPickEndpoint struct{}

type PackPickRequest struct {
	// Pick ID.
	PickID string `path:"id" validate:"required"`
	// Number of shipping cases to create on the new shipment.
	//
	// Must be at least 1. Cases are numbered sequentially from the shipment number (e.g. `SO-001-1`, `SO-001-2`), and each starts with zero freight weight and freight cost for you to fill in later.
	ShipmentCaseCount int32 `json:"shipment_case_count" validate:"required,gte=1"`
}

type PickAllLinesEndpoint struct{}

type PickAllLinesRequest struct {
	// Pick ID.
	PickID string `path:"id" validate:"required"`
}

type PickPickLineEndpoint struct{}

type PickPickLineRequest struct {
	// Pick ID.
	PickID string `path:"pick_id" validate:"required"`
	// Pick line ID.
	PickLineID string `path:"id" validate:"required"`
}

type PickSvc interface {
	ListPicks(ctx context.Context, req *ListPicksRequest) (*apiresource.List[apiresource.Pick], *apierror.APIError)
	GetPick(ctx context.Context, req *RetrievePickRequest) (*apiresource.Pick, *apierror.APIError)
	UpdatePick(ctx context.Context, req *UpdatePickRequest) (*apiresource.Pick, *apierror.APIError)
	PickAllLines(ctx context.Context, req *PickAllLinesRequest) (*apiresource.Pick, *apierror.APIError)
	VoidPick(ctx context.Context, req *VoidPickRequest) (*apiresource.Pick, *apierror.APIError)
	PackPick(ctx context.Context, req *PackPickRequest) (*apiresource.Job, *apierror.APIError)
	GetPickShipments(ctx context.Context, req *GetPickShipmentsRequest) (*apiresource.PickShipmentsResponse, *apierror.APIError)
	UpdatePickLine(ctx context.Context, req *UpdatePickLineRequest) (*apiresource.PickLine, *apierror.APIError)
	PickPickLine(ctx context.Context, req *PickPickLineRequest) (*apiresource.PickLine, *apierror.APIError)
	VoidPickLine(ctx context.Context, req *VoidPickLineRequest) (*apiresource.PickLine, *apierror.APIError)
}

type PickSvcConfig struct {
	// CoreClient (required) is the core-service picking gRPC client.
	CoreClient pb.CorePickingServiceClient
}

type RetrievePickEndpoint struct{}

type RetrievePickRequest struct {
	// Pick ID.
	PickID string `path:"id" validate:"required"`
}

type UpdatePickEndpoint struct{}

type UpdatePickLineEndpoint struct{}

type UpdatePickLineRequest struct {
	// Pick ID.
	PickID string `path:"pick_id" validate:"required"`
	// Pick line ID.
	PickLineID string `path:"id" validate:"required"`
	// New picked quantity for the line, as a decimal string read in the unit the sales order line was sold in, stored as given and not capped at the ordered quantity.
	//
	// Must not be negative. Pulling more than was ordered is a real floor event and is kept as recorded; pulling a negative amount is not.
	QuantityValue field.Optional[string] `json:"quantity_value,omitzero" validate:"omitempty,decimal,gte=0" format:"decimal"`
}

type UpdatePickRequest struct {
	// Pick ID.
	PickID string `path:"id" validate:"required"`
	// New number to assign to the pick.
	//
	// Maximum 255 characters. Renaming a pick does not rename the sales order it was created from.
	Number field.Optional[string] `json:"number,omitzero" validate:"omitempty,max=255"`
	// Timestamp when the pick was finished, in RFC 3339 format.
	//
	// Setting it closes the pick out even if lines are still unpacked; send `null` to clear it and reopen the pick.
	FinishedAt field.Clearable[string] `json:"finished_at,omitzero" validate:"omitempty,datetime=2006-01-02T15:04:05Z07:00"`
}

type VoidPickEndpoint struct{}

type VoidPickLineEndpoint struct{}

type VoidPickLineRequest struct {
	// Pick ID.
	PickID string `path:"pick_id" validate:"required"`
	// Pick line ID.
	PickLineID string `path:"id" validate:"required"`
}

type VoidPickRequest struct {
	// Pick ID.
	PickID string `path:"id" validate:"required"`
}