merchantfulfillmentv0

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 28, 2024 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package merchantfulfillmentv0 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCancelShipmentRequest 

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

NewCancelShipmentRequest generates requests for CancelShipment

func NewCreateShipmentRequest 

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

NewCreateShipmentRequest calls the generic CreateShipment builder with application/json body

func NewCreateShipmentRequestWithBody 

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

NewCreateShipmentRequestWithBody generates requests for CreateShipment with any type of body

func NewGetAdditionalSellerInputsRequest 

func NewGetAdditionalSellerInputsRequest(server string, body GetAdditionalSellerInputsJSONRequestBody) (*http.Request, error)

NewGetAdditionalSellerInputsRequest calls the generic GetAdditionalSellerInputs builder with application/json body

func NewGetAdditionalSellerInputsRequestWithBody 

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

NewGetAdditionalSellerInputsRequestWithBody generates requests for GetAdditionalSellerInputs with any type of body

func NewGetEligibleShipmentServicesRequest 

func NewGetEligibleShipmentServicesRequest(server string, body GetEligibleShipmentServicesJSONRequestBody) (*http.Request, error)

NewGetEligibleShipmentServicesRequest calls the generic GetEligibleShipmentServices builder with application/json body

func NewGetEligibleShipmentServicesRequestWithBody 

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

NewGetEligibleShipmentServicesRequestWithBody generates requests for GetEligibleShipmentServices with any type of body

func NewGetShipmentRequest 

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

NewGetShipmentRequest generates requests for GetShipment

Types

type AdditionalInputs 

type AdditionalInputs struct {
	// AdditionalInputFieldName The field name.
	AdditionalInputFieldName *string `json:"AdditionalInputFieldName,omitempty"`

	// SellerInputDefinition Specifies characteristics that apply to a seller input.
	SellerInputDefinition *SellerInputDefinition `json:"SellerInputDefinition,omitempty"`
}

AdditionalInputs Maps the additional seller input to the definition. The key to the map is the field name.

type AdditionalInputsList 

type AdditionalInputsList = []AdditionalInputs

AdditionalInputsList A list of additional inputs.

type AdditionalSellerInput 

type AdditionalSellerInput struct {
	// DataType The data type of the additional information.
	DataType *string `json:"DataType,omitempty"`

	// ValueAsAddress The postal address information.
	ValueAsAddress *Address `json:"ValueAsAddress,omitempty"`

	// ValueAsBoolean The value when the data type is boolean.
	ValueAsBoolean *bool `json:"ValueAsBoolean,omitempty"`

	// ValueAsCurrency Currency type and amount.
	ValueAsCurrency *CurrencyAmount `json:"ValueAsCurrency,omitempty"`

	// ValueAsDimension The length.
	ValueAsDimension *Length `json:"ValueAsDimension,omitempty"`

	// ValueAsInteger The value when the data type is integer.
	ValueAsInteger *int `json:"ValueAsInteger,omitempty"`

	// ValueAsString The value when the data type is string.
	ValueAsString *string `json:"ValueAsString,omitempty"`

	// ValueAsTimestamp Date-time formatted timestamp.
	ValueAsTimestamp *Timestamp `json:"ValueAsTimestamp,omitempty"`

	// ValueAsWeight The weight.
	ValueAsWeight *Weight `json:"ValueAsWeight,omitempty"`
}

AdditionalSellerInput Additional information required to purchase shipping.

type AdditionalSellerInputs 

type AdditionalSellerInputs struct {
	// AdditionalInputFieldName The name of the additional input field.
	AdditionalInputFieldName string `json:"AdditionalInputFieldName"`

	// AdditionalSellerInput Additional information required to purchase shipping.
	AdditionalSellerInput AdditionalSellerInput `json:"AdditionalSellerInput"`
}

AdditionalSellerInputs An additional set of seller inputs required to purchase shipping.

type AdditionalSellerInputsList 

type AdditionalSellerInputsList = []AdditionalSellerInputs

AdditionalSellerInputsList A list of additional seller input pairs required to purchase shipping.

type Address 

type Address struct {
	// AddressLine1 The street address information.
	AddressLine1 AddressLine1 `json:"AddressLine1"`

	// AddressLine2 Additional street address information.
	AddressLine2 *AddressLine2 `json:"AddressLine2,omitempty"`

	// AddressLine3 Additional street address information.
	AddressLine3 *AddressLine3 `json:"AddressLine3,omitempty"`

	// City The city.
	City City `json:"City"`

	// CountryCode The country code. A two-character country code, in ISO 3166-1 alpha-2 format.
	CountryCode CountryCode `json:"CountryCode"`

	// DistrictOrCounty The district or county.
	DistrictOrCounty *DistrictOrCounty `json:"DistrictOrCounty,omitempty"`

	// Email The email address.
	Email EmailAddress `json:"Email"`

	// Name The name of the addressee, or business name.
	Name AddressName `json:"Name"`

	// Phone The phone number.
	Phone PhoneNumber `json:"Phone"`

	// PostalCode The zip code or postal code.
	PostalCode PostalCode `json:"PostalCode"`

	// StateOrProvinceCode The state or province code. **Note.** Required in the Canada, US, and UK marketplaces. Also required for shipments originating from China.
	StateOrProvinceCode *StateOrProvinceCode `json:"StateOrProvinceCode,omitempty"`
}

Address The postal address information.

type AddressLine1 

type AddressLine1 = string

AddressLine1 The street address information.

type AddressLine2 

type AddressLine2 = string

AddressLine2 Additional street address information.

type AddressLine3 

type AddressLine3 = string

AddressLine3 Additional street address information.

type AddressName 

type AddressName = string

AddressName The name of the addressee, or business name.

type AmazonOrderId 

type AmazonOrderId = string

AmazonOrderId An Amazon-defined order identifier, in 3-7-7 format.

type AvailableCarrierWillPickUpOption 

type AvailableCarrierWillPickUpOption struct {
	// CarrierWillPickUpOption Carrier will pick up option.
	CarrierWillPickUpOption CarrierWillPickUpOption `json:"CarrierWillPickUpOption"`

	// Charge Currency type and amount.
	Charge CurrencyAmount `json:"Charge"`
}

AvailableCarrierWillPickUpOption Indicates whether the carrier will pick up the package, and what fee is charged, if any.

type AvailableCarrierWillPickUpOptionsList 

type AvailableCarrierWillPickUpOptionsList = []AvailableCarrierWillPickUpOption

AvailableCarrierWillPickUpOptionsList List of available carrier pickup options.

type AvailableDeliveryExperienceOption 

