Documentation ¶
Overview ¶
Package shippingv2 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 DO NOT EDIT.
Index ¶
- func NewCancelShipmentRequest(server string, shipmentId string, params *CancelShipmentParams) (*http.Request, error)
- func NewGetAccessPointsRequest(server string, params *GetAccessPointsParams) (*http.Request, error)
- func NewGetAdditionalInputsRequest(server string, params *GetAdditionalInputsParams) (*http.Request, error)
- func NewGetRatesRequest(server string, params *GetRatesParams, body GetRatesJSONRequestBody) (*http.Request, error)
- func NewGetRatesRequestWithBody(server string, params *GetRatesParams, contentType string, body io.Reader) (*http.Request, error)
- func NewGetShipmentDocumentsRequest(server string, shipmentId string, params *GetShipmentDocumentsParams) (*http.Request, error)
- func NewGetTrackingRequest(server string, params *GetTrackingParams) (*http.Request, error)
- func NewOneClickShipmentRequest(server string, params *OneClickShipmentParams, ...) (*http.Request, error)
- func NewOneClickShipmentRequestWithBody(server string, params *OneClickShipmentParams, contentType string, ...) (*http.Request, error)
- func NewPurchaseShipmentRequest(server string, params *PurchaseShipmentParams, ...) (*http.Request, error)
- func NewPurchaseShipmentRequestWithBody(server string, params *PurchaseShipmentParams, contentType string, ...) (*http.Request, error)
- func NewSubmitNdrFeedbackRequest(server string, params *SubmitNdrFeedbackParams, ...) (*http.Request, error)
- func NewSubmitNdrFeedbackRequestWithBody(server string, params *SubmitNdrFeedbackParams, contentType string, ...) (*http.Request, error)
- type AccessPoint
- type AccessPointAssistanceType
- type AccessPointDetails
- type AccessPointId
- type AccessPointList
- type AccessPointType
- type AccessPointsMap
- type AccessibilityAttributes
- type AdditionalAddressNotes
- type Address
- type AlternateLegTrackingId
- type AmazonOrderDetails
- type AmazonShipmentDetails
- type AvailableValueAddedServiceGroup
- type AvailableValueAddedServiceGroupList
- type Benefits
- type CancelShipmentParams
- type CancelShipmentParamsXAmznShippingBusinessId
- type CancelShipmentResp
- type CancelShipmentResponse
- type CancelShipmentResult
- type Carrier
- type CarrierId
- type CarrierName
- type ChannelDetails
- type ChannelType
- type ChargeComponent
- type ChargeComponentChargeType
- type ChargeList
- type City
- type Client
- func (c *Client) CancelShipment(ctx context.Context, shipmentId string, params *CancelShipmentParams) (*http.Response, error)
- func (c *Client) GetAccessPoints(ctx context.Context, params *GetAccessPointsParams) (*http.Response, error)
- func (c *Client) GetAdditionalInputs(ctx context.Context, params *GetAdditionalInputsParams) (*http.Response, error)
- func (c *Client) GetRates(ctx context.Context, params *GetRatesParams, body GetRatesJSONRequestBody) (*http.Response, error)
- func (c *Client) GetRatesWithBody(ctx context.Context, params *GetRatesParams, contentType string, ...) (*http.Response, error)
- func (c *Client) GetShipmentDocuments(ctx context.Context, shipmentId string, params *GetShipmentDocumentsParams) (*http.Response, error)
- func (c *Client) GetTracking(ctx context.Context, params *GetTrackingParams) (*http.Response, error)
- func (c *Client) OneClickShipment(ctx context.Context, params *OneClickShipmentParams, ...) (*http.Response, error)
- func (c *Client) OneClickShipmentWithBody(ctx context.Context, params *OneClickShipmentParams, contentType string, ...) (*http.Response, error)
- func (c *Client) PurchaseShipment(ctx context.Context, params *PurchaseShipmentParams, ...) (*http.Response, error)
- func (c *Client) PurchaseShipmentWithBody(ctx context.Context, params *PurchaseShipmentParams, contentType string, ...) (*http.Response, error)
- func (c *Client) SubmitNdrFeedback(ctx context.Context, params *SubmitNdrFeedbackParams, ...) (*http.Response, error)
- func (c *Client) SubmitNdrFeedbackWithBody(ctx context.Context, params *SubmitNdrFeedbackParams, contentType string, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientReferenceDetail
- type ClientReferenceDetailClientReferenceType
- type ClientReferenceDetails
- type ClientWithResponses
- func (c *ClientWithResponses) CancelShipmentWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams) (*CancelShipmentResp, error)
- func (c *ClientWithResponses) GetAccessPointsWithResponse(ctx context.Context, params *GetAccessPointsParams) (*GetAccessPointsResp, error)
- func (c *ClientWithResponses) GetAdditionalInputsWithResponse(ctx context.Context, params *GetAdditionalInputsParams) (*GetAdditionalInputsResp, error)
- func (c *ClientWithResponses) GetRatesWithBodyWithResponse(ctx context.Context, params *GetRatesParams, contentType string, ...) (*GetRatesResp, error)
- func (c *ClientWithResponses) GetRatesWithResponse(ctx context.Context, params *GetRatesParams, body GetRatesJSONRequestBody) (*GetRatesResp, error)
- func (c *ClientWithResponses) GetShipmentDocumentsWithResponse(ctx context.Context, shipmentId string, params *GetShipmentDocumentsParams) (*GetShipmentDocumentsResp, error)
- func (c *ClientWithResponses) GetTrackingWithResponse(ctx context.Context, params *GetTrackingParams) (*GetTrackingResp, error)
- func (c *ClientWithResponses) OneClickShipmentWithBodyWithResponse(ctx context.Context, params *OneClickShipmentParams, contentType string, ...) (*OneClickShipmentResp, error)
- func (c *ClientWithResponses) OneClickShipmentWithResponse(ctx context.Context, params *OneClickShipmentParams, ...) (*OneClickShipmentResp, error)
- func (c *ClientWithResponses) PurchaseShipmentWithBodyWithResponse(ctx context.Context, params *PurchaseShipmentParams, contentType string, ...) (*PurchaseShipmentResp, error)
- func (c *ClientWithResponses) PurchaseShipmentWithResponse(ctx context.Context, params *PurchaseShipmentParams, ...) (*PurchaseShipmentResp, error)
- func (c *ClientWithResponses) SubmitNdrFeedbackWithBodyWithResponse(ctx context.Context, params *SubmitNdrFeedbackParams, contentType string, ...) (*SubmitNdrFeedbackResp, error)
- func (c *ClientWithResponses) SubmitNdrFeedbackWithResponse(ctx context.Context, params *SubmitNdrFeedbackParams, ...) (*SubmitNdrFeedbackResp, error)
- type ClientWithResponsesInterface
- type CollectOnDelivery
- type Contents
- type CountryCode
- type Currency
- type DangerousGoodsDetails
- type DangerousGoodsDetailsPackingGroup
- type DangerousGoodsDetailsPackingInstruction
- type DateRange
- type DayOfWeekTimeMap
- type DetailCodes
- type Dimensions
- type DimensionsUnit
- type DirectFulfillmentItemIdentifiers
- type DocumentFormat
- type DocumentSize
- type DocumentSizeUnit
- type DocumentType
- type Dpi
- type Error
- type ErrorList
- type Event
- type EventCode
- type ExceptionOperatingHours
- type ExcludedBenefit
- type ExcludedBenefits
- type Geocode
- type GetAccessPointsParams
- type GetAccessPointsParamsAccessPointTypes
- type GetAccessPointsParamsXAmznShippingBusinessId
- type GetAccessPointsResp
- type GetAccessPointsResponse
- type GetAccessPointsResult
- type GetAdditionalInputsParams
- type GetAdditionalInputsParamsXAmznShippingBusinessId
- type GetAdditionalInputsResp
- type GetAdditionalInputsResponse
- type GetAdditionalInputsResult
- type GetRatesJSONRequestBody
- type GetRatesParams
- type GetRatesParamsXAmznShippingBusinessId
- type GetRatesRequest
- type GetRatesResp
- type GetRatesResponse
- type GetRatesResult
- type GetShipmentDocumentsParams
- type GetShipmentDocumentsParamsXAmznShippingBusinessId
- type GetShipmentDocumentsResp
- type GetShipmentDocumentsResponse
- type GetShipmentDocumentsResult
- type GetTrackingParams
- type GetTrackingParamsXAmznShippingBusinessId
- type GetTrackingResp
- type GetTrackingResponse
- type GetTrackingResult
- type HttpRequestDoer
- type IncludedBenefits
- type IneligibilityReason
- type IneligibilityReasonCode
- type IneligibleRate
- type IneligibleRateList
- type InvoiceDetails
- type Item
- type ItemList
- type LiquidVolume
- type LiquidVolumeUnit
- type Location
- type NdrAction
- type NdrRequestData
- type NeedFileJoining
- type OneClickShipmentJSONRequestBody
- type OneClickShipmentParams
- type OneClickShipmentParamsXAmznShippingBusinessId
- type OneClickShipmentRequest
- type OneClickShipmentResp
- type OneClickShipmentResponse
- type OneClickShipmentResult
- type OneClickShipmentValueAddedService
- type OneClickShipmentValueAddedServiceDetails
- type OperatingHours
- type Package
- type PackageClientReferenceId
- type PackageDocument
- type PackageDocumentDetail
- type PackageDocumentDetailList
- type PackageDocumentList
- type PackageList
- type PageLayout
- type PaymentType
- type PostalCode
- type PrintOption
- type PrintOptionList
- type Promise
- type PurchaseShipmentJSONRequestBody
- type PurchaseShipmentParams
- type PurchaseShipmentParamsXAmznShippingBusinessId
- type PurchaseShipmentRequest
- type PurchaseShipmentResp
- type PurchaseShipmentResponse
- type PurchaseShipmentResult
- type Rate
- type RateId
- type RateItem
- type RateItemID
- type RateItemList
- type RateItemType
- type RateList
- type RequestEditorFn
- type RequestToken
- type RequestedDocumentSpecification
- type RequestedValueAddedService
- type RequestedValueAddedServiceList
- type ResponseEditorFn
- type Service
- type ServiceId
- type ServiceIds
- type ServiceName
- type ServiceSelection
- type ShipmentId
- type ShipmentType
- type ShipperInstruction
- type StateOrRegion
- type Status
- type SubmitNdrFeedbackJSONRequestBody
- type SubmitNdrFeedbackParams
- type SubmitNdrFeedbackParamsXAmznShippingBusinessId
- type SubmitNdrFeedbackRequest
- type SubmitNdrFeedbackResp
- type SupportedDocumentDetail
- type SupportedDocumentSpecification
- type SupportedDocumentSpecificationList
- type TaxDetail
- type TaxDetailList
- type TaxType
- type TimeOfDay
- type TimeWindow
- type TrackingDetailCodes
- type TrackingId
- type TrackingSummary
- type ValueAddedService
- type ValueAddedServiceDetails
- type Weight
- type WeightUnit
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCancelShipmentRequest ¶
func NewCancelShipmentRequest(server string, shipmentId string, params *CancelShipmentParams) (*http.Request, error)
NewCancelShipmentRequest generates requests for CancelShipment
func NewGetAccessPointsRequest ¶
func NewGetAccessPointsRequest(server string, params *GetAccessPointsParams) (*http.Request, error)
NewGetAccessPointsRequest generates requests for GetAccessPoints
func NewGetAdditionalInputsRequest ¶
func NewGetAdditionalInputsRequest(server string, params *GetAdditionalInputsParams) (*http.Request, error)
NewGetAdditionalInputsRequest generates requests for GetAdditionalInputs
func NewGetRatesRequest ¶
func NewGetRatesRequest(server string, params *GetRatesParams, body GetRatesJSONRequestBody) (*http.Request, error)
NewGetRatesRequest calls the generic GetRates builder with application/json body
func NewGetRatesRequestWithBody ¶
func NewGetRatesRequestWithBody(server string, params *GetRatesParams, contentType string, body io.Reader) (*http.Request, error)
NewGetRatesRequestWithBody generates requests for GetRates with any type of body
func NewGetShipmentDocumentsRequest ¶
func NewGetShipmentDocumentsRequest(server string, shipmentId string, params *GetShipmentDocumentsParams) (*http.Request, error)
NewGetShipmentDocumentsRequest generates requests for GetShipmentDocuments
func NewGetTrackingRequest ¶
func NewGetTrackingRequest(server string, params *GetTrackingParams) (*http.Request, error)
NewGetTrackingRequest generates requests for GetTracking
func NewOneClickShipmentRequest ¶
func NewOneClickShipmentRequest(server string, params *OneClickShipmentParams, body OneClickShipmentJSONRequestBody) (*http.Request, error)
NewOneClickShipmentRequest calls the generic OneClickShipment builder with application/json body
func NewOneClickShipmentRequestWithBody ¶
func NewOneClickShipmentRequestWithBody(server string, params *OneClickShipmentParams, contentType string, body io.Reader) (*http.Request, error)
NewOneClickShipmentRequestWithBody generates requests for OneClickShipment with any type of body
func NewPurchaseShipmentRequest ¶
func NewPurchaseShipmentRequest(server string, params *PurchaseShipmentParams, body PurchaseShipmentJSONRequestBody) (*http.Request, error)
NewPurchaseShipmentRequest calls the generic PurchaseShipment builder with application/json body
func NewPurchaseShipmentRequestWithBody ¶
func NewPurchaseShipmentRequestWithBody(server string, params *PurchaseShipmentParams, contentType string, body io.Reader) (*http.Request, error)
NewPurchaseShipmentRequestWithBody generates requests for PurchaseShipment with any type of body
func NewSubmitNdrFeedbackRequest ¶
func NewSubmitNdrFeedbackRequest(server string, params *SubmitNdrFeedbackParams, body SubmitNdrFeedbackJSONRequestBody) (*http.Request, error)
NewSubmitNdrFeedbackRequest calls the generic SubmitNdrFeedback builder with application/json body
func NewSubmitNdrFeedbackRequestWithBody ¶
func NewSubmitNdrFeedbackRequestWithBody(server string, params *SubmitNdrFeedbackParams, contentType string, body io.Reader) (*http.Request, error)
NewSubmitNdrFeedbackRequestWithBody generates requests for SubmitNdrFeedback with any type of body
Types ¶
type AccessPoint ¶
type AccessPoint struct { // AccessPointId Unique identifier for the access point AccessPointId *AccessPointId `json:"accessPointId,omitempty"` // AccessibilityAttributes Defines the accessibility details of the access point. AccessibilityAttributes *AccessibilityAttributes `json:"accessibilityAttributes,omitempty"` // Address The address. Address *Address `json:"address,omitempty"` AssistanceType *AccessPointAssistanceType `json:"assistanceType,omitempty"` ExceptionOperatingHours *[]ExceptionOperatingHours `json:"exceptionOperatingHours,omitempty"` // Name Name of entity (store/hub etc) where this access point is located Name *string `json:"name,omitempty"` // Score The score of access point, based on proximity to postal code and sorting preference. This can be used to sort access point results on shipper's end. Score *string `json:"score,omitempty"` // StandardOperatingHours Map of day of the week to operating hours of that day StandardOperatingHours *DayOfWeekTimeMap `json:"standardOperatingHours,omitempty"` // Timezone Timezone of access point Timezone *string `json:"timezone,omitempty"` // Type The type of access point, like counter (HELIX), lockers, etc. Type *AccessPointType `json:"type,omitempty"` }
AccessPoint Access point details
type AccessPointAssistanceType ¶
type AccessPointAssistanceType string
AccessPointAssistanceType defines model for AccessPoint.AssistanceType.
const ( SELFASSISTED AccessPointAssistanceType = "SELF_ASSISTED" STAFFASSISTED AccessPointAssistanceType = "STAFF_ASSISTED" )
Defines values for AccessPointAssistanceType.
type AccessPointDetails ¶
type AccessPointDetails struct { // AccessPointId Unique identifier for the access point AccessPointId *AccessPointId `json:"accessPointId,omitempty"` }
AccessPointDetails defines model for AccessPointDetails.
type AccessPointId ¶
type AccessPointId = string
AccessPointId Unique identifier for the access point
type AccessPointList ¶
type AccessPointList = []AccessPoint
AccessPointList List of relevant Access points requested by shipper. These access points are sorted by proximity to postal code, and are limited to 40. We have internally defined a radius value to render relevant results.
type AccessPointType ¶
type AccessPointType string
AccessPointType The type of access point, like counter (HELIX), lockers, etc.
const ( AccessPointTypeCAMPUSLOCKER AccessPointType = "CAMPUS_LOCKER" AccessPointTypeCAMPUSROOM AccessPointType = "CAMPUS_ROOM" AccessPointTypeCORELOCKER AccessPointType = "CORE_LOCKER" AccessPointTypeDOBBYLOCKER AccessPointType = "DOBBY_LOCKER" AccessPointTypeHELIX AccessPointType = "HELIX" AccessPointTypeN3P AccessPointType = "3P" AccessPointTypeODINLOCKER AccessPointType = "ODIN_LOCKER" AccessPointTypeOMNILOCKER AccessPointType = "OMNI_LOCKER" )
Defines values for AccessPointType.
type AccessPointsMap ¶
type AccessPointsMap map[string]AccessPointList
AccessPointsMap Map of type of access point to list of access points
type AccessibilityAttributes ¶
type AccessibilityAttributes struct { // Distance The approximate distance of access point from input postalCode's centroid. Distance *string `json:"distance,omitempty"` // DriveTime The approximate (static) drive time from input postal code's centroid. DriveTime *int `json:"driveTime,omitempty"` }
AccessibilityAttributes Defines the accessibility details of the access point.
type AdditionalAddressNotes ¶
type AdditionalAddressNotes = string
AdditionalAddressNotes Address notes to re-attempt delivery with.
type Address ¶
type Address struct { // AddressLine1 The first line of the address. AddressLine1 string `json:"addressLine1"` // AddressLine2 Additional address information, if required. AddressLine2 *string `json:"addressLine2,omitempty"` // AddressLine3 Additional address information, if required. AddressLine3 *string `json:"addressLine3,omitempty"` // City The city or town where the person, business or institution is located. City City `json:"city"` // CompanyName The name of the business or institution associated with the address. CompanyName *string `json:"companyName,omitempty"` // CountryCode The two digit country code. Follows ISO 3166-1 alpha-2 format. CountryCode CountryCode `json:"countryCode"` // Email The email address of the contact associated with the address. Email *string `json:"email,omitempty"` // Geocode Defines the latitude and longitude of the access point. Geocode *Geocode `json:"geocode,omitempty"` // Name The name of the person, business or institution at the address. Name string `json:"name"` // PhoneNumber The phone number of the person, business or institution located at that address, including the country calling code. PhoneNumber *string `json:"phoneNumber,omitempty"` // PostalCode The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. PostalCode PostalCode `json:"postalCode"` // StateOrRegion The state, county or region where the person, business or institution is located. StateOrRegion StateOrRegion `json:"stateOrRegion"` }
Address The address.
type AlternateLegTrackingId ¶
type AlternateLegTrackingId = string
AlternateLegTrackingId The carrier generated reverse identifier for a returned package in a purchased shipment.
type AmazonOrderDetails ¶
type AmazonOrderDetails struct { // OrderId The Amazon order ID associated with the Amazon order fulfilled by this shipment. OrderId string `json:"orderId"` }
AmazonOrderDetails Amazon order information. This is required if the shipment source channel is Amazon.
type AmazonShipmentDetails ¶
type AmazonShipmentDetails struct { // ShipmentId This attribute is required only for a Direct Fulfillment shipment. This is the encrypted shipment ID. ShipmentId string `json:"shipmentId"` }
AmazonShipmentDetails Amazon shipment information.
type AvailableValueAddedServiceGroup ¶
type AvailableValueAddedServiceGroup struct { // GroupDescription The name of the value-added service group. GroupDescription string `json:"groupDescription"` // GroupId The type of the value-added service group. GroupId string `json:"groupId"` // IsRequired When true, one or more of the value-added services listed must be specified. IsRequired bool `json:"isRequired"` // ValueAddedServices A list of optional value-added services available for purchase with a shipping service offering. ValueAddedServices *[]ValueAddedService `json:"valueAddedServices,omitempty"` }
AvailableValueAddedServiceGroup The value-added services available for purchase with a shipping service offering.
type AvailableValueAddedServiceGroupList ¶
type AvailableValueAddedServiceGroupList = []AvailableValueAddedServiceGroup
AvailableValueAddedServiceGroupList A list of value-added services available for a shipping service offering.
type Benefits ¶
type Benefits struct { // ExcludedBenefits A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation ExcludedBenefits ExcludedBenefits `json:"excludedBenefits"` // IncludedBenefits A list of included benefits. IncludedBenefits IncludedBenefits `json:"includedBenefits"` }
Benefits Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon.
type CancelShipmentParams ¶
type CancelShipmentParams struct { // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId CancelShipmentParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id"` }
CancelShipmentParams defines parameters for CancelShipment.
type CancelShipmentParamsXAmznShippingBusinessId ¶
type CancelShipmentParamsXAmznShippingBusinessId string
CancelShipmentParamsXAmznShippingBusinessId defines parameters for CancelShipment.
const ( CancelShipmentParamsXAmznShippingBusinessIdAmazonShippingES CancelShipmentParamsXAmznShippingBusinessId = "AmazonShipping_ES" CancelShipmentParamsXAmznShippingBusinessIdAmazonShippingFR CancelShipmentParamsXAmznShippingBusinessId = "AmazonShipping_FR" CancelShipmentParamsXAmznShippingBusinessIdAmazonShippingIN CancelShipmentParamsXAmznShippingBusinessId = "AmazonShipping_IN" CancelShipmentParamsXAmznShippingBusinessIdAmazonShippingIT CancelShipmentParamsXAmznShippingBusinessId = "AmazonShipping_IT" CancelShipmentParamsXAmznShippingBusinessIdAmazonShippingUK CancelShipmentParamsXAmznShippingBusinessId = "AmazonShipping_UK" CancelShipmentParamsXAmznShippingBusinessIdAmazonShippingUS CancelShipmentParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for CancelShipmentParamsXAmznShippingBusinessId.
type CancelShipmentResp ¶
type CancelShipmentResp struct { Body []byte HTTPResponse *http.Response JSON200 *CancelShipmentResponse JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParseCancelShipmentResp ¶
func ParseCancelShipmentResp(rsp *http.Response) (*CancelShipmentResp, error)
ParseCancelShipmentResp parses an HTTP response from a CancelShipmentWithResponse call
func (CancelShipmentResp) Status ¶
func (r CancelShipmentResp) Status() string
Status returns HTTPResponse.Status
func (CancelShipmentResp) StatusCode ¶
func (r CancelShipmentResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CancelShipmentResponse ¶
type CancelShipmentResponse struct { // Payload The payload for the cancelShipment operation. Payload *CancelShipmentResult `json:"payload,omitempty"` }
CancelShipmentResponse Response schema for the cancelShipment operation.
type CancelShipmentResult ¶
type CancelShipmentResult map[string]interface{}
CancelShipmentResult The payload for the cancelShipment operation.
type Carrier ¶
type Carrier struct { // Id The carrier identifier for the offering, provided by the carrier. Id CarrierId `json:"id"` // Name The carrier name for the offering. Name CarrierName `json:"name"` }
Carrier Carrier Related Info
type CarrierId ¶
type CarrierId = string
CarrierId The carrier identifier for the offering, provided by the carrier.
type ChannelDetails ¶
type ChannelDetails struct { // AmazonOrderDetails Amazon order information. This is required if the shipment source channel is Amazon. AmazonOrderDetails *AmazonOrderDetails `json:"amazonOrderDetails,omitempty"` // AmazonShipmentDetails Amazon shipment information. AmazonShipmentDetails *AmazonShipmentDetails `json:"amazonShipmentDetails,omitempty"` // ChannelType The shipment source channel type. ChannelType ChannelType `json:"channelType"` }
ChannelDetails Shipment source channel related information.
type ChannelType ¶
type ChannelType string
ChannelType The shipment source channel type.
const ( AMAZON ChannelType = "AMAZON" EXTERNAL ChannelType = "EXTERNAL" )
Defines values for ChannelType.
type ChargeComponent ¶
type ChargeComponent struct { // Amount The monetary value in the currency indicated, in ISO 4217 standard format. Amount *Currency `json:"amount,omitempty"` // ChargeType The type of charge. ChargeType *ChargeComponentChargeType `json:"chargeType,omitempty"` }
ChargeComponent The type and amount of a charge applied on a package.
type ChargeComponentChargeType ¶
type ChargeComponentChargeType string
ChargeComponentChargeType The type of charge.
const ( DISCOUNT ChargeComponentChargeType = "DISCOUNT" TAX ChargeComponentChargeType = "TAX" )
Defines values for ChargeComponentChargeType.
type ChargeList ¶
type ChargeList = []ChargeComponent
ChargeList A list of charges based on the shipping service charges applied on a package.
type City ¶
type City = string
City The city or town where the person, business or institution is located.
type Client ¶
type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. This can contain a path relative // to the server, such as https://api.deepmap.com/dev-test, and all the // paths in the swagger spec will be appended to the server. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn // A callback for modifying response which are generated after receive from the network. ResponseEditors []ResponseEditorFn // The user agent header identifies your application, its version number, and the platform and programming language you are using. // You must include a user agent header in each request submitted to the sales partner API. UserAgent string }
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) CancelShipment ¶
func (*Client) GetAccessPoints ¶
func (*Client) GetAdditionalInputs ¶
func (*Client) GetRates ¶
func (c *Client) GetRates(ctx context.Context, params *GetRatesParams, body GetRatesJSONRequestBody) (*http.Response, error)
func (*Client) GetRatesWithBody ¶
func (*Client) GetShipmentDocuments ¶
func (*Client) GetTracking ¶
func (*Client) OneClickShipment ¶
func (c *Client) OneClickShipment(ctx context.Context, params *OneClickShipmentParams, body OneClickShipmentJSONRequestBody) (*http.Response, error)
func (*Client) OneClickShipmentWithBody ¶
func (*Client) PurchaseShipment ¶
func (c *Client) PurchaseShipment(ctx context.Context, params *PurchaseShipmentParams, body PurchaseShipmentJSONRequestBody) (*http.Response, error)
func (*Client) PurchaseShipmentWithBody ¶
func (*Client) SubmitNdrFeedback ¶
func (c *Client) SubmitNdrFeedback(ctx context.Context, params *SubmitNdrFeedbackParams, body SubmitNdrFeedbackJSONRequestBody) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface { // GetAccessPoints request GetAccessPoints(ctx context.Context, params *GetAccessPointsParams) (*http.Response, error) // SubmitNdrFeedbackWithBody request with any body SubmitNdrFeedbackWithBody(ctx context.Context, params *SubmitNdrFeedbackParams, contentType string, body io.Reader) (*http.Response, error) SubmitNdrFeedback(ctx context.Context, params *SubmitNdrFeedbackParams, body SubmitNdrFeedbackJSONRequestBody) (*http.Response, error) // OneClickShipmentWithBody request with any body OneClickShipmentWithBody(ctx context.Context, params *OneClickShipmentParams, contentType string, body io.Reader) (*http.Response, error) OneClickShipment(ctx context.Context, params *OneClickShipmentParams, body OneClickShipmentJSONRequestBody) (*http.Response, error) // PurchaseShipmentWithBody request with any body PurchaseShipmentWithBody(ctx context.Context, params *PurchaseShipmentParams, contentType string, body io.Reader) (*http.Response, error) PurchaseShipment(ctx context.Context, params *PurchaseShipmentParams, body PurchaseShipmentJSONRequestBody) (*http.Response, error) // GetAdditionalInputs request GetAdditionalInputs(ctx context.Context, params *GetAdditionalInputsParams) (*http.Response, error) // GetRatesWithBody request with any body GetRatesWithBody(ctx context.Context, params *GetRatesParams, contentType string, body io.Reader) (*http.Response, error) GetRates(ctx context.Context, params *GetRatesParams, body GetRatesJSONRequestBody) (*http.Response, error) // CancelShipment request CancelShipment(ctx context.Context, shipmentId string, params *CancelShipmentParams) (*http.Response, error) // GetShipmentDocuments request GetShipmentDocuments(ctx context.Context, shipmentId string, params *GetShipmentDocumentsParams) (*http.Response, error) // GetTracking request GetTracking(ctx context.Context, params *GetTrackingParams) (*http.Response, error) }
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
func WithResponseEditorFn ¶
func WithResponseEditorFn(fn ResponseEditorFn) ClientOption
WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.
type ClientReferenceDetail ¶
type ClientReferenceDetail struct { // ClientReferenceId The Client Reference Id. ClientReferenceId string `json:"clientReferenceId"` // ClientReferenceType Client Reference type. ClientReferenceType ClientReferenceDetailClientReferenceType `json:"clientReferenceType"` }
ClientReferenceDetail Client Reference Details
type ClientReferenceDetailClientReferenceType ¶
type ClientReferenceDetailClientReferenceType string
ClientReferenceDetailClientReferenceType Client Reference type.
const ( IntegratorMerchantId ClientReferenceDetailClientReferenceType = "IntegratorMerchantId" IntegratorShipperId ClientReferenceDetailClientReferenceType = "IntegratorShipperId" )
Defines values for ClientReferenceDetailClientReferenceType.
type ClientReferenceDetails ¶
type ClientReferenceDetails = []ClientReferenceDetail
ClientReferenceDetails Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) CancelShipmentWithResponse ¶
func (c *ClientWithResponses) CancelShipmentWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams) (*CancelShipmentResp, error)
CancelShipmentWithResponse request returning *CancelShipmentResp
func (*ClientWithResponses) GetAccessPointsWithResponse ¶
func (c *ClientWithResponses) GetAccessPointsWithResponse(ctx context.Context, params *GetAccessPointsParams) (*GetAccessPointsResp, error)
GetAccessPointsWithResponse request returning *GetAccessPointsResp
func (*ClientWithResponses) GetAdditionalInputsWithResponse ¶
func (c *ClientWithResponses) GetAdditionalInputsWithResponse(ctx context.Context, params *GetAdditionalInputsParams) (*GetAdditionalInputsResp, error)
GetAdditionalInputsWithResponse request returning *GetAdditionalInputsResp
func (*ClientWithResponses) GetRatesWithBodyWithResponse ¶
func (c *ClientWithResponses) GetRatesWithBodyWithResponse(ctx context.Context, params *GetRatesParams, contentType string, body io.Reader) (*GetRatesResp, error)
GetRatesWithBodyWithResponse request with arbitrary body returning *GetRatesResp
func (*ClientWithResponses) GetRatesWithResponse ¶
func (c *ClientWithResponses) GetRatesWithResponse(ctx context.Context, params *GetRatesParams, body GetRatesJSONRequestBody) (*GetRatesResp, error)
func (*ClientWithResponses) GetShipmentDocumentsWithResponse ¶
func (c *ClientWithResponses) GetShipmentDocumentsWithResponse(ctx context.Context, shipmentId string, params *GetShipmentDocumentsParams) (*GetShipmentDocumentsResp, error)
GetShipmentDocumentsWithResponse request returning *GetShipmentDocumentsResp
func (*ClientWithResponses) GetTrackingWithResponse ¶
func (c *ClientWithResponses) GetTrackingWithResponse(ctx context.Context, params *GetTrackingParams) (*GetTrackingResp, error)
GetTrackingWithResponse request returning *GetTrackingResp
func (*ClientWithResponses) OneClickShipmentWithBodyWithResponse ¶
func (c *ClientWithResponses) OneClickShipmentWithBodyWithResponse(ctx context.Context, params *OneClickShipmentParams, contentType string, body io.Reader) (*OneClickShipmentResp, error)
OneClickShipmentWithBodyWithResponse request with arbitrary body returning *OneClickShipmentResp
func (*ClientWithResponses) OneClickShipmentWithResponse ¶
func (c *ClientWithResponses) OneClickShipmentWithResponse(ctx context.Context, params *OneClickShipmentParams, body OneClickShipmentJSONRequestBody) (*OneClickShipmentResp, error)
func (*ClientWithResponses) PurchaseShipmentWithBodyWithResponse ¶
func (c *ClientWithResponses) PurchaseShipmentWithBodyWithResponse(ctx context.Context, params *PurchaseShipmentParams, contentType string, body io.Reader) (*PurchaseShipmentResp, error)
PurchaseShipmentWithBodyWithResponse request with arbitrary body returning *PurchaseShipmentResp
func (*ClientWithResponses) PurchaseShipmentWithResponse ¶
func (c *ClientWithResponses) PurchaseShipmentWithResponse(ctx context.Context, params *PurchaseShipmentParams, body PurchaseShipmentJSONRequestBody) (*PurchaseShipmentResp, error)
func (*ClientWithResponses) SubmitNdrFeedbackWithBodyWithResponse ¶
func (c *ClientWithResponses) SubmitNdrFeedbackWithBodyWithResponse(ctx context.Context, params *SubmitNdrFeedbackParams, contentType string, body io.Reader) (*SubmitNdrFeedbackResp, error)
SubmitNdrFeedbackWithBodyWithResponse request with arbitrary body returning *SubmitNdrFeedbackResp
func (*ClientWithResponses) SubmitNdrFeedbackWithResponse ¶
func (c *ClientWithResponses) SubmitNdrFeedbackWithResponse(ctx context.Context, params *SubmitNdrFeedbackParams, body SubmitNdrFeedbackJSONRequestBody) (*SubmitNdrFeedbackResp, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface { // GetAccessPointsWithResponse request GetAccessPointsWithResponse(ctx context.Context, params *GetAccessPointsParams) (*GetAccessPointsResp, error) // SubmitNdrFeedbackWithBodyWithResponse request with any body SubmitNdrFeedbackWithBodyWithResponse(ctx context.Context, params *SubmitNdrFeedbackParams, contentType string, body io.Reader) (*SubmitNdrFeedbackResp, error) SubmitNdrFeedbackWithResponse(ctx context.Context, params *SubmitNdrFeedbackParams, body SubmitNdrFeedbackJSONRequestBody) (*SubmitNdrFeedbackResp, error) // OneClickShipmentWithBodyWithResponse request with any body OneClickShipmentWithBodyWithResponse(ctx context.Context, params *OneClickShipmentParams, contentType string, body io.Reader) (*OneClickShipmentResp, error) OneClickShipmentWithResponse(ctx context.Context, params *OneClickShipmentParams, body OneClickShipmentJSONRequestBody) (*OneClickShipmentResp, error) // PurchaseShipmentWithBodyWithResponse request with any body PurchaseShipmentWithBodyWithResponse(ctx context.Context, params *PurchaseShipmentParams, contentType string, body io.Reader) (*PurchaseShipmentResp, error) PurchaseShipmentWithResponse(ctx context.Context, params *PurchaseShipmentParams, body PurchaseShipmentJSONRequestBody) (*PurchaseShipmentResp, error) // GetAdditionalInputsWithResponse request GetAdditionalInputsWithResponse(ctx context.Context, params *GetAdditionalInputsParams) (*GetAdditionalInputsResp, error) // GetRatesWithBodyWithResponse request with any body GetRatesWithBodyWithResponse(ctx context.Context, params *GetRatesParams, contentType string, body io.Reader) (*GetRatesResp, error) GetRatesWithResponse(ctx context.Context, params *GetRatesParams, body GetRatesJSONRequestBody) (*GetRatesResp, error) // CancelShipmentWithResponse request CancelShipmentWithResponse(ctx context.Context, shipmentId string, params *CancelShipmentParams) (*CancelShipmentResp, error) // GetShipmentDocumentsWithResponse request GetShipmentDocumentsWithResponse(ctx context.Context, shipmentId string, params *GetShipmentDocumentsParams) (*GetShipmentDocumentsResp, error) // GetTrackingWithResponse request GetTrackingWithResponse(ctx context.Context, params *GetTrackingParams) (*GetTrackingResp, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CollectOnDelivery ¶
type CollectOnDelivery struct { // Amount The monetary value in the currency indicated, in ISO 4217 standard format. Amount Currency `json:"amount"` }
CollectOnDelivery The amount to collect on delivery.
type CountryCode ¶
type CountryCode = string
CountryCode The two digit country code. Follows ISO 3166-1 alpha-2 format.
type Currency ¶
type Currency struct { // Unit The ISO 4217 format 3-character currency code. Unit string `json:"unit"` // Value The monetary value. Value float32 `json:"value"` }
Currency The monetary value in the currency indicated, in ISO 4217 standard format.
type DangerousGoodsDetails ¶
type DangerousGoodsDetails struct { // PackingGroup The specific packaging group of the item being shipped. PackingGroup *DangerousGoodsDetailsPackingGroup `json:"packingGroup,omitempty"` // PackingInstruction The specific packing instruction of the item being shipped. PackingInstruction *DangerousGoodsDetailsPackingInstruction `json:"packingInstruction,omitempty"` // TransportationRegulatoryClass The specific regulatory class of the item being shipped. TransportationRegulatoryClass *string `json:"transportationRegulatoryClass,omitempty"` // UnitedNationsRegulatoryId The specific UNID of the item being shipped. UnitedNationsRegulatoryId *string `json:"unitedNationsRegulatoryId,omitempty"` }
DangerousGoodsDetails Details related to any dangerous goods/items that are being shipped.
type DangerousGoodsDetailsPackingGroup ¶
type DangerousGoodsDetailsPackingGroup string
DangerousGoodsDetailsPackingGroup The specific packaging group of the item being shipped.
const ( I DangerousGoodsDetailsPackingGroup = "I" II DangerousGoodsDetailsPackingGroup = "II" III DangerousGoodsDetailsPackingGroup = "III" )
Defines values for DangerousGoodsDetailsPackingGroup.
type DangerousGoodsDetailsPackingInstruction ¶
type DangerousGoodsDetailsPackingInstruction string
DangerousGoodsDetailsPackingInstruction The specific packing instruction of the item being shipped.
const ( PI965SECTIONIA DangerousGoodsDetailsPackingInstruction = "PI965_SECTION_IA" PI965SECTIONIB DangerousGoodsDetailsPackingInstruction = "PI965_SECTION_IB" PI965SECTIONII DangerousGoodsDetailsPackingInstruction = "PI965_SECTION_II" PI966SECTIONI DangerousGoodsDetailsPackingInstruction = "PI966_SECTION_I" PI966SECTIONII DangerousGoodsDetailsPackingInstruction = "PI966_SECTION_II" PI967SECTIONI DangerousGoodsDetailsPackingInstruction = "PI967_SECTION_I" PI967SECTIONII DangerousGoodsDetailsPackingInstruction = "PI967_SECTION_II" PI968SECTIONIA DangerousGoodsDetailsPackingInstruction = "PI968_SECTION_IA" PI968SECTIONIB DangerousGoodsDetailsPackingInstruction = "PI968_SECTION_IB" PI969SECTIONI DangerousGoodsDetailsPackingInstruction = "PI969_SECTION_I" PI969SECTIONII DangerousGoodsDetailsPackingInstruction = "PI969_SECTION_II" PI970SECTIONI DangerousGoodsDetailsPackingInstruction = "PI970_SECTION_I" PI970SECTIONII DangerousGoodsDetailsPackingInstruction = "PI970_SECTION_II" )
Defines values for DangerousGoodsDetailsPackingInstruction.
type DateRange ¶
type DateRange struct { // EndDate end date for query. EndDate *string `json:"endDate,omitempty"` // StartDate Start Date for query . StartDate *string `json:"startDate,omitempty"` }
DateRange Date Range for query the results.
type DayOfWeekTimeMap ¶
type DayOfWeekTimeMap map[string]OperatingHours
DayOfWeekTimeMap Map of day of the week to operating hours of that day
type DetailCodes ¶
type DetailCodes string
DetailCodes A list of codes used to provide additional shipment information.
const ( DetailCodesAddressNotFound DetailCodes = "AddressNotFound" DetailCodesBusinessClosed DetailCodes = "BusinessClosed" DetailCodesCancelledByRecipient DetailCodes = "CancelledByRecipient" DetailCodesDamaged DetailCodes = "Damaged" DetailCodesDeliveredToBehindWheelieBin DetailCodes = "DeliveredToBehindWheelieBin" DetailCodesDeliveredToGarage DetailCodes = "DeliveredToGarage" DetailCodesDeliveredToGarden DetailCodes = "DeliveredToGarden" DetailCodesDeliveredToGreenhouse DetailCodes = "DeliveredToGreenhouse" DetailCodesDeliveredToMailRoom DetailCodes = "DeliveredToMailRoom" DetailCodesDeliveredToMailSlot DetailCodes = "DeliveredToMailSlot" DetailCodesDeliveredToNeighbor DetailCodes = "DeliveredToNeighbor" DetailCodesDeliveredToPorch DetailCodes = "DeliveredToPorch" DetailCodesDeliveredToRearDoor DetailCodes = "DeliveredToRearDoor" DetailCodesDeliveredToReceptionist DetailCodes = "DeliveredToReceptionist" DetailCodesDeliveredToShed DetailCodes = "DeliveredToShed" DetailCodesDeliveryAttempted DetailCodes = "DeliveryAttempted" DetailCodesHazmatShipment DetailCodes = "HazmatShipment" DetailCodesIncorrectItems DetailCodes = "IncorrectItems" DetailCodesNotRequired DetailCodes = "NotRequired" DetailCodesOtpNotAvailable DetailCodes = "OtpNotAvailable" DetailCodesPaymentNotReady DetailCodes = "PaymentNotReady" DetailCodesRejected DetailCodes = "Rejected" DetailCodesSigned DetailCodes = "Signed" DetailCodesUnableToAccess DetailCodes = "UnableToAccess" DetailCodesUnableToContactRecipient DetailCodes = "UnableToContactRecipient" DetailCodesUndeliverable DetailCodes = "Undeliverable" )
Defines values for DetailCodes.
type Dimensions ¶
type Dimensions struct { // Height The height of the package. Height float32 `json:"height"` // Length The length of the package. Length float32 `json:"length"` // Unit The unit of measurement. Unit DimensionsUnit `json:"unit"` // Width The width of the package. Width float32 `json:"width"` }
Dimensions A set of measurements for a three-dimensional object.
type DimensionsUnit ¶
type DimensionsUnit string
DimensionsUnit The unit of measurement.
const ( DimensionsUnitCENTIMETER DimensionsUnit = "CENTIMETER" DimensionsUnitINCH DimensionsUnit = "INCH" )
Defines values for DimensionsUnit.
type DirectFulfillmentItemIdentifiers ¶
type DirectFulfillmentItemIdentifiers struct { // LineItemID A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated for direct fulfillment multi-piece shipments. It is required if a vendor wants to change the configuration of the packages in which the purchase order is shipped. LineItemID string `json:"lineItemID"` // PieceNumber A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated if a single line item has multiple pieces. Defaults to 1. PieceNumber *string `json:"pieceNumber,omitempty"` }
DirectFulfillmentItemIdentifiers Item identifiers for an item in a direct fulfillment shipment.
type DocumentFormat ¶
type DocumentFormat string
DocumentFormat The file format of the document.
const ( PDF DocumentFormat = "PDF" PNG DocumentFormat = "PNG" ZPL DocumentFormat = "ZPL" )
Defines values for DocumentFormat.
type DocumentSize ¶
type DocumentSize struct { // Length The length of the document measured in the units specified. Length float32 `json:"length"` // Unit The unit of measurement. Unit DocumentSizeUnit `json:"unit"` // Width The width of the document measured in the units specified. Width float32 `json:"width"` }
DocumentSize The size dimensions of the label.
type DocumentSizeUnit ¶
type DocumentSizeUnit string
DocumentSizeUnit The unit of measurement.
const ( DocumentSizeUnitCENTIMETER DocumentSizeUnit = "CENTIMETER" DocumentSizeUnitINCH DocumentSizeUnit = "INCH" )
Defines values for DocumentSizeUnit.
type DocumentType ¶
type DocumentType string
DocumentType The type of shipping document.
const ( CUSTOMFORM DocumentType = "CUSTOM_FORM" LABEL DocumentType = "LABEL" PACKSLIP DocumentType = "PACKSLIP" RECEIPT DocumentType = "RECEIPT" )
Defines values for DocumentType.
type Dpi ¶
type Dpi = int
Dpi The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document.
type Error ¶
type Error struct { // Code An error code that identifies the type of error that occurred. Code string `json:"code"` // Details Additional details that can help the caller understand or fix the issue. Details *string `json:"details,omitempty"` // Message A message that describes the error condition. Message string `json:"message"` }
Error Error response returned when the request is unsuccessful.
type ErrorList ¶
type ErrorList struct {
Errors []Error `json:"errors"`
}
ErrorList A list of error responses returned when a request is unsuccessful.
type Event ¶
type Event struct { // EventCode The tracking event type. EventCode EventCode `json:"eventCode"` // EventTime The ISO 8601 formatted timestamp of the event. EventTime time.Time `json:"eventTime"` // Location The location where the person, business or institution is located. Location *Location `json:"location,omitempty"` // ShipmentType Shipment type. ShipmentType *ShipmentType `json:"shipmentType,omitempty"` }
Event A tracking event.
type EventCode ¶
type EventCode string
EventCode The tracking event type.
const ( EventCodeArrivedAtCarrierFacility EventCode = "ArrivedAtCarrierFacility" EventCodeAvailableForPickup EventCode = "AvailableForPickup" EventCodeDelivered EventCode = "Delivered" EventCodeDeliveryAttempted EventCode = "DeliveryAttempted" EventCodeDeparted EventCode = "Departed" EventCodeLost EventCode = "Lost" EventCodeOutForDelivery EventCode = "OutForDelivery" EventCodePickupCancelled EventCode = "PickupCancelled" EventCodePickupDone EventCode = "PickupDone" EventCodeReadyForReceive EventCode = "ReadyForReceive" EventCodeRejected EventCode = "Rejected" EventCodeReturnInitiated EventCode = "ReturnInitiated" EventCodeUndeliverable EventCode = "Undeliverable" )
Defines values for EventCode.
type ExceptionOperatingHours ¶
type ExceptionOperatingHours struct { // DateRange Date Range for query the results. DateRange *DateRange `json:"dateRange,omitempty"` // OperatingHours The hours in which the access point shall remain operational OperatingHours *OperatingHours `json:"operatingHours,omitempty"` }
ExceptionOperatingHours Defines exceptions to standard operating hours for certain date ranges.
type ExcludedBenefit ¶
type ExcludedBenefit struct { Benefit string `json:"benefit"` ReasonCode string `json:"reasonCode"` }
ExcludedBenefit Object representing an excluded benefit that is excluded for an ShippingOffering/Rate.
type ExcludedBenefits ¶
type ExcludedBenefits = []ExcludedBenefit
ExcludedBenefits A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation
type Geocode ¶
type Geocode struct { // Latitude The latitude of access point. Latitude *string `json:"latitude,omitempty"` // Longitude The longitude of access point. Longitude *string `json:"longitude,omitempty"` }
Geocode Defines the latitude and longitude of the access point.
type GetAccessPointsParams ¶
type GetAccessPointsParams struct { AccessPointTypes []GetAccessPointsParamsAccessPointTypes `form:"accessPointTypes" json:"accessPointTypes"` CountryCode string `form:"countryCode" json:"countryCode"` PostalCode string `form:"postalCode" json:"postalCode"` // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId GetAccessPointsParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id"` }
GetAccessPointsParams defines parameters for GetAccessPoints.
type GetAccessPointsParamsAccessPointTypes ¶
type GetAccessPointsParamsAccessPointTypes string
GetAccessPointsParamsAccessPointTypes defines parameters for GetAccessPoints.
const ( GetAccessPointsParamsAccessPointTypesCAMPUSLOCKER GetAccessPointsParamsAccessPointTypes = "CAMPUS_LOCKER" GetAccessPointsParamsAccessPointTypesCAMPUSROOM GetAccessPointsParamsAccessPointTypes = "CAMPUS_ROOM" GetAccessPointsParamsAccessPointTypesCORELOCKER GetAccessPointsParamsAccessPointTypes = "CORE_LOCKER" GetAccessPointsParamsAccessPointTypesDOBBYLOCKER GetAccessPointsParamsAccessPointTypes = "DOBBY_LOCKER" GetAccessPointsParamsAccessPointTypesHELIX GetAccessPointsParamsAccessPointTypes = "HELIX" GetAccessPointsParamsAccessPointTypesN3P GetAccessPointsParamsAccessPointTypes = "3P" GetAccessPointsParamsAccessPointTypesODINLOCKER GetAccessPointsParamsAccessPointTypes = "ODIN_LOCKER" GetAccessPointsParamsAccessPointTypesOMNILOCKER GetAccessPointsParamsAccessPointTypes = "OMNI_LOCKER" )
Defines values for GetAccessPointsParamsAccessPointTypes.
type GetAccessPointsParamsXAmznShippingBusinessId ¶
type GetAccessPointsParamsXAmznShippingBusinessId string
GetAccessPointsParamsXAmznShippingBusinessId defines parameters for GetAccessPoints.
const ( GetAccessPointsParamsXAmznShippingBusinessIdAmazonShippingES GetAccessPointsParamsXAmznShippingBusinessId = "AmazonShipping_ES" GetAccessPointsParamsXAmznShippingBusinessIdAmazonShippingFR GetAccessPointsParamsXAmznShippingBusinessId = "AmazonShipping_FR" GetAccessPointsParamsXAmznShippingBusinessIdAmazonShippingIN GetAccessPointsParamsXAmznShippingBusinessId = "AmazonShipping_IN" GetAccessPointsParamsXAmznShippingBusinessIdAmazonShippingIT GetAccessPointsParamsXAmznShippingBusinessId = "AmazonShipping_IT" GetAccessPointsParamsXAmznShippingBusinessIdAmazonShippingUK GetAccessPointsParamsXAmznShippingBusinessId = "AmazonShipping_UK" GetAccessPointsParamsXAmznShippingBusinessIdAmazonShippingUS GetAccessPointsParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for GetAccessPointsParamsXAmznShippingBusinessId.
type GetAccessPointsResp ¶
type GetAccessPointsResp struct { Body []byte HTTPResponse *http.Response JSON200 *GetAccessPointsResponse JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParseGetAccessPointsResp ¶
func ParseGetAccessPointsResp(rsp *http.Response) (*GetAccessPointsResp, error)
ParseGetAccessPointsResp parses an HTTP response from a GetAccessPointsWithResponse call
func (GetAccessPointsResp) Status ¶
func (r GetAccessPointsResp) Status() string
Status returns HTTPResponse.Status
func (GetAccessPointsResp) StatusCode ¶
func (r GetAccessPointsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetAccessPointsResponse ¶
type GetAccessPointsResponse struct { // Payload The payload for the GetAccessPoints API. Payload *GetAccessPointsResult `json:"payload,omitempty"` }
GetAccessPointsResponse The response schema for the GetAccessPoints operation.
type GetAccessPointsResult ¶
type GetAccessPointsResult struct { // AccessPointsMap Map of type of access point to list of access points AccessPointsMap AccessPointsMap `json:"accessPointsMap"` }
GetAccessPointsResult The payload for the GetAccessPoints API.
type GetAdditionalInputsParams ¶
type GetAdditionalInputsParams struct { // RequestToken The request token returned in the response to the getRates operation. RequestToken string `form:"requestToken" json:"requestToken"` // RateId The rate identifier for the shipping offering (rate) returned in the response to the getRates operation. RateId string `form:"rateId" json:"rateId"` // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId *GetAdditionalInputsParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id,omitempty"` }
GetAdditionalInputsParams defines parameters for GetAdditionalInputs.
type GetAdditionalInputsParamsXAmznShippingBusinessId ¶
type GetAdditionalInputsParamsXAmznShippingBusinessId string
GetAdditionalInputsParamsXAmznShippingBusinessId defines parameters for GetAdditionalInputs.
const ( GetAdditionalInputsParamsXAmznShippingBusinessIdAmazonShippingES GetAdditionalInputsParamsXAmznShippingBusinessId = "AmazonShipping_ES" GetAdditionalInputsParamsXAmznShippingBusinessIdAmazonShippingFR GetAdditionalInputsParamsXAmznShippingBusinessId = "AmazonShipping_FR" GetAdditionalInputsParamsXAmznShippingBusinessIdAmazonShippingIN GetAdditionalInputsParamsXAmznShippingBusinessId = "AmazonShipping_IN" GetAdditionalInputsParamsXAmznShippingBusinessIdAmazonShippingIT GetAdditionalInputsParamsXAmznShippingBusinessId = "AmazonShipping_IT" GetAdditionalInputsParamsXAmznShippingBusinessIdAmazonShippingUK GetAdditionalInputsParamsXAmznShippingBusinessId = "AmazonShipping_UK" GetAdditionalInputsParamsXAmznShippingBusinessIdAmazonShippingUS GetAdditionalInputsParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for GetAdditionalInputsParamsXAmznShippingBusinessId.
type GetAdditionalInputsResp ¶
type GetAdditionalInputsResp struct { Body []byte HTTPResponse *http.Response JSON200 *GetAdditionalInputsResponse JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParseGetAdditionalInputsResp ¶
func ParseGetAdditionalInputsResp(rsp *http.Response) (*GetAdditionalInputsResp, error)
ParseGetAdditionalInputsResp parses an HTTP response from a GetAdditionalInputsWithResponse call
func (GetAdditionalInputsResp) Status ¶
func (r GetAdditionalInputsResp) Status() string
Status returns HTTPResponse.Status
func (GetAdditionalInputsResp) StatusCode ¶
func (r GetAdditionalInputsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetAdditionalInputsResponse ¶
type GetAdditionalInputsResponse struct { // Payload The JSON schema to use to provide additional inputs when required to purchase a shipping offering. Payload *GetAdditionalInputsResult `json:"payload,omitempty"` }
GetAdditionalInputsResponse The response schema for the getAdditionalInputs operation.
type GetAdditionalInputsResult ¶
type GetAdditionalInputsResult map[string]interface{}
GetAdditionalInputsResult The JSON schema to use to provide additional inputs when required to purchase a shipping offering.
type GetRatesJSONRequestBody ¶
type GetRatesJSONRequestBody = GetRatesRequest
GetRatesJSONRequestBody defines body for GetRates for application/json ContentType.
type GetRatesParams ¶
type GetRatesParams struct { // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId GetRatesParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id"` }
GetRatesParams defines parameters for GetRates.
type GetRatesParamsXAmznShippingBusinessId ¶
type GetRatesParamsXAmznShippingBusinessId string
GetRatesParamsXAmznShippingBusinessId defines parameters for GetRates.
const ( GetRatesParamsXAmznShippingBusinessIdAmazonShippingES GetRatesParamsXAmznShippingBusinessId = "AmazonShipping_ES" GetRatesParamsXAmznShippingBusinessIdAmazonShippingFR GetRatesParamsXAmznShippingBusinessId = "AmazonShipping_FR" GetRatesParamsXAmznShippingBusinessIdAmazonShippingIN GetRatesParamsXAmznShippingBusinessId = "AmazonShipping_IN" GetRatesParamsXAmznShippingBusinessIdAmazonShippingIT GetRatesParamsXAmznShippingBusinessId = "AmazonShipping_IT" GetRatesParamsXAmznShippingBusinessIdAmazonShippingUK GetRatesParamsXAmznShippingBusinessId = "AmazonShipping_UK" GetRatesParamsXAmznShippingBusinessIdAmazonShippingUS GetRatesParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for GetRatesParamsXAmznShippingBusinessId.
type GetRatesRequest ¶
type GetRatesRequest struct { // ChannelDetails Shipment source channel related information. ChannelDetails ChannelDetails `json:"channelDetails"` // ClientReferenceDetails Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail ClientReferenceDetails *ClientReferenceDetails `json:"clientReferenceDetails,omitempty"` DestinationAccessPointDetails *AccessPointDetails `json:"destinationAccessPointDetails,omitempty"` // Packages A list of packages to be shipped through a shipping service offering. Packages PackageList `json:"packages"` // ReturnTo The address. ReturnTo *Address `json:"returnTo,omitempty"` // ShipDate The ship date and time (the requested pickup). This defaults to the current date and time. ShipDate *time.Time `json:"shipDate,omitempty"` // ShipFrom The address. ShipFrom Address `json:"shipFrom"` // ShipTo The address. ShipTo *Address `json:"shipTo,omitempty"` // ShipmentType Shipment type. ShipmentType *ShipmentType `json:"shipmentType,omitempty"` // ShipperInstruction The shipper instruction. ShipperInstruction *ShipperInstruction `json:"shipperInstruction,omitempty"` // TaxDetails A list of tax detail information. TaxDetails *TaxDetailList `json:"taxDetails,omitempty"` // ValueAddedServices A collection of supported value-added services. ValueAddedServices *ValueAddedServiceDetails `json:"valueAddedServices,omitempty"` }
GetRatesRequest The request schema for the getRates operation. When the channelType is Amazon, the shipTo address is not required and will be ignored.
type GetRatesResp ¶
type GetRatesResp struct { Body []byte HTTPResponse *http.Response JSON200 *GetRatesResponse JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParseGetRatesResp ¶
func ParseGetRatesResp(rsp *http.Response) (*GetRatesResp, error)
ParseGetRatesResp parses an HTTP response from a GetRatesWithResponse call
func (GetRatesResp) Status ¶
func (r GetRatesResp) Status() string
Status returns HTTPResponse.Status
func (GetRatesResp) StatusCode ¶
func (r GetRatesResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetRatesResponse ¶
type GetRatesResponse struct { // Payload The payload for the getRates operation. Payload *GetRatesResult `json:"payload,omitempty"` }
GetRatesResponse The response schema for the getRates operation.
type GetRatesResult ¶
type GetRatesResult struct { // IneligibleRates A list of ineligible shipping service offerings. IneligibleRates *IneligibleRateList `json:"ineligibleRates,omitempty"` // Rates A list of eligible shipping service offerings. Rates RateList `json:"rates"` // RequestToken A unique token generated to identify a getRates operation. RequestToken RequestToken `json:"requestToken"` }
GetRatesResult The payload for the getRates operation.
type GetShipmentDocumentsParams ¶
type GetShipmentDocumentsParams struct { // PackageClientReferenceId The package client reference identifier originally provided in the request body parameter for the getRates operation. PackageClientReferenceId string `form:"packageClientReferenceId" json:"packageClientReferenceId"` // Format The file format of the document. Must be one of the supported formats returned by the getRates operation. Format *string `form:"format,omitempty" json:"format,omitempty"` // Dpi The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation. Dpi *float32 `form:"dpi,omitempty" json:"dpi,omitempty"` // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId GetShipmentDocumentsParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id"` }
GetShipmentDocumentsParams defines parameters for GetShipmentDocuments.
type GetShipmentDocumentsParamsXAmznShippingBusinessId ¶
type GetShipmentDocumentsParamsXAmznShippingBusinessId string
GetShipmentDocumentsParamsXAmznShippingBusinessId defines parameters for GetShipmentDocuments.
const ( GetShipmentDocumentsParamsXAmznShippingBusinessIdAmazonShippingES GetShipmentDocumentsParamsXAmznShippingBusinessId = "AmazonShipping_ES" GetShipmentDocumentsParamsXAmznShippingBusinessIdAmazonShippingFR GetShipmentDocumentsParamsXAmznShippingBusinessId = "AmazonShipping_FR" GetShipmentDocumentsParamsXAmznShippingBusinessIdAmazonShippingIN GetShipmentDocumentsParamsXAmznShippingBusinessId = "AmazonShipping_IN" GetShipmentDocumentsParamsXAmznShippingBusinessIdAmazonShippingIT GetShipmentDocumentsParamsXAmznShippingBusinessId = "AmazonShipping_IT" GetShipmentDocumentsParamsXAmznShippingBusinessIdAmazonShippingUK GetShipmentDocumentsParamsXAmznShippingBusinessId = "AmazonShipping_UK" GetShipmentDocumentsParamsXAmznShippingBusinessIdAmazonShippingUS GetShipmentDocumentsParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for GetShipmentDocumentsParamsXAmznShippingBusinessId.
type GetShipmentDocumentsResp ¶
type GetShipmentDocumentsResp struct { Body []byte HTTPResponse *http.Response JSON200 *GetShipmentDocumentsResponse JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParseGetShipmentDocumentsResp ¶
func ParseGetShipmentDocumentsResp(rsp *http.Response) (*GetShipmentDocumentsResp, error)
ParseGetShipmentDocumentsResp parses an HTTP response from a GetShipmentDocumentsWithResponse call
func (GetShipmentDocumentsResp) Status ¶
func (r GetShipmentDocumentsResp) Status() string
Status returns HTTPResponse.Status
func (GetShipmentDocumentsResp) StatusCode ¶
func (r GetShipmentDocumentsResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetShipmentDocumentsResponse ¶
type GetShipmentDocumentsResponse struct { // Payload The payload for the getShipmentDocuments operation. Payload *GetShipmentDocumentsResult `json:"payload,omitempty"` }
GetShipmentDocumentsResponse The response schema for the the getShipmentDocuments operation.
type GetShipmentDocumentsResult ¶
type GetShipmentDocumentsResult struct { // PackageDocumentDetail The post-purchase details of a package that will be shipped using a shipping service. PackageDocumentDetail PackageDocumentDetail `json:"packageDocumentDetail"` // ShipmentId The unique shipment identifier provided by a shipping service. ShipmentId ShipmentId `json:"shipmentId"` }
GetShipmentDocumentsResult The payload for the getShipmentDocuments operation.
type GetTrackingParams ¶
type GetTrackingParams struct { // TrackingId A carrier-generated tracking identifier originally returned by the purchaseShipment operation. TrackingId string `form:"trackingId" json:"trackingId"` // CarrierId A carrier identifier originally returned by the getRates operation for the selected rate. CarrierId string `form:"carrierId" json:"carrierId"` // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId *GetTrackingParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id,omitempty"` }
GetTrackingParams defines parameters for GetTracking.
type GetTrackingParamsXAmznShippingBusinessId ¶
type GetTrackingParamsXAmznShippingBusinessId string
GetTrackingParamsXAmznShippingBusinessId defines parameters for GetTracking.
const ( AmazonShippingES GetTrackingParamsXAmznShippingBusinessId = "AmazonShipping_ES" AmazonShippingFR GetTrackingParamsXAmznShippingBusinessId = "AmazonShipping_FR" AmazonShippingIN GetTrackingParamsXAmznShippingBusinessId = "AmazonShipping_IN" AmazonShippingIT GetTrackingParamsXAmznShippingBusinessId = "AmazonShipping_IT" AmazonShippingUK GetTrackingParamsXAmznShippingBusinessId = "AmazonShipping_UK" AmazonShippingUS GetTrackingParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for GetTrackingParamsXAmznShippingBusinessId.
type GetTrackingResp ¶
type GetTrackingResp struct { Body []byte HTTPResponse *http.Response JSON200 *GetTrackingResponse JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParseGetTrackingResp ¶
func ParseGetTrackingResp(rsp *http.Response) (*GetTrackingResp, error)
ParseGetTrackingResp parses an HTTP response from a GetTrackingWithResponse call
func (GetTrackingResp) Status ¶
func (r GetTrackingResp) Status() string
Status returns HTTPResponse.Status
func (GetTrackingResp) StatusCode ¶
func (r GetTrackingResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetTrackingResponse ¶
type GetTrackingResponse struct { // Payload The payload for the getTracking operation. Payload *GetTrackingResult `json:"payload,omitempty"` }
GetTrackingResponse The response schema for the getTracking operation.
type GetTrackingResult ¶
type GetTrackingResult struct { // AlternateLegTrackingId The carrier generated reverse identifier for a returned package in a purchased shipment. AlternateLegTrackingId AlternateLegTrackingId `json:"alternateLegTrackingId"` // EventHistory A list of tracking events. EventHistory []Event `json:"eventHistory"` // PromisedDeliveryDate The date and time by which the shipment is promised to be delivered. PromisedDeliveryDate time.Time `json:"promisedDeliveryDate"` // Summary A package status summary. Summary TrackingSummary `json:"summary"` // TrackingId The carrier generated identifier for a package in a purchased shipment. TrackingId TrackingId `json:"trackingId"` }
GetTrackingResult The payload for the getTracking operation.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type IncludedBenefits ¶
type IncludedBenefits = []string
IncludedBenefits A list of included benefits.
type IneligibilityReason ¶
type IneligibilityReason struct { // Code Reasons that make a shipment service offering ineligible. Code IneligibilityReasonCode `json:"code"` // Message The ineligibility reason. Message string `json:"message"` }
IneligibilityReason The reason why a shipping service offering is ineligible.
type IneligibilityReasonCode ¶
type IneligibilityReasonCode string
IneligibilityReasonCode Reasons that make a shipment service offering ineligible.
const ( LATEDELIVERY IneligibilityReasonCode = "LATE_DELIVERY" NOCOVERAGE IneligibilityReasonCode = "NO_COVERAGE" PICKUPSLOTRESTRICTION IneligibilityReasonCode = "PICKUP_SLOT_RESTRICTION" PROGRAMCONSTRAINTS IneligibilityReasonCode = "PROGRAM_CONSTRAINTS" SIZERESTRICTIONS IneligibilityReasonCode = "SIZE_RESTRICTIONS" TERMSANDCONDITIONSNOTACCEPTED IneligibilityReasonCode = "TERMS_AND_CONDITIONS_NOT_ACCEPTED" UNKNOWN IneligibilityReasonCode = "UNKNOWN" UNSUPPORTEDVAS IneligibilityReasonCode = "UNSUPPORTED_VAS" VASCOMBINATIONRESTRICTION IneligibilityReasonCode = "VAS_COMBINATION_RESTRICTION" WEIGHTRESTRICTIONS IneligibilityReasonCode = "WEIGHT_RESTRICTIONS" )
Defines values for IneligibilityReasonCode.
type IneligibleRate ¶
type IneligibleRate struct { // CarrierId The carrier identifier for the offering, provided by the carrier. CarrierId CarrierId `json:"carrierId"` // CarrierName The carrier name for the offering. CarrierName CarrierName `json:"carrierName"` // IneligibilityReasons A list of reasons why a shipping service offering is ineligible. IneligibilityReasons []IneligibilityReason `json:"ineligibilityReasons"` // ServiceId An identifier for the shipping service. ServiceId ServiceId `json:"serviceId"` // ServiceName The name of the shipping service. ServiceName ServiceName `json:"serviceName"` }
IneligibleRate Detailed information for an ineligible shipping service offering.
type IneligibleRateList ¶
type IneligibleRateList = []IneligibleRate
IneligibleRateList A list of ineligible shipping service offerings.
type InvoiceDetails ¶
type InvoiceDetails struct { // InvoiceDate The invoice date of the item in ISO 8061 format. InvoiceDate *time.Time `json:"invoiceDate,omitempty"` // InvoiceNumber The invoice number of the item. InvoiceNumber *string `json:"invoiceNumber,omitempty"` }
InvoiceDetails The invoice details for charges associated with the goods in the package. Only applies to certain regions.
type Item ¶
type Item struct { // DangerousGoodsDetails Details related to any dangerous goods/items that are being shipped. DangerousGoodsDetails *DangerousGoodsDetails `json:"dangerousGoodsDetails,omitempty"` // Description The product description of the item. Description *string `json:"description,omitempty"` // DirectFulfillmentItemIdentifiers Item identifiers for an item in a direct fulfillment shipment. DirectFulfillmentItemIdentifiers *DirectFulfillmentItemIdentifiers `json:"directFulfillmentItemIdentifiers,omitempty"` // InvoiceDetails The invoice details for charges associated with the goods in the package. Only applies to certain regions. InvoiceDetails *InvoiceDetails `json:"invoiceDetails,omitempty"` // IsHazmat When true, the item qualifies as hazardous materials (hazmat). Defaults to false. IsHazmat *bool `json:"isHazmat,omitempty"` // ItemIdentifier A unique identifier for an item provided by the client. ItemIdentifier *string `json:"itemIdentifier,omitempty"` // ItemValue The monetary value in the currency indicated, in ISO 4217 standard format. ItemValue *Currency `json:"itemValue,omitempty"` // LiquidVolume Liquid Volume. LiquidVolume *LiquidVolume `json:"liquidVolume,omitempty"` // ProductType The product type of the item. ProductType *string `json:"productType,omitempty"` // Quantity The number of units. This value is required. Quantity int `json:"quantity"` // SerialNumbers A list of unique serial numbers in an Amazon package that can be used to guarantee non-fraudulent items. The number of serial numbers in the list must be less than or equal to the quantity of items being shipped. Only applicable when channel source is Amazon. SerialNumbers *[]string `json:"serialNumbers,omitempty"` // Weight The weight in the units indicated. Weight *Weight `json:"weight,omitempty"` }
Item An item in a package.
type LiquidVolume ¶
type LiquidVolume struct { // Unit The unit of measurement. Unit LiquidVolumeUnit `json:"unit"` // Value The measurement value. Value float32 `json:"value"` }
LiquidVolume Liquid Volume.
type LiquidVolumeUnit ¶
type LiquidVolumeUnit string
LiquidVolumeUnit The unit of measurement.
const ( C LiquidVolumeUnit = "C" FLOZ LiquidVolumeUnit = "FL_OZ" GAL LiquidVolumeUnit = "GAL" L LiquidVolumeUnit = "L" ML LiquidVolumeUnit = "ML" PT LiquidVolumeUnit = "PT" QT LiquidVolumeUnit = "QT" )
Defines values for LiquidVolumeUnit.
type Location ¶
type Location struct { // City The city or town where the person, business or institution is located. City *City `json:"city,omitempty"` // CountryCode The two digit country code. Follows ISO 3166-1 alpha-2 format. CountryCode *CountryCode `json:"countryCode,omitempty"` // PostalCode The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. PostalCode *PostalCode `json:"postalCode,omitempty"` // StateOrRegion The state, county or region where the person, business or institution is located. StateOrRegion *StateOrRegion `json:"stateOrRegion,omitempty"` }
Location The location where the person, business or institution is located.
type NdrAction ¶
type NdrAction string
NdrAction The type of NDR action shipper wants to take for a particular shipment.
type NdrRequestData ¶
type NdrRequestData struct { // AdditionalAddressNotes Address notes to re-attempt delivery with. AdditionalAddressNotes *AdditionalAddressNotes `json:"additionalAddressNotes,omitempty"` // RescheduleDate The date on which the Seller wants to reschedule shipment delivery, in ISO-8601 date/time format RescheduleDate *time.Time `json:"rescheduleDate,omitempty"` }
NdrRequestData Additional information required for the NDR action that has been filed. If the NDR Action is RESCHEDULE, rescheduleDate is a required field. Otherwise, if the NDR Action is REATTEMPT, additionalAddressNotes is a required field.
type NeedFileJoining ¶
type NeedFileJoining = bool
NeedFileJoining When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false.
type OneClickShipmentJSONRequestBody ¶
type OneClickShipmentJSONRequestBody = OneClickShipmentRequest
OneClickShipmentJSONRequestBody defines body for OneClickShipment for application/json ContentType.
type OneClickShipmentParams ¶
type OneClickShipmentParams struct { // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId OneClickShipmentParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id"` }
OneClickShipmentParams defines parameters for OneClickShipment.
type OneClickShipmentParamsXAmznShippingBusinessId ¶
type OneClickShipmentParamsXAmznShippingBusinessId string
OneClickShipmentParamsXAmznShippingBusinessId defines parameters for OneClickShipment.
const ( OneClickShipmentParamsXAmznShippingBusinessIdAmazonShippingES OneClickShipmentParamsXAmznShippingBusinessId = "AmazonShipping_ES" OneClickShipmentParamsXAmznShippingBusinessIdAmazonShippingFR OneClickShipmentParamsXAmznShippingBusinessId = "AmazonShipping_FR" OneClickShipmentParamsXAmznShippingBusinessIdAmazonShippingIN OneClickShipmentParamsXAmznShippingBusinessId = "AmazonShipping_IN" OneClickShipmentParamsXAmznShippingBusinessIdAmazonShippingIT OneClickShipmentParamsXAmznShippingBusinessId = "AmazonShipping_IT" OneClickShipmentParamsXAmznShippingBusinessIdAmazonShippingUK OneClickShipmentParamsXAmznShippingBusinessId = "AmazonShipping_UK" OneClickShipmentParamsXAmznShippingBusinessIdAmazonShippingUS OneClickShipmentParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for OneClickShipmentParamsXAmznShippingBusinessId.
type OneClickShipmentRequest ¶
type OneClickShipmentRequest struct { // ChannelDetails Shipment source channel related information. ChannelDetails ChannelDetails `json:"channelDetails"` DestinationAccessPointDetails *AccessPointDetails `json:"destinationAccessPointDetails,omitempty"` // LabelSpecifications The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation. LabelSpecifications RequestedDocumentSpecification `json:"labelSpecifications"` // Packages A list of packages to be shipped through a shipping service offering. Packages PackageList `json:"packages"` // ReturnTo The address. ReturnTo *Address `json:"returnTo,omitempty"` // ServiceSelection Service Selection Criteria. ServiceSelection ServiceSelection `json:"serviceSelection"` // ShipDate The ship date and time (the requested pickup). This defaults to the current date and time. ShipDate *time.Time `json:"shipDate,omitempty"` // ShipFrom The address. ShipFrom Address `json:"shipFrom"` // ShipTo The address. ShipTo *Address `json:"shipTo,omitempty"` // ShipperInstruction The shipper instruction. ShipperInstruction *ShipperInstruction `json:"shipperInstruction,omitempty"` // TaxDetails A list of tax detail information. TaxDetails *TaxDetailList `json:"taxDetails,omitempty"` // ValueAddedServicesDetails The value-added services to be added to a shipping service purchase. ValueAddedServicesDetails *OneClickShipmentValueAddedServiceDetails `json:"valueAddedServicesDetails,omitempty"` }
OneClickShipmentRequest The request schema for the OneClickShipment operation. When the channelType is not Amazon, shipTo is required and when channelType is Amazon shipTo is ignored.
type OneClickShipmentResp ¶
type OneClickShipmentResp struct { Body []byte HTTPResponse *http.Response JSON200 *OneClickShipmentResponse JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParseOneClickShipmentResp ¶
func ParseOneClickShipmentResp(rsp *http.Response) (*OneClickShipmentResp, error)
ParseOneClickShipmentResp parses an HTTP response from a OneClickShipmentWithResponse call
func (OneClickShipmentResp) Status ¶
func (r OneClickShipmentResp) Status() string
Status returns HTTPResponse.Status
func (OneClickShipmentResp) StatusCode ¶
func (r OneClickShipmentResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type OneClickShipmentResponse ¶
type OneClickShipmentResponse struct { // Payload The payload for the OneClickShipment API. Payload *OneClickShipmentResult `json:"payload,omitempty"` }
OneClickShipmentResponse The response schema for the OneClickShipment operation.
type OneClickShipmentResult ¶
type OneClickShipmentResult struct { // Carrier Carrier Related Info Carrier Carrier `json:"carrier"` // PackageDocumentDetails A list of post-purchase details about a package that will be shipped using a shipping service. PackageDocumentDetails PackageDocumentDetailList `json:"packageDocumentDetails"` // Promise The time windows promised for pickup and delivery events. Promise Promise `json:"promise"` // Service Service Related Info Service Service `json:"service"` // ShipmentId The unique shipment identifier provided by a shipping service. ShipmentId ShipmentId `json:"shipmentId"` // TotalCharge The monetary value in the currency indicated, in ISO 4217 standard format. TotalCharge Currency `json:"totalCharge"` }
OneClickShipmentResult The payload for the OneClickShipment API.
type OneClickShipmentValueAddedService ¶
type OneClickShipmentValueAddedService struct { // Amount The monetary value in the currency indicated, in ISO 4217 standard format. Amount *Currency `json:"amount,omitempty"` // Id The identifier of the selected value-added service. Id string `json:"id"` }
OneClickShipmentValueAddedService A value-added service to be applied to a shipping service purchase.
type OneClickShipmentValueAddedServiceDetails ¶
type OneClickShipmentValueAddedServiceDetails = []OneClickShipmentValueAddedService
OneClickShipmentValueAddedServiceDetails The value-added services to be added to a shipping service purchase.
type OperatingHours ¶
type OperatingHours struct { // ClosingTime Denotes time of the day, used for defining opening or closing time of access points ClosingTime *TimeOfDay `json:"closingTime,omitempty"` MidDayClosures *[]TimeOfDay `json:"midDayClosures,omitempty"` // OpeningTime Denotes time of the day, used for defining opening or closing time of access points OpeningTime *TimeOfDay `json:"openingTime,omitempty"` }
OperatingHours The hours in which the access point shall remain operational
type Package ¶
type Package struct { // Charges A list of charges based on the shipping service charges applied on a package. Charges *ChargeList `json:"charges,omitempty"` // Dimensions A set of measurements for a three-dimensional object. Dimensions Dimensions `json:"dimensions"` // InsuredValue The monetary value in the currency indicated, in ISO 4217 standard format. InsuredValue Currency `json:"insuredValue"` // IsHazmat When true, the package contains hazardous materials. Defaults to false. IsHazmat *bool `json:"isHazmat,omitempty"` // Items A list of items. Items ItemList `json:"items"` // PackageClientReferenceId A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation. PackageClientReferenceId PackageClientReferenceId `json:"packageClientReferenceId"` // SellerDisplayName The seller name displayed on the label. SellerDisplayName *string `json:"sellerDisplayName,omitempty"` // Weight The weight in the units indicated. Weight Weight `json:"weight"` }
Package A package to be shipped through a shipping service offering.
type PackageClientReferenceId ¶
type PackageClientReferenceId = string
PackageClientReferenceId A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.
type PackageDocument ¶
type PackageDocument struct { // Contents A Base64 encoded string of the file contents. Contents Contents `json:"contents"` // Format The file format of the document. Format DocumentFormat `json:"format"` // Type The type of shipping document. Type DocumentType `json:"type"` }
PackageDocument A document related to a package.
type PackageDocumentDetail ¶
type PackageDocumentDetail struct { // PackageClientReferenceId A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation. PackageClientReferenceId PackageClientReferenceId `json:"packageClientReferenceId"` // PackageDocuments A list of documents related to a package. PackageDocuments PackageDocumentList `json:"packageDocuments"` // TrackingId The carrier generated identifier for a package in a purchased shipment. TrackingId *TrackingId `json:"trackingId,omitempty"` }
PackageDocumentDetail The post-purchase details of a package that will be shipped using a shipping service.
type PackageDocumentDetailList ¶
type PackageDocumentDetailList = []PackageDocumentDetail
PackageDocumentDetailList A list of post-purchase details about a package that will be shipped using a shipping service.
type PackageDocumentList ¶
type PackageDocumentList = []PackageDocument
PackageDocumentList A list of documents related to a package.
type PackageList ¶
type PackageList = []Package
PackageList A list of packages to be shipped through a shipping service offering.
type PageLayout ¶
type PageLayout = string
PageLayout Indicates the position of the label on the paper. Should be the same value as returned in getRates response.
type PaymentType ¶
type PaymentType string
PaymentType Payment type of the purchase.
const ( PAYDIRECTTOCARRIER PaymentType = "PAY_DIRECT_TO_CARRIER" PAYTHROUGHAMAZON PaymentType = "PAY_THROUGH_AMAZON" )
Defines values for PaymentType.
type PostalCode ¶
type PostalCode = string
PostalCode The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
type PrintOption ¶
type PrintOption struct { // SupportedDPIs A list of the supported DPI options for a document. SupportedDPIs *[]Dpi `json:"supportedDPIs,omitempty"` // SupportedDocumentDetails A list of the supported documented details. SupportedDocumentDetails []SupportedDocumentDetail `json:"supportedDocumentDetails"` // SupportedFileJoiningOptions A list of the supported needFileJoining boolean values for a document. SupportedFileJoiningOptions []NeedFileJoining `json:"supportedFileJoiningOptions"` // SupportedPageLayouts A list of the supported page layout options for a document. SupportedPageLayouts []PageLayout `json:"supportedPageLayouts"` }
PrintOption The format options available for a label.
type PrintOptionList ¶
type PrintOptionList = []PrintOption
PrintOptionList A list of the format options for a label.
type Promise ¶
type Promise struct { // DeliveryWindow The start and end time that specifies the time interval of an event. DeliveryWindow *TimeWindow `json:"deliveryWindow,omitempty"` // PickupWindow The start and end time that specifies the time interval of an event. PickupWindow *TimeWindow `json:"pickupWindow,omitempty"` }
Promise The time windows promised for pickup and delivery events.
type PurchaseShipmentJSONRequestBody ¶
type PurchaseShipmentJSONRequestBody = PurchaseShipmentRequest
PurchaseShipmentJSONRequestBody defines body for PurchaseShipment for application/json ContentType.
type PurchaseShipmentParams ¶
type PurchaseShipmentParams struct { // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId PurchaseShipmentParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id"` }
PurchaseShipmentParams defines parameters for PurchaseShipment.
type PurchaseShipmentParamsXAmznShippingBusinessId ¶
type PurchaseShipmentParamsXAmznShippingBusinessId string
PurchaseShipmentParamsXAmznShippingBusinessId defines parameters for PurchaseShipment.
const ( PurchaseShipmentParamsXAmznShippingBusinessIdAmazonShippingES PurchaseShipmentParamsXAmznShippingBusinessId = "AmazonShipping_ES" PurchaseShipmentParamsXAmznShippingBusinessIdAmazonShippingFR PurchaseShipmentParamsXAmznShippingBusinessId = "AmazonShipping_FR" PurchaseShipmentParamsXAmznShippingBusinessIdAmazonShippingIN PurchaseShipmentParamsXAmznShippingBusinessId = "AmazonShipping_IN" PurchaseShipmentParamsXAmznShippingBusinessIdAmazonShippingIT PurchaseShipmentParamsXAmznShippingBusinessId = "AmazonShipping_IT" PurchaseShipmentParamsXAmznShippingBusinessIdAmazonShippingUK PurchaseShipmentParamsXAmznShippingBusinessId = "AmazonShipping_UK" PurchaseShipmentParamsXAmznShippingBusinessIdAmazonShippingUS PurchaseShipmentParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for PurchaseShipmentParamsXAmznShippingBusinessId.
type PurchaseShipmentRequest ¶
type PurchaseShipmentRequest struct { // AdditionalInputs The additional inputs required to purchase a shipping offering, in JSON format. The JSON provided here must adhere to the JSON schema that is returned in the response to the getAdditionalInputs operation. // // Additional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation. AdditionalInputs *map[string]interface{} `json:"additionalInputs,omitempty"` // RateId An identifier for the rate (shipment offering) provided by a shipping service provider. RateId RateId `json:"rateId"` // RequestToken A unique token generated to identify a getRates operation. RequestToken RequestToken `json:"requestToken"` // RequestedDocumentSpecification The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation. RequestedDocumentSpecification RequestedDocumentSpecification `json:"requestedDocumentSpecification"` // RequestedValueAddedServices The value-added services to be added to a shipping service purchase. RequestedValueAddedServices *RequestedValueAddedServiceList `json:"requestedValueAddedServices,omitempty"` }
PurchaseShipmentRequest The request schema for the purchaseShipment operation.
type PurchaseShipmentResp ¶
type PurchaseShipmentResp struct { Body []byte HTTPResponse *http.Response JSON200 *PurchaseShipmentResponse JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParsePurchaseShipmentResp ¶
func ParsePurchaseShipmentResp(rsp *http.Response) (*PurchaseShipmentResp, error)
ParsePurchaseShipmentResp parses an HTTP response from a PurchaseShipmentWithResponse call
func (PurchaseShipmentResp) Status ¶
func (r PurchaseShipmentResp) Status() string
Status returns HTTPResponse.Status
func (PurchaseShipmentResp) StatusCode ¶
func (r PurchaseShipmentResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PurchaseShipmentResponse ¶
type PurchaseShipmentResponse struct { // Payload The payload for the purchaseShipment operation. Payload *PurchaseShipmentResult `json:"payload,omitempty"` }
PurchaseShipmentResponse The response schema for the purchaseShipment operation.
type PurchaseShipmentResult ¶
type PurchaseShipmentResult struct { // PackageDocumentDetails A list of post-purchase details about a package that will be shipped using a shipping service. PackageDocumentDetails PackageDocumentDetailList `json:"packageDocumentDetails"` // Promise The time windows promised for pickup and delivery events. Promise Promise `json:"promise"` // ShipmentId The unique shipment identifier provided by a shipping service. ShipmentId ShipmentId `json:"shipmentId"` }
PurchaseShipmentResult The payload for the purchaseShipment operation.
type Rate ¶
type Rate struct { // AvailableValueAddedServiceGroups A list of value-added services available for a shipping service offering. AvailableValueAddedServiceGroups *AvailableValueAddedServiceGroupList `json:"availableValueAddedServiceGroups,omitempty"` // Benefits Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon. Benefits *Benefits `json:"benefits,omitempty"` // BilledWeight The weight in the units indicated. BilledWeight *Weight `json:"billedWeight,omitempty"` // CarrierId The carrier identifier for the offering, provided by the carrier. CarrierId CarrierId `json:"carrierId"` // CarrierName The carrier name for the offering. CarrierName CarrierName `json:"carrierName"` // PaymentType Payment type of the purchase. PaymentType *PaymentType `json:"paymentType,omitempty"` // Promise The time windows promised for pickup and delivery events. Promise Promise `json:"promise"` // RateId An identifier for the rate (shipment offering) provided by a shipping service provider. RateId RateId `json:"rateId"` // RateItemList A list of RateItem RateItemList *RateItemList `json:"rateItemList,omitempty"` // RequiresAdditionalInputs When true, indicates that additional inputs are required to purchase this shipment service. You must then call the getAdditionalInputs operation to return the JSON schema to use when providing the additional inputs to the purchaseShipment operation. RequiresAdditionalInputs bool `json:"requiresAdditionalInputs"` // ServiceId An identifier for the shipping service. ServiceId ServiceId `json:"serviceId"` // ServiceName The name of the shipping service. ServiceName ServiceName `json:"serviceName"` // SupportedDocumentSpecifications A list of the document specifications supported for a shipment service offering. SupportedDocumentSpecifications SupportedDocumentSpecificationList `json:"supportedDocumentSpecifications"` // TotalCharge The monetary value in the currency indicated, in ISO 4217 standard format. TotalCharge Currency `json:"totalCharge"` }
Rate The details of a shipping service offering.
type RateId ¶
type RateId = string
RateId An identifier for the rate (shipment offering) provided by a shipping service provider.
type RateItem ¶
type RateItem struct { // RateItemCharge The monetary value in the currency indicated, in ISO 4217 standard format. RateItemCharge *Currency `json:"rateItemCharge,omitempty"` // RateItemID Unique ID for the rateItem. RateItemID *RateItemID `json:"rateItemID,omitempty"` // RateItemNameLocalization Used for the localization. RateItemNameLocalization *string `json:"rateItemNameLocalization,omitempty"` // RateItemType Type of the rateItem. RateItemType *RateItemType `json:"rateItemType,omitempty"` }
RateItem Rate Item for shipping (base cost, transaction fee, confirmation, insurance, etc.) Data source definition:
type RateItemID ¶
type RateItemID string
RateItemID Unique ID for the rateItem.
const ( ADDITIONALSURCHARGE RateItemID = "ADDITIONAL_SURCHARGE" ADULTSIGNATURECONFIRMATION RateItemID = "ADULT_SIGNATURE_CONFIRMATION" AMAZONSPONSOREDDISCOUNT RateItemID = "AMAZON_SPONSORED_DISCOUNT" BASERATE RateItemID = "BASE_RATE" COD RateItemID = "COD" CONGESTIONCHARGE RateItemID = "CONGESTION_CHARGE" DECLAREDVALUE RateItemID = "DECLARED_VALUE" DELIVERYAREASURCHARGE RateItemID = "DELIVERY_AREA_SURCHARGE" DELIVERYCONFIRMATION RateItemID = "DELIVERY_CONFIRMATION" FUELSURCHARGE RateItemID = "FUEL_SURCHARGE" HIDDENPOSTAGE RateItemID = "HIDDEN_POSTAGE" IMPLIEDLIABILITY RateItemID = "IMPLIED_LIABILITY" IMPORTDUTYCHARGE RateItemID = "IMPORT_DUTY_CHARGE" INSPECTIONCHARGE RateItemID = "INSPECTION_CHARGE" INSURANCE RateItemID = "INSURANCE" INTEGRATORSPONSOREDDISCOUNT RateItemID = "INTEGRATOR_SPONSORED_DISCOUNT" NOCONFIRMATION RateItemID = "NO_CONFIRMATION" NOSATURDAYDELIVERY RateItemID = "NO_SATURDAY_DELIVERY" OVERSIZESURCHARGE RateItemID = "OVERSIZE_SURCHARGE" REBATE RateItemID = "REBATE" RESIDENTIALSURCHARGE RateItemID = "RESIDENTIAL_SURCHARGE" SIGNATURECONFIRMATION RateItemID = "SIGNATURE_CONFIRMATION" SUNDAYHOLIDAYDELIVERY RateItemID = "SUNDAY_HOLIDAY_DELIVERY" SURCHARGE RateItemID = "SURCHARGE" TRANSACTIONFEE RateItemID = "TRANSACTION_FEE" VAT RateItemID = "VAT" WAIVESIGNATURE RateItemID = "WAIVE_SIGNATURE" WAYBILLCHARGE RateItemID = "WAYBILL_CHARGE" )
Defines values for RateItemID.
type RateItemType ¶
type RateItemType string
RateItemType Type of the rateItem.
const ( INCLUDED RateItemType = "INCLUDED" MANDATORY RateItemType = "MANDATORY" OPTIONAL RateItemType = "OPTIONAL" )
Defines values for RateItemType.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type RequestToken ¶
type RequestToken = string
RequestToken A unique token generated to identify a getRates operation.
type RequestedDocumentSpecification ¶
type RequestedDocumentSpecification struct { // Dpi The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document. Dpi *Dpi `json:"dpi,omitempty"` // Format The file format of the document. Format DocumentFormat `json:"format"` // NeedFileJoining When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false. NeedFileJoining NeedFileJoining `json:"needFileJoining"` // PageLayout Indicates the position of the label on the paper. Should be the same value as returned in getRates response. PageLayout *PageLayout `json:"pageLayout,omitempty"` // RequestedDocumentTypes A list of the document types requested. RequestedDocumentTypes []DocumentType `json:"requestedDocumentTypes"` // Size The size dimensions of the label. Size DocumentSize `json:"size"` }
RequestedDocumentSpecification The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation.
type RequestedValueAddedService ¶
type RequestedValueAddedService struct { // Id The identifier of the selected value-added service. Must be among those returned in the response to the getRates operation. Id string `json:"id"` }
RequestedValueAddedService A value-added service to be applied to a shipping service purchase.
type RequestedValueAddedServiceList ¶
type RequestedValueAddedServiceList = []RequestedValueAddedService
RequestedValueAddedServiceList The value-added services to be added to a shipping service purchase.
type ResponseEditorFn ¶
ResponseEditorFn is the function signature for the ResponseEditor callback function
type Service ¶
type Service struct { // Id An identifier for the shipping service. Id ServiceId `json:"id"` // Name The name of the shipping service. Name ServiceName `json:"name"` }
Service Service Related Info
type ServiceSelection ¶
type ServiceSelection struct { // ServiceId A list of ServiceId. ServiceId ServiceIds `json:"serviceId"` }
ServiceSelection Service Selection Criteria.
type ShipmentId ¶
type ShipmentId = string
ShipmentId The unique shipment identifier provided by a shipping service.
type ShipmentType ¶
type ShipmentType string
ShipmentType Shipment type.
const ( FORWARD ShipmentType = "FORWARD" RETURNS ShipmentType = "RETURNS" )
Defines values for ShipmentType.
type ShipperInstruction ¶
type ShipperInstruction struct { // DeliveryNotes The delivery notes for the shipment DeliveryNotes *string `json:"deliveryNotes,omitempty"` }
ShipperInstruction The shipper instruction.
type StateOrRegion ¶
type StateOrRegion = string
StateOrRegion The state, county or region where the person, business or institution is located.
type Status ¶
type Status string
Status The status of the package being shipped.
const ( AwaitingCustomerPickup Status = "AwaitingCustomerPickup" Delivered Status = "Delivered" DeliveryAttempted Status = "DeliveryAttempted" InTransit Status = "InTransit" Lost Status = "Lost" OutForDelivery Status = "OutForDelivery" PickupCancelled Status = "PickupCancelled" PreTransit Status = "PreTransit" Rejected Status = "Rejected" Undeliverable Status = "Undeliverable" )
Defines values for Status.
type SubmitNdrFeedbackJSONRequestBody ¶
type SubmitNdrFeedbackJSONRequestBody = SubmitNdrFeedbackRequest
SubmitNdrFeedbackJSONRequestBody defines body for SubmitNdrFeedback for application/json ContentType.
type SubmitNdrFeedbackParams ¶
type SubmitNdrFeedbackParams struct { // XAmzAccessToken Amazon shipping request token XAmzAccessToken string `json:"x-amz-access-token"` // XAmznShippingBusinessId Amazon shipping business to assume for this request. The default is AmazonShipping_UK. XAmznShippingBusinessId *SubmitNdrFeedbackParamsXAmznShippingBusinessId `json:"x-amzn-shipping-business-id,omitempty"` }
SubmitNdrFeedbackParams defines parameters for SubmitNdrFeedback.
type SubmitNdrFeedbackParamsXAmznShippingBusinessId ¶
type SubmitNdrFeedbackParamsXAmznShippingBusinessId string
SubmitNdrFeedbackParamsXAmznShippingBusinessId defines parameters for SubmitNdrFeedback.
const ( SubmitNdrFeedbackParamsXAmznShippingBusinessIdAmazonShippingES SubmitNdrFeedbackParamsXAmznShippingBusinessId = "AmazonShipping_ES" SubmitNdrFeedbackParamsXAmznShippingBusinessIdAmazonShippingFR SubmitNdrFeedbackParamsXAmznShippingBusinessId = "AmazonShipping_FR" SubmitNdrFeedbackParamsXAmznShippingBusinessIdAmazonShippingIN SubmitNdrFeedbackParamsXAmznShippingBusinessId = "AmazonShipping_IN" SubmitNdrFeedbackParamsXAmznShippingBusinessIdAmazonShippingIT SubmitNdrFeedbackParamsXAmznShippingBusinessId = "AmazonShipping_IT" SubmitNdrFeedbackParamsXAmznShippingBusinessIdAmazonShippingUK SubmitNdrFeedbackParamsXAmznShippingBusinessId = "AmazonShipping_UK" SubmitNdrFeedbackParamsXAmznShippingBusinessIdAmazonShippingUS SubmitNdrFeedbackParamsXAmznShippingBusinessId = "AmazonShipping_US" )
Defines values for SubmitNdrFeedbackParamsXAmznShippingBusinessId.
type SubmitNdrFeedbackRequest ¶
type SubmitNdrFeedbackRequest struct { // NdrAction The type of NDR action shipper wants to take for a particular shipment. NdrAction NdrAction `json:"ndrAction"` // NdrRequestData Additional information required for the NDR action that has been filed. If the NDR Action is RESCHEDULE, rescheduleDate is a required field. Otherwise, if the NDR Action is REATTEMPT, additionalAddressNotes is a required field. NdrRequestData *NdrRequestData `json:"ndrRequestData,omitempty"` // TrackingId The carrier generated identifier for a package in a purchased shipment. TrackingId TrackingId `json:"trackingId"` }
SubmitNdrFeedbackRequest The request schema for the NdrFeedback operation
type SubmitNdrFeedbackResp ¶
type SubmitNdrFeedbackResp struct { Body []byte HTTPResponse *http.Response JSON400 *ErrorList JSON401 *ErrorList JSON403 *ErrorList JSON404 *ErrorList JSON413 *ErrorList JSON415 *ErrorList JSON429 *ErrorList JSON500 *ErrorList JSON503 *ErrorList }
func ParseSubmitNdrFeedbackResp ¶
func ParseSubmitNdrFeedbackResp(rsp *http.Response) (*SubmitNdrFeedbackResp, error)
ParseSubmitNdrFeedbackResp parses an HTTP response from a SubmitNdrFeedbackWithResponse call
func (SubmitNdrFeedbackResp) Status ¶
func (r SubmitNdrFeedbackResp) Status() string
Status returns HTTPResponse.Status
func (SubmitNdrFeedbackResp) StatusCode ¶
func (r SubmitNdrFeedbackResp) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SupportedDocumentDetail ¶
type SupportedDocumentDetail struct { // IsMandatory When true, the supported document type is required. IsMandatory bool `json:"isMandatory"` // Name The type of shipping document. Name DocumentType `json:"name"` }
SupportedDocumentDetail The supported document types for a service offering.
type SupportedDocumentSpecification ¶
type SupportedDocumentSpecification struct { // Format The file format of the document. Format DocumentFormat `json:"format"` // PrintOptions A list of the format options for a label. PrintOptions PrintOptionList `json:"printOptions"` // Size The size dimensions of the label. Size DocumentSize `json:"size"` }
SupportedDocumentSpecification Document specification that is supported for a service offering.
type SupportedDocumentSpecificationList ¶
type SupportedDocumentSpecificationList = []SupportedDocumentSpecification
SupportedDocumentSpecificationList A list of the document specifications supported for a shipment service offering.
type TaxDetail ¶
type TaxDetail struct { // TaxRegistrationNumber The shipper's tax registration number associated with the shipment for customs compliance purposes in certain regions. TaxRegistrationNumber string `json:"taxRegistrationNumber"` // TaxType Indicates the type of tax. TaxType TaxType `json:"taxType"` }
TaxDetail Indicates the tax specifications associated with the shipment for customs compliance purposes in certain regions.
type TaxDetailList ¶
type TaxDetailList = []TaxDetail
TaxDetailList A list of tax detail information.
type TaxType ¶
type TaxType string
TaxType Indicates the type of tax.
const (
GST TaxType = "GST"
)
Defines values for TaxType.
type TimeOfDay ¶
type TimeOfDay struct { HourOfDay *int `json:"hourOfDay,omitempty"` MinuteOfHour *int `json:"minuteOfHour,omitempty"` SecondOfMinute *int `json:"secondOfMinute,omitempty"` }
TimeOfDay Denotes time of the day, used for defining opening or closing time of access points
type TimeWindow ¶
type TimeWindow struct { // End The end time of the time window. End *time.Time `json:"end,omitempty"` // Start The start time of the time window. Start *time.Time `json:"start,omitempty"` }
TimeWindow The start and end time that specifies the time interval of an event.
type TrackingDetailCodes ¶
type TrackingDetailCodes struct { // Forward Contains detail codes that provide additional details related to the forward leg of the shipment. Forward []DetailCodes `json:"forward"` // Returns Contains detail codes that provide additional details related to the return leg of the shipment. Returns []DetailCodes `json:"returns"` }
TrackingDetailCodes Contains detail codes that provide additional details related to the forward and return leg of the shipment.
type TrackingId ¶
type TrackingId = string
TrackingId The carrier generated identifier for a package in a purchased shipment.
type TrackingSummary ¶
type TrackingSummary struct { // Status The status of the package being shipped. Status *Status `json:"status,omitempty"` // TrackingDetailCodes Contains detail codes that provide additional details related to the forward and return leg of the shipment. TrackingDetailCodes *TrackingDetailCodes `json:"trackingDetailCodes,omitempty"` }
TrackingSummary A package status summary.
type ValueAddedService ¶
type ValueAddedService struct { // Cost The monetary value in the currency indicated, in ISO 4217 standard format. Cost Currency `json:"cost"` // Id The identifier for the value-added service. Id string `json:"id"` // Name The name of the value-added service. Name string `json:"name"` }
ValueAddedService A value-added service available for purchase with a shipment service offering.
type ValueAddedServiceDetails ¶
type ValueAddedServiceDetails struct { // CollectOnDelivery The amount to collect on delivery. CollectOnDelivery *CollectOnDelivery `json:"collectOnDelivery,omitempty"` }
ValueAddedServiceDetails A collection of supported value-added services.
type Weight ¶
type Weight struct { // Unit The unit of measurement. Unit WeightUnit `json:"unit"` // Value The measurement value. Value float32 `json:"value"` }
Weight The weight in the units indicated.
type WeightUnit ¶
type WeightUnit string
WeightUnit The unit of measurement.
const ( GRAM WeightUnit = "GRAM" KILOGRAM WeightUnit = "KILOGRAM" OUNCE WeightUnit = "OUNCE" POUND WeightUnit = "POUND" )
Defines values for WeightUnit.