Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

shippingv1

package

Go to main page

Versions in this module

v1

v1.0.6

Oct 23, 2023

v1.0.5

Sep 19, 2023

v1.0.4

Sep 5, 2023

v1.0.3

Sep 5, 2023

v1.0.2

Sep 2, 2023

v1.0.1

Aug 31, 2023

v1.0.0

Aug 26, 2023

Changes in this version

+ func NewCancelShipmentRequest(server string, shipmentId string) (*http.Request, error)

+ func NewCreateShipmentRequest(server string, body CreateShipmentJSONRequestBody) (*http.Request, error)

+ func NewCreateShipmentRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewGetAccountRequest(server string) (*http.Request, error)

+ func NewGetRatesRequest(server string, body GetRatesJSONRequestBody) (*http.Request, error)

+ func NewGetRatesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewGetShipmentRequest(server string, shipmentId string) (*http.Request, error)

+ func NewGetTrackingInformationRequest(server string, trackingId string) (*http.Request, error)

+ func NewPurchaseLabelsRequest(server string, shipmentId string, body PurchaseLabelsJSONRequestBody) (*http.Request, error)

+ func NewPurchaseLabelsRequestWithBody(server string, shipmentId string, contentType string, body io.Reader) (*http.Request, error)

+ func NewPurchaseShipmentRequest(server string, body PurchaseShipmentJSONRequestBody) (*http.Request, error)

+ func NewPurchaseShipmentRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewRetrieveShippingLabelRequest(server string, shipmentId string, trackingId string, ...) (*http.Request, error)

+ func NewRetrieveShippingLabelRequestWithBody(server string, shipmentId string, trackingId string, contentType string, ...) (*http.Request, error)

+ type AcceptedRate struct

+ BilledWeight *Weight

+ Promise *ShippingPromiseSet

+ ServiceType *ServiceType

+ TotalCharge *Currency

+ type Account struct

+ AccountId AccountId

+ type AccountId = string

+ type Address struct

+ AddressLine1 string

+ AddressLine2 *string

+ AddressLine3 *string

+ City City

+ CopyEmails *[]string

+ CountryCode CountryCode

+ Email *string

+ Name string

+ PhoneNumber *string

+ PostalCode PostalCode

+ StateOrRegion StateOrRegion

+ type CancelShipmentResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CancelShipmentResponse

+ JSON400 *CancelShipmentResponse

+ JSON401 *CancelShipmentResponse

+ JSON403 *CancelShipmentResponse

+ JSON404 *CancelShipmentResponse

+ JSON429 *CancelShipmentResponse

+ JSON500 *CancelShipmentResponse

+ JSON503 *CancelShipmentResponse

+ func ParseCancelShipmentResp(rsp *http.Response) (*CancelShipmentResp, error)

+ func (r CancelShipmentResp) Status() string

+ func (r CancelShipmentResp) StatusCode() int

+ type CancelShipmentResponse struct

+ Errors *ErrorList

+ type City = string

+ type Client struct

+ Client HttpRequestDoer

+ RequestEditors []RequestEditorFn

+ ResponseEditors []ResponseEditorFn

+ Server string

+ UserAgent string

+ func NewClient(server string, opts ...ClientOption) (*Client, error)

+ func (c *Client) CancelShipment(ctx context.Context, shipmentId string) (*http.Response, error)

+ func (c *Client) CreateShipment(ctx context.Context, body CreateShipmentJSONRequestBody) (*http.Response, error)

+ func (c *Client) CreateShipmentWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

+ func (c *Client) GetAccount(ctx context.Context) (*http.Response, error)

+ func (c *Client) GetRates(ctx context.Context, body GetRatesJSONRequestBody) (*http.Response, error)

+ func (c *Client) GetRatesWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

+ func (c *Client) GetShipment(ctx context.Context, shipmentId string) (*http.Response, error)

+ func (c *Client) GetTrackingInformation(ctx context.Context, trackingId string) (*http.Response, error)

+ func (c *Client) PurchaseLabels(ctx context.Context, shipmentId string, body PurchaseLabelsJSONRequestBody) (*http.Response, error)

+ func (c *Client) PurchaseLabelsWithBody(ctx context.Context, shipmentId string, contentType string, body io.Reader) (*http.Response, error)

+ func (c *Client) PurchaseShipment(ctx context.Context, body PurchaseShipmentJSONRequestBody) (*http.Response, error)

+ func (c *Client) PurchaseShipmentWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