type AvailableDeliveryExperienceOption struct {
	// Charge Currency type and amount.
	Charge CurrencyAmount `json:"Charge"`

	// DeliveryExperienceOption The delivery confirmation level.
	DeliveryExperienceOption DeliveryExperienceOption `json:"DeliveryExperienceOption"`
}

AvailableDeliveryExperienceOption The available delivery confirmation options, and the fee charged, if any.

type AvailableDeliveryExperienceOptionsList 

type AvailableDeliveryExperienceOptionsList = []AvailableDeliveryExperienceOption

AvailableDeliveryExperienceOptionsList List of available delivery experience options.

type AvailableFormatOptionsForLabelList 

type AvailableFormatOptionsForLabelList = []LabelFormatOption

AvailableFormatOptionsForLabelList The available label formats.

type AvailableShippingServiceOptions 

type AvailableShippingServiceOptions struct {
	// AvailableCarrierWillPickUpOptions List of available carrier pickup options.
	AvailableCarrierWillPickUpOptions AvailableCarrierWillPickUpOptionsList `json:"AvailableCarrierWillPickUpOptions"`

	// AvailableDeliveryExperienceOptions List of available delivery experience options.
	AvailableDeliveryExperienceOptions AvailableDeliveryExperienceOptionsList `json:"AvailableDeliveryExperienceOptions"`
}

AvailableShippingServiceOptions The available shipping service options.

type Benefits added in v1.0.9 

type Benefits struct {
	// ExcludedBenefits A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation.
	ExcludedBenefits *ExcludedBenefits `json:"ExcludedBenefits,omitempty"`

	// IncludedBenefits A list of included benefits.
	IncludedBenefits *IncludedBenefits `json:"IncludedBenefits,omitempty"`
}

Benefits Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC

type CancelShipmentResp 

type CancelShipmentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CancelShipmentResponse
	JSON400      *CancelShipmentResponse
	JSON401      *CancelShipmentResponse
	JSON403      *CancelShipmentResponse
	JSON404      *CancelShipmentResponse
	JSON429      *CancelShipmentResponse
	JSON500      *CancelShipmentResponse
	JSON503      *CancelShipmentResponse
}

func ParseCancelShipmentResp 

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 {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload The details of a shipment, including the shipment status.
	Payload *Shipment `json:"payload,omitempty"`
}

CancelShipmentResponse Response schema.

type CarrierWillPickUpOption 

type CarrierWillPickUpOption string

CarrierWillPickUpOption Carrier will pick up option. 

const (
	CarrierWillPickUpOptionCarrierWillPickUp  CarrierWillPickUpOption = "CarrierWillPickUp"
	CarrierWillPickUpOptionNoPreference       CarrierWillPickUpOption = "NoPreference"
	CarrierWillPickUpOptionShipperWillDropOff CarrierWillPickUpOption = "ShipperWillDropOff"
)

Defines values for CarrierWillPickUpOption.

type City 

type City = string

City The city.

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 (c *Client) CancelShipment(ctx context.Context, shipmentId string) (*http.Response, error)

func (*Client) CreateShipment 

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

func (*Client) CreateShipmentWithBody 

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

func (*Client) GetAdditionalSellerInputs 

func (c *Client) GetAdditionalSellerInputs(ctx context.Context, body GetAdditionalSellerInputsJSONRequestBody) (*http.Response, error)

func (*Client) GetAdditionalSellerInputsWithBody 

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

func (*Client) GetEligibleShipmentServices 

func (c *Client) GetEligibleShipmentServices(ctx context.Context, body GetEligibleShipmentServicesJSONRequestBody) (*http.Response, error)

func (*Client) GetEligibleShipmentServicesWithBody 

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

func (*Client) GetShipment 

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

type ClientInterface 

type ClientInterface interface {
	// GetAdditionalSellerInputsWithBody request with any body
	GetAdditionalSellerInputsWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	GetAdditionalSellerInputs(ctx context.Context, body GetAdditionalSellerInputsJSONRequestBody) (*http.Response, error)

	// GetEligibleShipmentServicesWithBody request with any body
	GetEligibleShipmentServicesWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	GetEligibleShipmentServices(ctx context.Context, body GetEligibleShipmentServicesJSONRequestBody) (*http.Response, error)

	// CreateShipmentWithBody request with any body
	CreateShipmentWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

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

	// CancelShipment request
	CancelShipment(ctx context.Context, shipmentId string) (*http.Response, error)

	// GetShipment request
	GetShipment(ctx context.Context, shipmentId string) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

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 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) (*CancelShipmentResp, error)

CancelShipmentWithResponse request returning *CancelShipmentResp

func (*ClientWithResponses) CreateShipmentWithBodyWithResponse 

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

CreateShipmentWithBodyWithResponse request with arbitrary body returning *CreateShipmentResp

func (*ClientWithResponses) CreateShipmentWithResponse 

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

func (*ClientWithResponses) GetAdditionalSellerInputsWithBodyWithResponse 

func (c *ClientWithResponses) GetAdditionalSellerInputsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetAdditionalSellerInputsResp, error)

GetAdditionalSellerInputsWithBodyWithResponse request with arbitrary body returning *GetAdditionalSellerInputsResp

func (*ClientWithResponses) GetAdditionalSellerInputsWithResponse 

func (c *ClientWithResponses) GetAdditionalSellerInputsWithResponse(ctx context.Context, body GetAdditionalSellerInputsJSONRequestBody) (*GetAdditionalSellerInputsResp, error)

func (*ClientWithResponses) GetEligibleShipmentServicesWithBodyWithResponse 

func (c *ClientWithResponses) GetEligibleShipmentServicesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetEligibleShipmentServicesResp, error)

GetEligibleShipmentServicesWithBodyWithResponse request with arbitrary body returning *GetEligibleShipmentServicesResp

func (*ClientWithResponses) GetEligibleShipmentServicesWithResponse 

func (c *ClientWithResponses) GetEligibleShipmentServicesWithResponse(ctx context.Context, body GetEligibleShipmentServicesJSONRequestBody) (*GetEligibleShipmentServicesResp, error)

func (*ClientWithResponses) GetShipmentWithResponse 

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

