shippingoptions

Documentation

Index

• type ListCartData
• type ListCartResponse
  • func ListCartOptions(cartId string, config *medusa.Config) (*ListCartResponse, error)
• type ListShippingOption
  • func NewListShippingOption() *ListShippingOption
  • func (l *ListShippingOption) List(config *medusa.Config) (*ListShippingOptionResponse, error)
  • func (l *ListShippingOption) SetIsreturn(isReturn bool) *ListShippingOption
  • func (l *ListShippingOption) SetProductIds(productIds string) *ListShippingOption
  • func (l *ListShippingOption) SetRegionId(regionId string) *ListShippingOption
• type ListShippingOptionData
• type ListShippingOptionResponse

Types

type ListCartData

type ListCartData struct {
	ShippingOptions []*schema.ShippingOption `json:"shipping_options"`
}

type ListCartResponse

type ListCartResponse struct {
	// Success response
	Data *ListCartData

	// Error response
	Error *response.Error

	// Errors in case of multiple errors
	Errors *response.Errors
}

func ListCartOptions

func ListCartOptions(cartId string, config *medusa.Config) (*ListCartResponse, error)

Retrieves a list of Shipping Options available to a cart.

type ListShippingOption

type ListShippingOption struct {
	// Whether return Shipping Options should be included. By default all Shipping Options are returned.
	IsReturn bool `json:"is_return,omitempty" url:"is_return,omitempty"`

	// A comma separated list of Product ids to filter Shipping Options by.
	ProductIds string `json:"product_ids,omitempty" url:"product_ids,omitempty"`

	// the Region to retrieve Shipping Options from.
	RegionId string `json:"region_id,omitempty" url:"region_id,omitempty"`
}

func NewListShippingOption

func NewListShippingOption() *ListShippingOption

func (*ListShippingOption) List

func (l *ListShippingOption) List(config *medusa.Config) (*ListShippingOptionResponse, error)

func (*ListShippingOption) SetIsreturn

func (l *ListShippingOption) SetIsreturn(isReturn bool) *ListShippingOption

func (*ListShippingOption) SetProductIds

func (l *ListShippingOption) SetProductIds(productIds string) *ListShippingOption

func (*ListShippingOption) SetRegionId

func (l *ListShippingOption) SetRegionId(regionId string) *ListShippingOption

type ListShippingOptionData

type ListShippingOptionData struct {
	ShippingOptions []*schema.ShippingOption `json:"shipping_options"`
}

type ListShippingOptionResponse

type ListShippingOptionResponse struct {
	// Success response
	Data *ListShippingOptionData

	// Error response
	Error *response.Error

	// Errors in case of multiple errors
	Errors *response.Errors
}