+ func (c *Client) RetrieveShippingLabel(ctx context.Context, shipmentId string, trackingId string, ...) (*http.Response, error)

+ func (c *Client) RetrieveShippingLabelWithBody(ctx context.Context, shipmentId string, trackingId string, contentType string, ...) (*http.Response, error)

+ type ClientInterface interface

+ CancelShipment func(ctx context.Context, shipmentId string) (*http.Response, error)

+ CreateShipment func(ctx context.Context, body CreateShipmentJSONRequestBody) (*http.Response, error)

+ CreateShipmentWithBody func(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

+ GetAccount func(ctx context.Context) (*http.Response, error)

+ GetRates func(ctx context.Context, body GetRatesJSONRequestBody) (*http.Response, error)

+ GetRatesWithBody func(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

+ GetShipment func(ctx context.Context, shipmentId string) (*http.Response, error)

+ GetTrackingInformation func(ctx context.Context, trackingId string) (*http.Response, error)

+ PurchaseLabels func(ctx context.Context, shipmentId string, body PurchaseLabelsJSONRequestBody) (*http.Response, error)

+ PurchaseLabelsWithBody func(ctx context.Context, shipmentId string, contentType string, body io.Reader) (*http.Response, error)

+ PurchaseShipment func(ctx context.Context, body PurchaseShipmentJSONRequestBody) (*http.Response, error)

+ PurchaseShipmentWithBody func(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

+ RetrieveShippingLabel func(ctx context.Context, shipmentId string, trackingId string, ...) (*http.Response, error)

+ RetrieveShippingLabelWithBody func(ctx context.Context, shipmentId string, trackingId string, contentType string, ...) (*http.Response, error)

+ type ClientOption func(*Client) error

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(doer HttpRequestDoer) ClientOption

+ func WithRequestEditorFn(fn RequestEditorFn) ClientOption

+ func WithResponseEditorFn(fn ResponseEditorFn) ClientOption

+ type ClientReferenceId = string

+ type ClientWithResponses struct

+ func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

+ func (c *ClientWithResponses) CancelShipmentWithResponse(ctx context.Context, shipmentId string) (*CancelShipmentResp, error)

+ func (c *ClientWithResponses) CreateShipmentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateShipmentResp, error)

+ func (c *ClientWithResponses) CreateShipmentWithResponse(ctx context.Context, body CreateShipmentJSONRequestBody) (*CreateShipmentResp, error)

+ func (c *ClientWithResponses) GetAccountWithResponse(ctx context.Context) (*GetAccountResp, error)

+ func (c *ClientWithResponses) GetRatesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetRatesResp, error)

+ func (c *ClientWithResponses) GetRatesWithResponse(ctx context.Context, body GetRatesJSONRequestBody) (*GetRatesResp, error)

+ func (c *ClientWithResponses) GetShipmentWithResponse(ctx context.Context, shipmentId string) (*GetShipmentResp, error)

+ func (c *ClientWithResponses) GetTrackingInformationWithResponse(ctx context.Context, trackingId string) (*GetTrackingInformationResp, error)

+ func (c *ClientWithResponses) PurchaseLabelsWithBodyWithResponse(ctx context.Context, shipmentId string, contentType string, body io.Reader) (*PurchaseLabelsResp, error)

+ func (c *ClientWithResponses) PurchaseLabelsWithResponse(ctx context.Context, shipmentId string, body PurchaseLabelsJSONRequestBody) (*PurchaseLabelsResp, error)

+ func (c *ClientWithResponses) PurchaseShipmentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PurchaseShipmentResp, error)

+ func (c *ClientWithResponses) PurchaseShipmentWithResponse(ctx context.Context, body PurchaseShipmentJSONRequestBody) (*PurchaseShipmentResp, error)

+ func (c *ClientWithResponses) RetrieveShippingLabelWithBodyWithResponse(ctx context.Context, shipmentId string, trackingId string, contentType string, ...) (*RetrieveShippingLabelResp, error)

+ func (c *ClientWithResponses) RetrieveShippingLabelWithResponse(ctx context.Context, shipmentId string, trackingId string, ...) (*RetrieveShippingLabelResp, error)

+ type ClientWithResponsesInterface interface

+ CancelShipmentWithResponse func(ctx context.Context, shipmentId string) (*CancelShipmentResp, error)

+ CreateShipmentWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader) (*CreateShipmentResp, error)