GetShipmentWithResponse request returning *GetShipmentResp

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetAdditionalSellerInputsWithBodyWithResponse request with any body
	GetAdditionalSellerInputsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetAdditionalSellerInputsResp, error)

	GetAdditionalSellerInputsWithResponse(ctx context.Context, body GetAdditionalSellerInputsJSONRequestBody) (*GetAdditionalSellerInputsResp, error)

	// GetEligibleShipmentServicesWithBodyWithResponse request with any body
	GetEligibleShipmentServicesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetEligibleShipmentServicesResp, error)

	GetEligibleShipmentServicesWithResponse(ctx context.Context, body GetEligibleShipmentServicesJSONRequestBody) (*GetEligibleShipmentServicesResp, error)

	// CreateShipmentWithBodyWithResponse request with any body
	CreateShipmentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*CreateShipmentResp, error)

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

	// CancelShipmentWithResponse request
	CancelShipmentWithResponse(ctx context.Context, shipmentId string) (*CancelShipmentResp, error)

	// GetShipmentWithResponse request
	GetShipmentWithResponse(ctx context.Context, shipmentId string) (*GetShipmentResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Constraint 

type Constraint struct {
	// ValidationRegEx A regular expression.
	ValidationRegEx *string `json:"ValidationRegEx,omitempty"`

	// ValidationString A validation string.
	ValidationString string `json:"ValidationString"`
}

Constraint A validation constraint.

type Constraints 

type Constraints = []Constraint

Constraints List of constraints.

type CountryCode 

type CountryCode = string

CountryCode The country code. A two-character country code, in ISO 3166-1 alpha-2 format.

type CreateShipmentJSONRequestBody 

type CreateShipmentJSONRequestBody = CreateShipmentRequest

CreateShipmentJSONRequestBody defines body for CreateShipment for application/json ContentType.

type CreateShipmentRequest 

type CreateShipmentRequest struct {
	// HazmatType Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials.
	HazmatType *HazmatType `json:"HazmatType,omitempty"`

	// LabelFormatOption Whether to include a packing slip.
	LabelFormatOption *LabelFormatOptionRequest `json:"LabelFormatOption,omitempty"`

	// ShipmentLevelSellerInputsList A list of additional seller input pairs required to purchase shipping.
	ShipmentLevelSellerInputsList *AdditionalSellerInputsList `json:"ShipmentLevelSellerInputsList,omitempty"`

	// ShipmentRequestDetails Shipment information required for requesting shipping service offers or for creating a shipment.
	ShipmentRequestDetails ShipmentRequestDetails `json:"ShipmentRequestDetails"`

	// ShippingServiceId An Amazon-defined shipping service identifier.
	ShippingServiceId ShippingServiceIdentifier `json:"ShippingServiceId"`

	// ShippingServiceOfferId Identifies a shipping service order made by a carrier.
	ShippingServiceOfferId *string `json:"ShippingServiceOfferId,omitempty"`
}

CreateShipmentRequest Request schema.

type CreateShipmentResp 

type CreateShipmentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CreateShipmentResponse
	JSON400      *CreateShipmentResponse
	JSON401      *CreateShipmentResponse
	JSON403      *CreateShipmentResponse
	JSON404      *CreateShipmentResponse
	JSON429      *CreateShipmentResponse
	JSON500      *CreateShipmentResponse
	JSON503      *CreateShipmentResponse
}

func ParseCreateShipmentResp 

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

ParseCreateShipmentResp parses an HTTP response from a CreateShipmentWithResponse call

func (CreateShipmentResp) Status 

func (r CreateShipmentResp) Status() string

Status returns HTTPResponse.Status

func (CreateShipmentResp) StatusCode 

func (r CreateShipmentResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateShipmentResponse 

type CreateShipmentResponse struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload The details of a shipment, including the shipment status.
	Payload *Shipment `json:"payload,omitempty"`
}

CreateShipmentResponse Response schema.

type CurrencyAmount 

type CurrencyAmount struct {
	// Amount The currency amount.
	Amount float64 `json:"Amount"`

	// CurrencyCode Three-digit currency code in ISO 4217 format.
	CurrencyCode string `json:"CurrencyCode"`
}

CurrencyAmount Currency type and amount.

type CustomTextForLabel 

type CustomTextForLabel = string

CustomTextForLabel Custom text to print on the label.

Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.

type DangerousGoodsDetails added in v1.0.7 

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 added in v1.0.7 

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 added in v1.0.7 

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 DeliveryExperienceOption 

type DeliveryExperienceOption string

DeliveryExperienceOption The delivery confirmation level. 

const (
	DeliveryExperienceOptionDeliveryConfirmationWithAdultSignature DeliveryExperienceOption = "DeliveryConfirmationWithAdultSignature"
	DeliveryExperienceOptionDeliveryConfirmationWithSignature      DeliveryExperienceOption = "DeliveryConfirmationWithSignature"
	DeliveryExperienceOptionDeliveryConfirmationWithoutSignature   DeliveryExperienceOption = "DeliveryConfirmationWithoutSignature"
	DeliveryExperienceOptionNoPreference                           DeliveryExperienceOption = "NoPreference"
	DeliveryExperienceOptionNoTracking                             DeliveryExperienceOption = "NoTracking"
)

Defines values for DeliveryExperienceOption.

type DeliveryExperienceType 

type DeliveryExperienceType string

DeliveryExperienceType The delivery confirmation level. 

const (
	DeliveryConfirmationWithAdultSignature DeliveryExperienceType = "DeliveryConfirmationWithAdultSignature"
	DeliveryConfirmationWithSignature      DeliveryExperienceType = "DeliveryConfirmationWithSignature"
	DeliveryConfirmationWithoutSignature   DeliveryExperienceType = "DeliveryConfirmationWithoutSignature"
	NoTracking                             DeliveryExperienceType = "NoTracking"
)

Defines values for DeliveryExperienceType.

type DistrictOrCounty 

type DistrictOrCounty = string

DistrictOrCounty The district or county.

type EmailAddress 

type EmailAddress = string

EmailAddress The email address.

type Error 

type Error struct {
	// Code An error code that identifies the type of error that occured.
	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 in a human-readable form.
	Message string `json:"message"`
}

Error Error response returned when the request is unsuccessful.

type ErrorList 

type ErrorList = []Error

ErrorList A list of error responses returned when a request is unsuccessful.

type ExcludedBenefit added in v1.0.9 

type ExcludedBenefit struct {
	// Benefit Benefit that is being excluded from a shipment.
	Benefit *string `json:"Benefit,omitempty"`

	// ReasonCodes List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.
	ReasonCodes *ExcludedBenefitReasonCodes `json:"ReasonCodes,omitempty"`
}

ExcludedBenefit Object representing an excluded benefit that is excluded for a shipping offer or rate.

type ExcludedBenefitReasonCodes added in v1.0.9 

type ExcludedBenefitReasonCodes = []string

ExcludedBenefitReasonCodes List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.

type ExcludedBenefits added in v1.0.9 

type ExcludedBenefits = []ExcludedBenefit

ExcludedBenefits A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation.

type FileContents 

