shippingtermep

type CreateShippingTermEndpoint struct{}

type CreateShippingTermRequest struct {
	// Human-readable name for the shipping term, used to identify it when assigning shipping terms to customers and orders.
	Name string `json:"name" validate:"required,max=255"`
	// Freight pricing model applied by this shipping term.
	//
	// - `free_freight`: the buyer is never charged for shipping.
	// - `flat_rate_freight`: the buyer is charged the fixed amount in `flat_rate`, regardless of what the carrier would have charged.
	// - `carrier_rate_freight`: the buyer is charged the rate the carrier quotes for the order's carrier and service level.
	Type constants.ShippingTermType `json:"type" validate:"required"`
	// Fixed shipping charge applied to orders.
	//
	// Used only when `type` is `flat_rate_freight`. A `flat_rate_freight` term created without a flat rate falls through to the carrier's quoted rate.
	FlatRate field.Optional[apirequest.QuantityInput] `json:"flat_rate,omitzero"`
	// Order total a buyer must exceed for this term's free-shipping rules to apply.
	//
	// Above this total, freight is free for the service levels in `free_shipping_service_level_ids`.
	MinimumOrderValue field.Optional[apirequest.QuantityInput] `json:"minimum_order_value,omitzero"`
	// IDs of the service levels that ship for free once an order exceeds `minimum_order_value`.
	//
	// Leave this empty to let every service level ship free above the threshold. The request is rejected if any ID is not a service level available to your account.
	FreeShippingServiceLevelIDs []string `json:"free_shipping_service_level_ids,omitzero"`
}

type DeleteShippingTermEndpoint struct{}

type DeleteShippingTermRequest struct {
	// Shipping term ID.
	ShippingTermID string `path:"id" validate:"required"`
}

type ListShippingTermsEndpoint struct{}

type ListShippingTermsRequest struct {
	apiresource.PaginationRequest
}

type RetrieveShippingTermEndpoint struct{}

type RetrieveShippingTermRequest struct {
	// Shipping term ID.
	ShippingTermID string `path:"id" validate:"required"`
}

type ShippingTermSvc interface {
	ListShippingTerms(ctx context.Context, req *ListShippingTermsRequest) (*apiresource.List[apiresource.ShippingTerm], *apierror.APIError)
	GetShippingTerm(ctx context.Context, req *RetrieveShippingTermRequest) (*apiresource.ShippingTerm, *apierror.APIError)
	CreateShippingTerm(ctx context.Context, req *CreateShippingTermRequest) (*apiresource.ShippingTerm, *apierror.APIError)
	UpdateShippingTerm(ctx context.Context, req *UpdateShippingTermRequest) (*apiresource.ShippingTerm, *apierror.APIError)
	DeleteShippingTerm(ctx context.Context, req *DeleteShippingTermRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

type ShippingTermSvcConfig struct {
	// CoreClient (required) is the core-service gRPC client.
	CoreClient pb.CoreServiceClient
}

type UpdateShippingTermEndpoint struct{}

type UpdateShippingTermRequest struct {
	// Shipping term ID.
	ShippingTermID string `path:"id" validate:"required"`
	// Human-readable name for the shipping term, used to identify it when assigning shipping terms to customers and orders.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Freight pricing model applied by this shipping term.
	//
	// - `free_freight`: the buyer is never charged for shipping.
	// - `flat_rate_freight`: the buyer is charged the fixed amount in `flat_rate`, regardless of what the carrier would have charged.
	// - `carrier_rate_freight`: the buyer is charged the rate the carrier quotes for the order's carrier and service level.
	Type field.Optional[constants.ShippingTermType] `json:"type,omitzero"`
	// Fixed shipping charge applied to orders.
	//
	// Used only when `type` is `flat_rate_freight`. Clearing it leaves a `flat_rate_freight` term falling through to the carrier's quoted rate.
	FlatRate field.Clearable[apirequest.QuantityInput] `json:"flat_rate,omitzero"`
	// Order total a buyer must exceed for this term's free-shipping rules to apply.
	//
	// Clearing it removes the free-shipping threshold, so orders are charged according to `type` regardless of their total.
	MinimumOrderValue field.Clearable[apirequest.QuantityInput] `json:"minimum_order_value,omitzero"`
	// IDs of the service levels that ship for free once an order exceeds `minimum_order_value`.
	//
	// Replaces the whole list rather than adding to it, and clearing it lets every service level ship free above the threshold. The request is rejected if any ID is not a service level available to your account.
	FreeShippingServiceLevelIDs field.Clearable[[]string] `json:"free_shipping_service_level_ids,omitzero"`
}