+ CreateShipmentWithResponse func(ctx context.Context, body CreateShipmentJSONRequestBody) (*CreateShipmentResp, error)

+ GetAccountWithResponse func(ctx context.Context) (*GetAccountResp, error)

+ GetRatesWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader) (*GetRatesResp, error)

+ GetRatesWithResponse func(ctx context.Context, body GetRatesJSONRequestBody) (*GetRatesResp, error)

+ GetShipmentWithResponse func(ctx context.Context, shipmentId string) (*GetShipmentResp, error)

+ GetTrackingInformationWithResponse func(ctx context.Context, trackingId string) (*GetTrackingInformationResp, error)

+ PurchaseLabelsWithBodyWithResponse func(ctx context.Context, shipmentId string, contentType string, body io.Reader) (*PurchaseLabelsResp, error)

+ PurchaseLabelsWithResponse func(ctx context.Context, shipmentId string, body PurchaseLabelsJSONRequestBody) (*PurchaseLabelsResp, error)

+ PurchaseShipmentWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader) (*PurchaseShipmentResp, error)

+ PurchaseShipmentWithResponse func(ctx context.Context, body PurchaseShipmentJSONRequestBody) (*PurchaseShipmentResp, error)

+ RetrieveShippingLabelWithBodyWithResponse func(ctx context.Context, shipmentId string, trackingId string, contentType string, ...) (*RetrieveShippingLabelResp, error)

+ RetrieveShippingLabelWithResponse func(ctx context.Context, shipmentId string, trackingId string, ...) (*RetrieveShippingLabelResp, error)

+ type Container struct

+ ContainerReferenceId ContainerReferenceId

+ ContainerType *ContainerContainerType

+ Dimensions Dimensions

+ Items []ContainerItem

+ Value Currency

+ Weight Weight

+ type ContainerContainerType string

+ const PACKAGE

+ type ContainerItem struct

+ Quantity float32

+ Title string

+ UnitPrice Currency

+ UnitWeight Weight

+ type ContainerList = []Container

+ type ContainerReferenceId = string

+ type ContainerSpecification struct

+ Dimensions Dimensions

+ Weight Weight

+ type ContainerSpecificationList = []ContainerSpecification

+ type CountryCode = string

+ type CreateShipmentJSONRequestBody = CreateShipmentRequest

+ type CreateShipmentRequest struct

+ ClientReferenceId ClientReferenceId

+ Containers ContainerList

+ ShipFrom Address

+ ShipTo Address

+ type CreateShipmentResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *CreateShipmentResponse

+ JSON400 *CreateShipmentResponse

+ JSON401 *CreateShipmentResponse

+ JSON403 *CreateShipmentResponse

+ JSON404 *CreateShipmentResponse

+ JSON429 *CreateShipmentResponse

+ JSON500 *CreateShipmentResponse

+ JSON503 *CreateShipmentResponse

+ func ParseCreateShipmentResp(rsp *http.Response) (*CreateShipmentResp, error)

+ func (r CreateShipmentResp) Status() string

+ func (r CreateShipmentResp) StatusCode() int

+ type CreateShipmentResponse struct

+ Errors *ErrorList

+ Payload *CreateShipmentResult

+ type CreateShipmentResult struct

+ EligibleRates RateList

+ ShipmentId ShipmentId

+ type Currency struct

+ Unit string

+ Value float32

+ type Dimensions struct

+ Height float32

+ Length float32

+ Unit DimensionsUnit

+ Width float32

+ type DimensionsUnit string

+ const CM

+ const IN

+ type Error struct

+ Code string

+ Details *string

+ Message string

+ type ErrorList = []Error

+ type Event struct

+ EventCode EventCode

+ EventTime time.Time

+ Location *Location

+ type EventCode = string

+ type EventList = []Event

+ type GetAccountResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *GetAccountResponse

+ JSON400 *GetAccountResponse

+ JSON401 *GetAccountResponse

+ JSON403 *GetAccountResponse

+ JSON404 *GetAccountResponse

+ JSON429 *GetAccountResponse

+ JSON500 *GetAccountResponse

+ JSON503 *GetAccountResponse

+ func ParseGetAccountResp(rsp *http.Response) (*GetAccountResp, error)

+ func (r GetAccountResp) Status() string

+ func (r GetAccountResp) StatusCode() int

+ type GetAccountResponse struct

+ Errors *ErrorList

+ Payload *Account

+ type GetRatesJSONRequestBody = GetRatesRequest