type FileContents struct {
	// Checksum An MD5 hash to validate the PDF document data, in the form of a Base64-encoded string.
	Checksum string `json:"Checksum"`

	// Contents Data for printing labels, in the form of a Base64-encoded, GZip-compressed string.
	Contents string `json:"Contents"`

	// FileType The file type for a label.
	FileType FileType `json:"FileType"`
}

FileContents The document data and checksum.

type FileType 

type FileType string

FileType The file type for a label. 

const (
	Applicationpdf FileType = "application/pdf"
	Applicationzpl FileType = "application/zpl"
	Imagepng       FileType = "image/png"
)

Defines values for FileType.

type GetAdditionalSellerInputsJSONRequestBody 

type GetAdditionalSellerInputsJSONRequestBody = GetAdditionalSellerInputsRequest

GetAdditionalSellerInputsJSONRequestBody defines body for GetAdditionalSellerInputs for application/json ContentType.

type GetAdditionalSellerInputsRequest 

type GetAdditionalSellerInputsRequest struct {
	// OrderId An Amazon-defined order identifier, in 3-7-7 format.
	OrderId AmazonOrderId `json:"OrderId"`

	// ShipFromAddress The postal address information.
	ShipFromAddress Address `json:"ShipFromAddress"`

	// ShippingServiceId An Amazon-defined shipping service identifier.
	ShippingServiceId ShippingServiceIdentifier `json:"ShippingServiceId"`
}

GetAdditionalSellerInputsRequest Request schema.

type GetAdditionalSellerInputsResp 

type GetAdditionalSellerInputsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetAdditionalSellerInputsResponse
	JSON400      *GetAdditionalSellerInputsResponse
	JSON401      *GetAdditionalSellerInputsResponse
	JSON403      *GetAdditionalSellerInputsResponse
	JSON404      *GetAdditionalSellerInputsResponse
	JSON429      *GetAdditionalSellerInputsResponse
	JSON500      *GetAdditionalSellerInputsResponse
	JSON503      *GetAdditionalSellerInputsResponse
}

func ParseGetAdditionalSellerInputsResp 

func ParseGetAdditionalSellerInputsResp(rsp *http.Response) (*GetAdditionalSellerInputsResp, error)

ParseGetAdditionalSellerInputsResp parses an HTTP response from a GetAdditionalSellerInputsWithResponse call

func (GetAdditionalSellerInputsResp) Status 

func (r GetAdditionalSellerInputsResp) Status() string

Status returns HTTPResponse.Status

func (GetAdditionalSellerInputsResp) StatusCode 

func (r GetAdditionalSellerInputsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAdditionalSellerInputsResponse 

type GetAdditionalSellerInputsResponse struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload The payload for the getAdditionalSellerInputs operation.
	Payload *GetAdditionalSellerInputsResult `json:"payload,omitempty"`
}

GetAdditionalSellerInputsResponse Response schema.

type GetAdditionalSellerInputsResult 

type GetAdditionalSellerInputsResult struct {
	// ItemLevelFieldsList A list of item level fields.
	ItemLevelFieldsList *ItemLevelFieldsList `json:"ItemLevelFieldsList,omitempty"`

	// ShipmentLevelFields A list of additional inputs.
	ShipmentLevelFields *AdditionalInputsList `json:"ShipmentLevelFields,omitempty"`
}

GetAdditionalSellerInputsResult The payload for the getAdditionalSellerInputs operation.

type GetEligibleShipmentServicesJSONRequestBody 

type GetEligibleShipmentServicesJSONRequestBody = GetEligibleShipmentServicesRequest

GetEligibleShipmentServicesJSONRequestBody defines body for GetEligibleShipmentServices for application/json ContentType.

type GetEligibleShipmentServicesRequest 

type GetEligibleShipmentServicesRequest struct {
	// ShipmentRequestDetails Shipment information required for requesting shipping service offers or for creating a shipment.
	ShipmentRequestDetails ShipmentRequestDetails `json:"ShipmentRequestDetails"`

	// ShippingOfferingFilter Filter for use when requesting eligible shipping services.
	ShippingOfferingFilter *ShippingOfferingFilter `json:"ShippingOfferingFilter,omitempty"`
}

GetEligibleShipmentServicesRequest Request schema.

type GetEligibleShipmentServicesResp 

type GetEligibleShipmentServicesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetEligibleShipmentServicesResponse
	JSON400      *GetEligibleShipmentServicesResponse
	JSON401      *GetEligibleShipmentServicesResponse
	JSON403      *GetEligibleShipmentServicesResponse
	JSON404      *GetEligibleShipmentServicesResponse
	JSON429      *GetEligibleShipmentServicesResponse
	JSON500      *GetEligibleShipmentServicesResponse
	JSON503      *GetEligibleShipmentServicesResponse
}

func ParseGetEligibleShipmentServicesResp 

func ParseGetEligibleShipmentServicesResp(rsp *http.Response) (*GetEligibleShipmentServicesResp, error)

ParseGetEligibleShipmentServicesResp parses an HTTP response from a GetEligibleShipmentServicesWithResponse call

func (GetEligibleShipmentServicesResp) Status 

func (r GetEligibleShipmentServicesResp) Status() string

Status returns HTTPResponse.Status

func (GetEligibleShipmentServicesResp) StatusCode 

func (r GetEligibleShipmentServicesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEligibleShipmentServicesResponse 

type GetEligibleShipmentServicesResponse struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload The payload for the getEligibleShipmentServices operation.
	Payload *GetEligibleShipmentServicesResult `json:"payload,omitempty"`
}

GetEligibleShipmentServicesResponse Response schema.

type GetEligibleShipmentServicesResult 

type GetEligibleShipmentServicesResult struct {
	// RejectedShippingServiceList List of services that were for some reason unavailable for this request
	RejectedShippingServiceList *RejectedShippingServiceList `json:"RejectedShippingServiceList,omitempty"`

	// ShippingServiceList A list of shipping services offers.
	ShippingServiceList ShippingServiceList `json:"ShippingServiceList"`

	// TemporarilyUnavailableCarrierList A list of temporarily unavailable carriers.
	TemporarilyUnavailableCarrierList *TemporarilyUnavailableCarrierList `json:"TemporarilyUnavailableCarrierList,omitempty"`

	// TermsAndConditionsNotAcceptedCarrierList List of carriers whose terms and conditions were not accepted by the seller.
	TermsAndConditionsNotAcceptedCarrierList *TermsAndConditionsNotAcceptedCarrierList `json:"TermsAndConditionsNotAcceptedCarrierList,omitempty"`
}

GetEligibleShipmentServicesResult The payload for the getEligibleShipmentServices operation.

type GetShipmentResp 

type GetShipmentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetShipmentResponse
	JSON400      *GetShipmentResponse
	JSON401      *GetShipmentResponse
	JSON403      *GetShipmentResponse
	JSON404      *GetShipmentResponse
	JSON429      *GetShipmentResponse
	JSON500      *GetShipmentResponse
	JSON503      *GetShipmentResponse
}

func ParseGetShipmentResp 

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

ParseGetShipmentResp parses an HTTP response from a GetShipmentWithResponse call

func (GetShipmentResp) Status 

func (r GetShipmentResp) Status() string

Status returns HTTPResponse.Status

func (GetShipmentResp) StatusCode 

func (r GetShipmentResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetShipmentResponse 

type GetShipmentResponse struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload The details of a shipment, including the shipment status.
	Payload *Shipment `json:"payload,omitempty"`
}

GetShipmentResponse Response schema.

type HazmatType 

type HazmatType string

HazmatType Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials. 

const (
	LQHazmat HazmatType = "LQHazmat"
	None     HazmatType = "None"
)

Defines values for HazmatType.

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IncludedBenefits added in v1.0.9 

type IncludedBenefits = []string

IncludedBenefits A list of included benefits.

type InputTargetType 

type InputTargetType string

InputTargetType Indicates whether the additional seller input is at the item or shipment level. 

const (
	ITEMLEVEL     InputTargetType = "ITEM_LEVEL"
	SHIPMENTLEVEL InputTargetType = "SHIPMENT_LEVEL"
)

Defines values for InputTargetType.

type Item 

type Item struct {
	// DangerousGoodsDetails Details related to any dangerous goods/items that are being shipped.
	DangerousGoodsDetails *DangerousGoodsDetails `json:"DangerousGoodsDetails,omitempty"`

	// IsHazmat When true, the item qualifies as hazardous materials (hazmat). Defaults to false.
	IsHazmat *bool `json:"IsHazmat,omitempty"`

	// ItemDescription The description of the item.
	ItemDescription *ItemDescription `json:"ItemDescription,omitempty"`

	// ItemLevelSellerInputsList A list of additional seller input pairs required to purchase shipping.
	ItemLevelSellerInputsList *AdditionalSellerInputsList `json:"ItemLevelSellerInputsList,omitempty"`

	// ItemWeight The weight.
	ItemWeight *Weight `json:"ItemWeight,omitempty"`

	// LiquidVolume Liquid Volume.
	LiquidVolume *LiquidVolume `json:"LiquidVolume,omitempty"`

	// OrderItemId An Amazon-defined identifier for an individual item in an order.
	OrderItemId OrderItemId `json:"OrderItemId"`

	// Quantity The number of items.
	Quantity ItemQuantity `json:"Quantity"`

	// TransparencyCodeList A list of transparency codes.
	TransparencyCodeList *TransparencyCodeList `json:"TransparencyCodeList,omitempty"`
}

Item An Amazon order item identifier and a quantity.

type ItemDescription 

type ItemDescription = string

ItemDescription The description of the item.

type ItemLevelFields 

type ItemLevelFields struct {
	// AdditionalInputs A list of additional inputs.
	AdditionalInputs AdditionalInputsList `json:"AdditionalInputs"`

	// Asin The Amazon Standard Identification Number (ASIN) of the item.
	Asin string `json:"Asin"`
}

ItemLevelFields A list of item level fields.

type ItemLevelFieldsList 

type ItemLevelFieldsList = []ItemLevelFields

ItemLevelFieldsList A list of item level fields.

type ItemList 

type ItemList = []Item

ItemList The list of items to be included in a shipment.

type ItemQuantity 

type ItemQuantity = int32

ItemQuantity The number of items.

type Label 

type Label struct {
	// CustomTextForLabel Custom text to print on the label.
	//
	// Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.
	CustomTextForLabel *CustomTextForLabel `json:"CustomTextForLabel,omitempty"`

	// Dimensions Dimensions for printing a shipping label.
	Dimensions LabelDimensions `json:"Dimensions"`

	// FileContents The document data and checksum.
	FileContents FileContents `json:"FileContents"`

	// LabelFormat The label format.
	LabelFormat *LabelFormat `json:"LabelFormat,omitempty"`

	// StandardIdForLabel The type of standard identifier to print on the label.
	StandardIdForLabel *StandardIdForLabel `json:"StandardIdForLabel,omitempty"`
}

Label Data for creating a shipping label and dimensions for printing the label.

type LabelCustomization 

type LabelCustomization struct {
	// CustomTextForLabel Custom text to print on the label.
	//
	// Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.
	CustomTextForLabel *CustomTextForLabel `json:"CustomTextForLabel,omitempty"`

	// StandardIdForLabel The type of standard identifier to print on the label.
	StandardIdForLabel *StandardIdForLabel `json:"StandardIdForLabel,omitempty"`
}

LabelCustomization Custom text for shipping labels.

type LabelDimension 

type LabelDimension = float32

LabelDimension A label dimension.

type LabelDimensions 

type LabelDimensions struct {
	// Length A label dimension.
	Length LabelDimension `json:"Length"`

	// Unit The unit of length.
	Unit UnitOfLength `json:"Unit"`

	// Width A label dimension.
	Width LabelDimension `json:"Width"`
}

LabelDimensions Dimensions for printing a shipping label.

type LabelFormat 

type LabelFormat string

LabelFormat The label format. 

const (
	PDF                    LabelFormat = "PDF"
	PNG                    LabelFormat = "PNG"
	ShippingServiceDefault LabelFormat = "ShippingServiceDefault"
	ZPL203                 LabelFormat = "ZPL203"
	ZPL300                 LabelFormat = "ZPL300"
)

Defines values for LabelFormat.

type LabelFormatList 

type LabelFormatList = []LabelFormat

LabelFormatList List of label formats.

type LabelFormatOption 

type LabelFormatOption struct {
	// IncludePackingSlipWithLabel When true, include a packing slip with the label.
	IncludePackingSlipWithLabel *bool `json:"IncludePackingSlipWithLabel,omitempty"`

	// LabelFormat The label format.
	LabelFormat *LabelFormat `json:"LabelFormat,omitempty"`
}

LabelFormatOption The label format details and whether to include a packing slip.

type LabelFormatOptionRequest 

type LabelFormatOptionRequest struct {
	// IncludePackingSlipWithLabel When true, include a packing slip with the label.
	IncludePackingSlipWithLabel *bool `json:"IncludePackingSlipWithLabel,omitempty"`
}

LabelFormatOptionRequest Whether to include a packing slip.

type Length 

type Length struct {
	// Unit The unit of length.
	Unit *UnitOfLength `json:"unit,omitempty"`

	// Value The value in units.
	Value *float32 `json:"value,omitempty"`
}

Length The length.

type LiquidVolume added in v1.0.7 

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 added in v1.0.7 

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 OrderItemId 

