models

Documentation

Index

• type Address
• type Delivery
• type Dimension
• type Item
• type PackRequest
• type PackResponse
• type Package
• type Packaging
• type PackedItem
• type Prepackage
• type Service
• type Stack
• type Status

Types

type Address

type Address struct {
	FirstName     string   `json:"firstName,omitempty"`
	LastName      string   `json:"lastName,omitempty"`
	Company       string   `json:"company,omitempty"`
	Phone         string   `json:"phone,omitempty"`
	StreetAddress []string `json:"streetAddress,[]models.Address,omitempty"`
	City          string   `json:"city,omitempty"`
	Post          string   `json:"post,omitempty"`
	Region        string   `json:"region,omitempty"`
	Country       string   `json:"country,omitempty"`
	Residential   bool     `json:"residential,bool"`
}

type Delivery

type Delivery struct {
	GuaranteedDaysToDelivery int    `json:"guaranteedDaysToDelivery"`
	Date                     string `json:"date"`
	ScheduledDeliveryTime    string `json:"scheduledDeliveryTime,omitempty"`
	Time                     string `json:"time,omitempty"`
}

type Dimension

type Dimension struct {
	Length float64 `json:"length,float64"`
	Width  float64 `json:"width,float64"`
	Height float64 `json:"height,float64"`
}

type Item

type Item struct {
	Sku               string        `json:"sku,omitempty"`
	Name              string        `json:"name"`
	Qty               int           `json:"qty,integer"`
	Shelf             string        `json:"shelf,models.Shelf,omitempty"`
	UnitPrice         float64       `json:"unitPrice,float64,omitempty"`
	Value             float64       `json:"value,int,omitempty"`
	Weight            float64       `json:"weight,float64,omitempty"`
	WeightUnit        string        `json:"weightUnit"`
	Dimensions        []*Dimension  `json:"dimensions,[]models.Dimension"`
	DimensionUnit     string        `json:"dimensionUnit,omitempty"`
	Rotatable         bool          `json:"rotatable,omitempty"`
	Packable          bool          `json:"packable,omitempty"`
	Strappable        bool          `json:"strappable,omitempty"`
	VoidFiller        bool          `json:"voidFiller,omitempty"`
	VoidDimensions    []*Dimension  `json:"voidDimensions,[]models.Dimension,omitempty"`
	PrepackageMinQty  int           `json:"prepackMinQty,int,omitempty"`
	Prepackages       []*Prepackage `json:"prepackages,[]models.Prepackage,omitempty"`
	Stack             *Stack        `json:"stack,models.Stack,omitempty"`
	Packaging         *Packaging    `json:"packaging,models.Packaging,omitempty"`
	PreferContainers  []string      `json:"preferContainers,[]string,omitempty"`
	ExcludeContainers []string      `json:"excludeContainers,[]string,omitempty"`
	ExcludeServices   []string      `json:"excludeServices,[]string,omitempty"`
	Group             int           `json:"group,int,omitempty"`
}

type PackRequest

type PackRequest struct {
	Items               []*Item   `json:"items,models.Item,omitempty"`
	ShowRates           bool      `json:"showRates,bool,omitempty"`
	EnableCatalog       bool      `json:"enableCatalog,bool,omitempty"`
	ValidateDestination string    `json:"validateDestination,omitempty"`
	Destination         *Address  `json:"destination,models.Address,omitempty"`
	ShipDate            *Delivery `json:"shipDate,models.Delivery,omitempty"`
	VoidFill            int       `json:"voidFill,int,omitempty"`
	Services            []string  `json:"services,[]string,omitempty"`
}

type PackResponse

type PackResponse struct {
	Status           *Status
	DestinationMatch *Address
	Services         []*Service
}

type Package

type Package struct {
	Container     string  `json:"container"`
	Weight        float64 `json:"weight"`
	Length        float64 `json:"length"`
	Width         float64 `json:"width"`
	Height        float64 `json:"height"`
	WeightUnit    string  `json:"weightUnit"`
	DimensionUnit string  `json:"dimensionUnit"`
	Rate          float64 `json:"rate"`
	Value         float64 `json:"value"`
	Items         []*Item `json:"items"`
}

type Packaging

type Packaging struct {
	Length    float64
	Width     float64
	Height    float64
	Weight    float64
	Irregular bool
}

type PackedItem

type PackedItem struct {
	Sku        string      `json:"sku,omitempty"`
	Name       string      `json:"name"`
	Qty        int         `json:"qty,integer"`
	VoidSku    string      `json:"voidSku,omitempty"`
	VoidIndex  int         `json:"voidIndex,integer,omitempty"`
	Prepackage *Prepackage `json:"prepackage,models.Prepackage,omitempty"`
}

type Prepackage

type Prepackage struct {
	Id            int `json:"integer,omitempty"`
	Length        float64
	Width         float64
	Height        float64
	DimensionUnit string  `json:"string,omitempty"`
	Weight        float64 `json:"float64,omitempty"`
	Capacity      int
}

type Service

type Service struct {
	Carrier    string     `json:"carrier"`
	Service    string     `json:"service"`
	Currency   string     `json:"currency"`
	Weight     float64    `json:"weight"`
	WeightUnit string     `json:"weightUnit"`
	Rate       float64    `json:"rate"`
	Value      float64    `json:"value"`
	Packing    []*Package `json:"packing"`
	Status     struct {
		Success bool `json:"success"`
	} `json:"status"`
	ListRate float64   `json:"listRate"`
	Delivery *Delivery `json:"delivery,omitempty"`
}

type Stack

type Stack struct {
	LengthIncrement float64
	WidthIncrement  float64
	HeightIncrement float64
	MaxQty          int
}

type Status

type Status struct {
	Success  bool     `json:"success"`
	Messages []string `json:"messages,omitempty"`
}