+ type GetRatesRequest struct

+ ContainerSpecifications ContainerSpecificationList

+ ServiceTypes ServiceTypeList

+ ShipDate *time.Time

+ ShipFrom Address

+ ShipTo Address

+ type GetRatesResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *GetRatesResponse

+ JSON400 *GetRatesResponse

+ JSON401 *GetRatesResponse

+ JSON403 *GetRatesResponse

+ JSON404 *GetRatesResponse

+ JSON429 *GetRatesResponse

+ JSON500 *GetRatesResponse

+ JSON503 *GetRatesResponse

+ func ParseGetRatesResp(rsp *http.Response) (*GetRatesResp, error)

+ func (r GetRatesResp) Status() string

+ func (r GetRatesResp) StatusCode() int

+ type GetRatesResponse struct

+ Errors *ErrorList

+ Payload *GetRatesResult

+ type GetRatesResult struct

+ ServiceRates ServiceRateList

+ type GetShipmentResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *GetShipmentResponse

+ JSON400 *GetShipmentResponse

+ JSON401 *GetShipmentResponse

+ JSON403 *GetShipmentResponse

+ JSON404 *GetShipmentResponse

+ JSON429 *GetShipmentResponse

+ JSON500 *GetShipmentResponse

+ JSON503 *GetShipmentResponse

+ func ParseGetShipmentResp(rsp *http.Response) (*GetShipmentResp, error)

+ func (r GetShipmentResp) Status() string

+ func (r GetShipmentResp) StatusCode() int

+ type GetShipmentResponse struct

+ Errors *ErrorList

+ Payload *Shipment

+ type GetTrackingInformationResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *GetTrackingInformationResponse

+ JSON400 *GetTrackingInformationResponse

+ JSON401 *GetTrackingInformationResponse

+ JSON403 *GetTrackingInformationResponse

+ JSON404 *GetTrackingInformationResponse

+ JSON429 *GetTrackingInformationResponse

+ JSON500 *GetTrackingInformationResponse

+ JSON503 *GetTrackingInformationResponse

+ func ParseGetTrackingInformationResp(rsp *http.Response) (*GetTrackingInformationResp, error)

+ func (r GetTrackingInformationResp) Status() string

+ func (r GetTrackingInformationResp) StatusCode() int

+ type GetTrackingInformationResponse struct

+ Errors *ErrorList

+ Payload *TrackingInformation

+ type HttpRequestDoer interface

+ Do func(req *http.Request) (*http.Response, error)

+ type Label struct

+ LabelSpecification *LabelSpecification

+ LabelStream *LabelStream

+ type LabelResult struct

+ ContainerReferenceId *ContainerReferenceId

+ Label *Label

+ TrackingId *string

+ type LabelResultList = []LabelResult

+ type LabelSpecification struct

+ LabelFormat LabelSpecificationLabelFormat

+ LabelStockSize LabelSpecificationLabelStockSize

+ type LabelSpecificationLabelFormat string

+ const PNG

+ type LabelSpecificationLabelStockSize string

+ const N4x6

+ type LabelStream = string

+ type Location struct

+ City *City

+ CountryCode *CountryCode

+ PostalCode *PostalCode

+ StateOrRegion *StateOrRegion

+ type Party struct

+ AccountId *AccountId

+ type PostalCode = string

+ type PromisedDeliveryDate = time.Time

+ type PurchaseLabelsJSONRequestBody = PurchaseLabelsRequest

+ type PurchaseLabelsRequest struct

+ LabelSpecification LabelSpecification

+ RateId RateId

+ type PurchaseLabelsResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *PurchaseLabelsResponse

+ JSON400 *PurchaseLabelsResponse

+ JSON401 *PurchaseLabelsResponse

+ JSON403 *PurchaseLabelsResponse

+ JSON404 *PurchaseLabelsResponse

+ JSON429 *PurchaseLabelsResponse

+ JSON500 *PurchaseLabelsResponse

+ JSON503 *PurchaseLabelsResponse

+ func ParsePurchaseLabelsResp(rsp *http.Response) (*PurchaseLabelsResp, error)

+ func (r PurchaseLabelsResp) Status() string

+ func (r PurchaseLabelsResp) StatusCode() int

+ type PurchaseLabelsResponse struct

+ Errors *ErrorList

+ Payload *PurchaseLabelsResult

+ type PurchaseLabelsResult struct