type OrderItemId = string

OrderItemId An Amazon-defined identifier for an individual item in an order.

type PackageDimension 

type PackageDimension = float64

PackageDimension Number representing the given package dimension.

type PackageDimensions 

type PackageDimensions struct {
	// Height Number representing the given package dimension.
	Height *PackageDimension `json:"Height,omitempty"`

	// Length Number representing the given package dimension.
	Length *PackageDimension `json:"Length,omitempty"`

	// PredefinedPackageDimensions An enumeration of predefined parcel tokens. If you specify a PredefinedPackageDimensions token, you are not obligated to use a branded package from a carrier. For example, if you specify the FedEx_Box_10kg token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token.
	//
	// Note: Please note that carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for all details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate Envelope or Box.
	PredefinedPackageDimensions *PredefinedPackageDimensions `json:"PredefinedPackageDimensions,omitempty"`

	// Unit The unit of length.
	Unit *UnitOfLength `json:"Unit,omitempty"`

	// Width Number representing the given package dimension.
	Width *PackageDimension `json:"Width,omitempty"`
}

PackageDimensions The dimensions of a package contained in a shipment.

type PhoneNumber 

type PhoneNumber = string

PhoneNumber The phone number.

type PostalCode 

type PostalCode = string

PostalCode The zip code or postal code.

type PredefinedPackageDimensions 

type PredefinedPackageDimensions string

PredefinedPackageDimensions An enumeration of predefined parcel tokens. If you specify a PredefinedPackageDimensions token, you are not obligated to use a branded package from a carrier. For example, if you specify the FedEx_Box_10kg token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token.

Note: Please note that carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for all details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate Envelope or Box. 

const (
	FedExBox10kg                  PredefinedPackageDimensions = "FedEx_Box_10kg"
	FedExBox25kg                  PredefinedPackageDimensions = "FedEx_Box_25kg"
	FedExBoxExtraLarge1           PredefinedPackageDimensions = "FedEx_Box_Extra_Large_1"
	FedExBoxExtraLarge2           PredefinedPackageDimensions = "FedEx_Box_Extra_Large_2"
	FedExBoxLarge1                PredefinedPackageDimensions = "FedEx_Box_Large_1"
	FedExBoxLarge2                PredefinedPackageDimensions = "FedEx_Box_Large_2"
	FedExBoxMedium1               PredefinedPackageDimensions = "FedEx_Box_Medium_1"
	FedExBoxMedium2               PredefinedPackageDimensions = "FedEx_Box_Medium_2"
	FedExBoxSmall1                PredefinedPackageDimensions = "FedEx_Box_Small_1"
	FedExBoxSmall2                PredefinedPackageDimensions = "FedEx_Box_Small_2"
	FedExEnvelope                 PredefinedPackageDimensions = "FedEx_Envelope"
	FedExPaddedPak                PredefinedPackageDimensions = "FedEx_Padded_Pak"
	FedExPak1                     PredefinedPackageDimensions = "FedEx_Pak_1"
	FedExPak2                     PredefinedPackageDimensions = "FedEx_Pak_2"
	FedExTube                     PredefinedPackageDimensions = "FedEx_Tube"
	FedExXLPak                    PredefinedPackageDimensions = "FedEx_XL_Pak"
	UPSBox10kg                    PredefinedPackageDimensions = "UPS_Box_10kg"
	UPSBox25kg                    PredefinedPackageDimensions = "UPS_Box_25kg"
	UPSExpressBox                 PredefinedPackageDimensions = "UPS_Express_Box"
	UPSExpressBoxLarge            PredefinedPackageDimensions = "UPS_Express_Box_Large"
	UPSExpressBoxMedium           PredefinedPackageDimensions = "UPS_Express_Box_Medium"
	UPSExpressBoxSmall            PredefinedPackageDimensions = "UPS_Express_Box_Small"
	UPSExpressEnvelope            PredefinedPackageDimensions = "UPS_Express_Envelope"
	UPSExpressHardPak             PredefinedPackageDimensions = "UPS_Express_Hard_Pak"
	UPSExpressLegalEnvelope       PredefinedPackageDimensions = "UPS_Express_Legal_Envelope"
	UPSExpressPak                 PredefinedPackageDimensions = "UPS_Express_Pak"
	UPSExpressTube                PredefinedPackageDimensions = "UPS_Express_Tube"
	UPSLaboratoryPak              PredefinedPackageDimensions = "UPS_Laboratory_Pak"
	UPSPadPak                     PredefinedPackageDimensions = "UPS_Pad_Pak"
	UPSPallet                     PredefinedPackageDimensions = "UPS_Pallet"
	USPSCard                      PredefinedPackageDimensions = "USPS_Card"
	USPSFlat                      PredefinedPackageDimensions = "USPS_Flat"
	USPSFlatRateCardboardEnvelope PredefinedPackageDimensions = "USPS_FlatRateCardboardEnvelope"
	USPSFlatRateEnvelope          PredefinedPackageDimensions = "USPS_FlatRateEnvelope"
	USPSFlatRateGiftCardEnvelope  PredefinedPackageDimensions = "USPS_FlatRateGiftCardEnvelope"
	USPSFlatRateLegalEnvelope     PredefinedPackageDimensions = "USPS_FlatRateLegalEnvelope"
	USPSFlatRatePaddedEnvelope    PredefinedPackageDimensions = "USPS_FlatRatePaddedEnvelope"
	USPSFlatRateWindowEnvelope    PredefinedPackageDimensions = "USPS_FlatRateWindowEnvelope"
	USPSLargeFlatRateBoardGameBox PredefinedPackageDimensions = "USPS_LargeFlatRateBoardGameBox"
	USPSLargeFlatRateBox          PredefinedPackageDimensions = "USPS_LargeFlatRateBox"
	USPSLetter                    PredefinedPackageDimensions = "USPS_Letter"
	USPSMediumFlatRateBox1        PredefinedPackageDimensions = "USPS_MediumFlatRateBox1"
	USPSMediumFlatRateBox2        PredefinedPackageDimensions = "USPS_MediumFlatRateBox2"
	USPSRegionalRateBoxA1         PredefinedPackageDimensions = "USPS_RegionalRateBoxA1"
	USPSRegionalRateBoxA2         PredefinedPackageDimensions = "USPS_RegionalRateBoxA2"
	USPSRegionalRateBoxB1         PredefinedPackageDimensions = "USPS_RegionalRateBoxB1"
	USPSRegionalRateBoxB2         PredefinedPackageDimensions = "USPS_RegionalRateBoxB2"
	USPSRegionalRateBoxC          PredefinedPackageDimensions = "USPS_RegionalRateBoxC"
	USPSSmallFlatRateBox          PredefinedPackageDimensions = "USPS_SmallFlatRateBox"
	USPSSmallFlatRateEnvelope     PredefinedPackageDimensions = "USPS_SmallFlatRateEnvelope"
)

Defines values for PredefinedPackageDimensions.

type RejectedShippingService 

type RejectedShippingService struct {
	// CarrierName The rejected shipping carrier name. e.g. USPS
	CarrierName string `json:"CarrierName"`

	// RejectionReasonCode A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX
	RejectionReasonCode string `json:"RejectionReasonCode"`

	// RejectionReasonMessage A localized human readable description of the rejected reason.
	RejectionReasonMessage *string `json:"RejectionReasonMessage,omitempty"`

	// ShippingServiceId An Amazon-defined shipping service identifier.
	ShippingServiceId ShippingServiceIdentifier `json:"ShippingServiceId"`

	// ShippingServiceName The rejected shipping service localized name. e.g. FedEx Standard Overnight
	ShippingServiceName string `json:"ShippingServiceName"`
}

RejectedShippingService Information about a rejected shipping service

type RejectedShippingServiceList 

type RejectedShippingServiceList = []RejectedShippingService

RejectedShippingServiceList List of services that were for some reason unavailable for this request

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseEditorFn 

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

ResponseEditorFn is the function signature for the ResponseEditor callback function

type RestrictedSetValues 

type RestrictedSetValues = []string

RestrictedSetValues The set of fixed values in an additional seller input.

type SellerInputDefinition 

type SellerInputDefinition struct {
	// Constraints List of constraints.
	Constraints Constraints `json:"Constraints"`

	// DataType The data type of the additional input field.
	DataType string `json:"DataType"`

	// InputDisplayText The display text for the additional input field.
	InputDisplayText string `json:"InputDisplayText"`

	// InputTarget Indicates whether the additional seller input is at the item or shipment level.
	InputTarget *InputTargetType `json:"InputTarget,omitempty"`

	// IsRequired When true, the additional input field is required.
	IsRequired bool `json:"IsRequired"`

	// RestrictedSetValues The set of fixed values in an additional seller input.
	RestrictedSetValues *RestrictedSetValues `json:"RestrictedSetValues,omitempty"`

	// StoredValue Additional information required to purchase shipping.
	StoredValue AdditionalSellerInput `json:"StoredValue"`
}

SellerInputDefinition Specifies characteristics that apply to a seller input.

type SellerOrderId 

type SellerOrderId = string

SellerOrderId A seller-defined order identifier.

type Shipment 

type Shipment struct {
	// AmazonOrderId An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId AmazonOrderId `json:"AmazonOrderId"`

	// CreatedDate Date-time formatted timestamp.
	CreatedDate Timestamp `json:"CreatedDate"`

	// Insurance Currency type and amount.
	Insurance CurrencyAmount `json:"Insurance"`

	// ItemList The list of items to be included in a shipment.
	ItemList ItemList `json:"ItemList"`

	// Label Data for creating a shipping label and dimensions for printing the label.
	Label Label `json:"Label"`

	// LastUpdatedDate Date-time formatted timestamp.
	LastUpdatedDate *Timestamp `json:"LastUpdatedDate,omitempty"`

	// PackageDimensions The dimensions of a package contained in a shipment.
	PackageDimensions PackageDimensions `json:"PackageDimensions"`

	// SellerOrderId A seller-defined order identifier.
	SellerOrderId *SellerOrderId `json:"SellerOrderId,omitempty"`

	// ShipFromAddress The postal address information.
	ShipFromAddress Address `json:"ShipFromAddress"`

	// ShipToAddress The postal address information.
	ShipToAddress Address `json:"ShipToAddress"`

	// ShipmentId An Amazon-defined shipment identifier.
	ShipmentId ShipmentId `json:"ShipmentId"`

	// ShippingService A shipping service offer made by a carrier.
	ShippingService ShippingService `json:"ShippingService"`

	// Status The shipment status.
	Status ShipmentStatus `json:"Status"`

	// TrackingId The shipment tracking identifier provided by the carrier.
	TrackingId *TrackingId `json:"TrackingId,omitempty"`

	// Weight The weight.
	Weight Weight `json:"Weight"`
}

Shipment The details of a shipment, including the shipment status.

type ShipmentId 

type ShipmentId = string

ShipmentId An Amazon-defined shipment identifier.

type ShipmentRequestDetails 

type ShipmentRequestDetails struct {
	// AmazonOrderId An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId AmazonOrderId `json:"AmazonOrderId"`

	// ItemList The list of items to be included in a shipment.
	ItemList ItemList `json:"ItemList"`

	// LabelCustomization Custom text for shipping labels.
	LabelCustomization *LabelCustomization `json:"LabelCustomization,omitempty"`

	// MustArriveByDate Date-time formatted timestamp.
	MustArriveByDate *Timestamp `json:"MustArriveByDate,omitempty"`

	// PackageDimensions The dimensions of a package contained in a shipment.
	PackageDimensions PackageDimensions `json:"PackageDimensions"`

	// SellerOrderId A seller-defined order identifier.
	SellerOrderId *SellerOrderId `json:"SellerOrderId,omitempty"`

	// ShipDate Date-time formatted timestamp.
	ShipDate *Timestamp `json:"ShipDate,omitempty"`

	// ShipFromAddress The postal address information.
	ShipFromAddress Address `json:"ShipFromAddress"`

	// ShippingServiceOptions Extra services provided by a carrier.
	ShippingServiceOptions ShippingServiceOptions `json:"ShippingServiceOptions"`

	// Weight The weight.
	Weight Weight `json:"Weight"`
}

ShipmentRequestDetails Shipment information required for requesting shipping service offers or for creating a shipment.

type ShipmentStatus 

type ShipmentStatus string

ShipmentStatus The shipment status. 

const (
	Purchased      ShipmentStatus = "Purchased"
	RefundApplied  ShipmentStatus = "RefundApplied"
	RefundPending  ShipmentStatus = "RefundPending"
	RefundRejected ShipmentStatus = "RefundRejected"
)

Defines values for ShipmentStatus.

type ShippingOfferingFilter 

type ShippingOfferingFilter struct {
	// CarrierWillPickUp Carrier will pick up option.
	CarrierWillPickUp *CarrierWillPickUpOption `json:"CarrierWillPickUp,omitempty"`

	// DeliveryExperience The delivery confirmation level.
	DeliveryExperience *DeliveryExperienceOption `json:"DeliveryExperience,omitempty"`

	// IncludeComplexShippingOptions When true, include complex shipping options.
	IncludeComplexShippingOptions *bool `json:"IncludeComplexShippingOptions,omitempty"`

	// IncludePackingSlipWithLabel When true, include a packing slip with the label.
	IncludePackingSlipWithLabel *bool `json:"IncludePackingSlipWithLabel,omitempty"`
}