+ AcceptedRate AcceptedRate

+ ClientReferenceId *ClientReferenceId

+ LabelResults LabelResultList

+ ShipmentId ShipmentId

+ type PurchaseShipmentJSONRequestBody = PurchaseShipmentRequest

+ type PurchaseShipmentRequest struct

+ ClientReferenceId ClientReferenceId

+ Containers ContainerList

+ LabelSpecification LabelSpecification

+ ServiceType ServiceType

+ ShipDate *time.Time

+ ShipFrom Address

+ ShipTo Address

+ type PurchaseShipmentResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *PurchaseShipmentResponse

+ JSON400 *PurchaseShipmentResponse

+ JSON401 *PurchaseShipmentResponse

+ JSON403 *PurchaseShipmentResponse

+ JSON404 *PurchaseShipmentResponse

+ JSON429 *PurchaseShipmentResponse

+ JSON500 *PurchaseShipmentResponse

+ JSON503 *PurchaseShipmentResponse

+ func ParsePurchaseShipmentResp(rsp *http.Response) (*PurchaseShipmentResp, error)

+ func (r PurchaseShipmentResp) Status() string

+ func (r PurchaseShipmentResp) StatusCode() int

+ type PurchaseShipmentResponse struct

+ Errors *ErrorList

+ Payload *PurchaseShipmentResult

+ type PurchaseShipmentResult struct

+ LabelResults LabelResultList

+ ServiceRate ServiceRate

+ ShipmentId ShipmentId

+ type Rate struct

+ BilledWeight *Weight

+ ExpirationTime *time.Time

+ Promise *ShippingPromiseSet

+ RateId *string

+ ServiceType *ServiceType

+ TotalCharge *Currency

+ type RateId = string

+ type RateList = []Rate

+ type RequestEditorFn func(ctx context.Context, req *http.Request) error

+ type ResponseEditorFn func(ctx context.Context, rsp *http.Response) error

+ type RetrieveShippingLabelJSONRequestBody = RetrieveShippingLabelRequest

+ type RetrieveShippingLabelRequest struct

+ LabelSpecification LabelSpecification

+ type RetrieveShippingLabelResp struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *RetrieveShippingLabelResponse

+ JSON400 *RetrieveShippingLabelResponse

+ JSON401 *RetrieveShippingLabelResponse

+ JSON403 *RetrieveShippingLabelResponse

+ JSON404 *RetrieveShippingLabelResponse

+ JSON429 *RetrieveShippingLabelResponse

+ JSON500 *RetrieveShippingLabelResponse

+ JSON503 *RetrieveShippingLabelResponse

+ func ParseRetrieveShippingLabelResp(rsp *http.Response) (*RetrieveShippingLabelResp, error)

+ func (r RetrieveShippingLabelResp) Status() string

+ func (r RetrieveShippingLabelResp) StatusCode() int

+ type RetrieveShippingLabelResponse struct

+ Errors *ErrorList

+ Payload *RetrieveShippingLabelResult

+ type RetrieveShippingLabelResult struct

+ LabelSpecification LabelSpecification

+ LabelStream LabelStream

+ type ServiceRate struct

+ BillableWeight Weight

+ Promise ShippingPromiseSet

+ ServiceType ServiceType

+ TotalCharge Currency

+ type ServiceRateList = []ServiceRate

+ type ServiceType string

+ const AmazonShippingGround

+ const AmazonShippingPremium

+ const AmazonShippingStandard

+ type ServiceTypeList = []ServiceType

+ type Shipment struct

+ AcceptedRate *AcceptedRate

+ ClientReferenceId ClientReferenceId

+ Containers ContainerList

+ ShipFrom Address

+ ShipTo Address

+ ShipmentId ShipmentId

+ Shipper *Party

+ type ShipmentId = string

+ type ShippingPromiseSet struct

+ DeliveryWindow *TimeRange

+ ReceiveWindow *TimeRange

+ type StateOrRegion = string

+ type TimeRange struct

+ End *time.Time

+ Start *time.Time

+ type TrackingId = string

+ type TrackingInformation struct

+ EventHistory EventList

+ PromisedDeliveryDate PromisedDeliveryDate

+ Summary TrackingSummary

+ TrackingId TrackingId

+ type TrackingSummary struct

+ Status *string

+ type Weight struct

+ Unit WeightUnit

+ Value float32

+ type WeightUnit string

+ const G

+ const Kg

+ const Lb

+ const Oz