ShippingOfferingFilter Filter for use when requesting eligible shipping services.

type ShippingService 

type ShippingService struct {
	// AvailableFormatOptionsForLabel The available label formats.
	AvailableFormatOptionsForLabel *AvailableFormatOptionsForLabelList `json:"AvailableFormatOptionsForLabel,omitempty"`

	// AvailableLabelFormats List of label formats.
	AvailableLabelFormats *LabelFormatList `json:"AvailableLabelFormats,omitempty"`

	// AvailableShippingServiceOptions The available shipping service options.
	AvailableShippingServiceOptions *AvailableShippingServiceOptions `json:"AvailableShippingServiceOptions,omitempty"`

	// Benefits Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC
	Benefits *Benefits `json:"Benefits,omitempty"`

	// CarrierName The name of the carrier.
	CarrierName string `json:"CarrierName"`

	// EarliestEstimatedDeliveryDate Date-time formatted timestamp.
	EarliestEstimatedDeliveryDate *Timestamp `json:"EarliestEstimatedDeliveryDate,omitempty"`

	// LatestEstimatedDeliveryDate Date-time formatted timestamp.
	LatestEstimatedDeliveryDate *Timestamp `json:"LatestEstimatedDeliveryDate,omitempty"`

	// Rate Currency type and amount.
	Rate CurrencyAmount `json:"Rate"`

	// RequiresAdditionalSellerInputs When true, additional seller inputs are required.
	RequiresAdditionalSellerInputs bool `json:"RequiresAdditionalSellerInputs"`

	// ShipDate Date-time formatted timestamp.
	ShipDate Timestamp `json:"ShipDate"`

	// ShippingServiceId An Amazon-defined shipping service identifier.
	ShippingServiceId ShippingServiceIdentifier `json:"ShippingServiceId"`

	// ShippingServiceName A plain text representation of a carrier's shipping service. For example, "UPS Ground" or "FedEx Standard Overnight".
	ShippingServiceName string `json:"ShippingServiceName"`

	// ShippingServiceOfferId An Amazon-defined shipping service offer identifier.
	ShippingServiceOfferId string `json:"ShippingServiceOfferId"`

	// ShippingServiceOptions Extra services provided by a carrier.
	ShippingServiceOptions ShippingServiceOptions `json:"ShippingServiceOptions"`
}

ShippingService A shipping service offer made by a carrier.

type ShippingServiceIdentifier 

type ShippingServiceIdentifier = string

ShippingServiceIdentifier An Amazon-defined shipping service identifier.

type ShippingServiceList 

type ShippingServiceList = []ShippingService

ShippingServiceList A list of shipping services offers.

type ShippingServiceOptions 

type ShippingServiceOptions struct {
	// CarrierWillPickUp When true, the carrier will pick up the package.
	//
	// Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK).
	CarrierWillPickUp bool `json:"CarrierWillPickUp"`

	// CarrierWillPickUpOption Carrier will pick up option.
	CarrierWillPickUpOption *CarrierWillPickUpOption `json:"CarrierWillPickUpOption,omitempty"`

	// DeclaredValue Currency type and amount.
	DeclaredValue *CurrencyAmount `json:"DeclaredValue,omitempty"`

	// DeliveryExperience The delivery confirmation level.
	DeliveryExperience DeliveryExperienceType `json:"DeliveryExperience"`

	// LabelFormat The label format.
	LabelFormat *LabelFormat `json:"LabelFormat,omitempty"`
}

ShippingServiceOptions Extra services provided by a carrier.

type StandardIdForLabel 

type StandardIdForLabel string

StandardIdForLabel The type of standard identifier to print on the label. 

const (
	StandardIdForLabelAmazonOrderId StandardIdForLabel = "AmazonOrderId"
)

Defines values for StandardIdForLabel.

type StateOrProvinceCode 

type StateOrProvinceCode = string

StateOrProvinceCode The state or province code. **Note.** Required in the Canada, US, and UK marketplaces. Also required for shipments originating from China.

type TemporarilyUnavailableCarrier 

type TemporarilyUnavailableCarrier struct {
	// CarrierName The name of the carrier.
	CarrierName string `json:"CarrierName"`
}

TemporarilyUnavailableCarrier A carrier who is temporarily unavailable, most likely due to a service outage experienced by the carrier.

type TemporarilyUnavailableCarrierList 

type TemporarilyUnavailableCarrierList = []TemporarilyUnavailableCarrier

TemporarilyUnavailableCarrierList A list of temporarily unavailable carriers.

type TermsAndConditionsNotAcceptedCarrier 

type TermsAndConditionsNotAcceptedCarrier struct {
	// CarrierName The name of the carrier.
	CarrierName string `json:"CarrierName"`
}

TermsAndConditionsNotAcceptedCarrier A carrier whose terms and conditions have not been accepted by the seller.

type TermsAndConditionsNotAcceptedCarrierList 

type TermsAndConditionsNotAcceptedCarrierList = []TermsAndConditionsNotAcceptedCarrier

TermsAndConditionsNotAcceptedCarrierList List of carriers whose terms and conditions were not accepted by the seller.

type Timestamp 

type Timestamp = time.Time

Timestamp Date-time formatted timestamp.

type TrackingId 

type TrackingId = string

TrackingId The shipment tracking identifier provided by the carrier.

type TransparencyCode 

type TransparencyCode = string

TransparencyCode The Transparency code associated with the item. The Transparency serial number that needs to be submitted can be determined by the following:

**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN). **2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode. **QR code SN:** Submit the URL that the QR code generates.

type TransparencyCodeList 

type TransparencyCodeList = []TransparencyCode

TransparencyCodeList A list of transparency codes.

type UnitOfLength 

type UnitOfLength string

UnitOfLength The unit of length. 

const (
	Centimeters UnitOfLength = "centimeters"
	Inches      UnitOfLength = "inches"
)

Defines values for UnitOfLength.

type UnitOfWeight 

type UnitOfWeight string

UnitOfWeight The unit of weight. 

const (
	G  UnitOfWeight = "g"
	Oz UnitOfWeight = "oz"
)

Defines values for UnitOfWeight.

type Weight 

type Weight struct {
	// Unit The unit of weight.
	Unit UnitOfWeight `json:"Unit"`

	// Value The weight value.
	Value WeightValue `json:"Value"`
}

Weight The weight.

type WeightValue 

type WeightValue = float64

WeightValue The weight value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.