merchantFulfillment

package
v0.0.0-...-1bcf55c Latest Latest
Warning

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

 Go to latest Published: Mar 25, 2023 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package merchantFulfillment provides primitives to interact the openapi HTTP API.

Code generated by go-sdk-codegen DO NOT EDIT.

Package merchantFulfillment provides primitives to interact the openapi HTTP API.

Code generated by go-sdk-codegen DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCancelShipmentOldRequest 

func NewCancelShipmentOldRequest(endpoint string, shipmentId string) (*http.Request, error)

NewCancelShipmentOldRequest generates requests for CancelShipmentOld

func NewCancelShipmentRequest 

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

NewCancelShipmentRequest generates requests for CancelShipment

func NewCreateShipmentRequest 

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

NewCreateShipmentRequest calls the generic CreateShipment builder with application/json body

func NewCreateShipmentRequestWithBody 

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

NewCreateShipmentRequestWithBody generates requests for CreateShipment with any type of body

func NewGetAdditionalSellerInputsOldRequest 

func NewGetAdditionalSellerInputsOldRequest(endpoint string, body GetAdditionalSellerInputsOldJSONRequestBody) (*http.Request, error)

NewGetAdditionalSellerInputsOldRequest calls the generic GetAdditionalSellerInputsOld builder with application/json body

func NewGetAdditionalSellerInputsOldRequestWithBody 

func NewGetAdditionalSellerInputsOldRequestWithBody(endpoint string, contentType string, body io.Reader) (*http.Request, error)

NewGetAdditionalSellerInputsOldRequestWithBody generates requests for GetAdditionalSellerInputsOld with any type of body

func NewGetAdditionalSellerInputsRequest 

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

NewGetAdditionalSellerInputsRequest calls the generic GetAdditionalSellerInputs builder with application/json body

func NewGetAdditionalSellerInputsRequestWithBody 

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

NewGetAdditionalSellerInputsRequestWithBody generates requests for GetAdditionalSellerInputs with any type of body

func NewGetEligibleShipmentServicesOldRequest 

func NewGetEligibleShipmentServicesOldRequest(endpoint string, body GetEligibleShipmentServicesOldJSONRequestBody) (*http.Request, error)

NewGetEligibleShipmentServicesOldRequest calls the generic GetEligibleShipmentServicesOld builder with application/json body

func NewGetEligibleShipmentServicesOldRequestWithBody 

func NewGetEligibleShipmentServicesOldRequestWithBody(endpoint string, contentType string, body io.Reader) (*http.Request, error)

NewGetEligibleShipmentServicesOldRequestWithBody generates requests for GetEligibleShipmentServicesOld with any type of body

func NewGetEligibleShipmentServicesRequest 

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

NewGetEligibleShipmentServicesRequest calls the generic GetEligibleShipmentServices builder with application/json body

func NewGetEligibleShipmentServicesRequestWithBody 

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

NewGetEligibleShipmentServicesRequestWithBody generates requests for GetEligibleShipmentServices with any type of body

func NewGetShipmentRequest 

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

NewGetShipmentRequest generates requests for GetShipment

Types

type AdditionalInputs 

type AdditionalInputs struct {

	// The field name.
	AdditionalInputFieldName *string `json:"AdditionalInputFieldName,omitempty"`

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

AdditionalInputs defines model for AdditionalInputs.

type AdditionalInputsList 

type AdditionalInputsList []AdditionalInputs

AdditionalInputsList defines model for AdditionalInputsList.

type AdditionalSellerInput 

type AdditionalSellerInput struct {

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

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

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

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

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

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

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

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

AdditionalSellerInput defines model for AdditionalSellerInput.

type AdditionalSellerInputs 

type AdditionalSellerInputs struct {

	// The name of the additional input field.
	AdditionalInputFieldName string `json:"AdditionalInputFieldName"`

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

AdditionalSellerInputs defines model for AdditionalSellerInputs.

type AdditionalSellerInputsList 

type AdditionalSellerInputsList []AdditionalSellerInputs

AdditionalSellerInputsList defines model for AdditionalSellerInputsList.

type Address 

type Address struct {

	// The street address information.
	AddressLine1 AddressLine1 `json:"AddressLine1"`

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

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

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

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

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

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

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

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

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

	// The state or province code.
	StateOrProvinceCode *StateOrProvinceCode `json:"StateOrProvinceCode,omitempty"`
}

Address defines model for Address.

type AddressLine1 

type AddressLine1 string

AddressLine1 defines model for AddressLine1.

type AddressLine2 

type AddressLine2 string

AddressLine2 defines model for AddressLine2.

type AddressLine3 

type AddressLine3 string

AddressLine3 defines model for AddressLine3.

type AddressName 

type AddressName string

AddressName defines model for AddressName.

type AmazonOrderId 

type AmazonOrderId string

AmazonOrderId defines model for AmazonOrderId.

type AvailableCarrierWillPickUpOption 

type AvailableCarrierWillPickUpOption struct {

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

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

AvailableCarrierWillPickUpOption defines model for AvailableCarrierWillPickUpOption.

type AvailableCarrierWillPickUpOptionsList 

type AvailableCarrierWillPickUpOptionsList []AvailableCarrierWillPickUpOption

AvailableCarrierWillPickUpOptionsList defines model for AvailableCarrierWillPickUpOptionsList.

type AvailableDeliveryExperienceOption 

type AvailableDeliveryExperienceOption struct {

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

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

AvailableDeliveryExperienceOption defines model for AvailableDeliveryExperienceOption.

type AvailableDeliveryExperienceOptionsList 

type AvailableDeliveryExperienceOptionsList []AvailableDeliveryExperienceOption

AvailableDeliveryExperienceOptionsList defines model for AvailableDeliveryExperienceOptionsList.

type AvailableFormatOptionsForLabel 

type AvailableFormatOptionsForLabel AvailableFormatOptionsForLabelList

AvailableFormatOptionsForLabel defines model for AvailableFormatOptionsForLabel.

type AvailableFormatOptionsForLabelList 

type AvailableFormatOptionsForLabelList []LabelFormatOption

AvailableFormatOptionsForLabelList defines model for AvailableFormatOptionsForLabelList.

type AvailableShippingServiceOptions 

type AvailableShippingServiceOptions struct {

	// List of available carrier pickup options.
	AvailableCarrierWillPickUpOptions AvailableCarrierWillPickUpOptionsList `json:"AvailableCarrierWillPickUpOptions"`

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

AvailableShippingServiceOptions defines model for AvailableShippingServiceOptions.

type CancelShipmentOldResp 

type CancelShipmentOldResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *CancelShipmentResponse
}

func ParseCancelShipmentOldResp 

func ParseCancelShipmentOldResp(rsp *http.Response) (*CancelShipmentOldResp, error)

ParseCancelShipmentOldResp parses an HTTP response from a CancelShipmentOldWithResponse call

func (CancelShipmentOldResp) Status 

func (r CancelShipmentOldResp) Status() string

Status returns HTTPResponse.Status

func (CancelShipmentOldResp) StatusCode 

func (r CancelShipmentOldResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CancelShipmentResp 

type CancelShipmentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *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 {

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

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

CancelShipmentResponse defines model for CancelShipmentResponse.

type CarrierWillPickUpOption 

type CarrierWillPickUpOption string

CarrierWillPickUpOption defines model for CarrierWillPickUpOption. 

const (
	CarrierWillPickUpOption_CarrierWillPickUp  CarrierWillPickUpOption = "CarrierWillPickUp"
	CarrierWillPickUpOption_NoPreference       CarrierWillPickUpOption = "NoPreference"
	CarrierWillPickUpOption_ShipperWillDropOff CarrierWillPickUpOption = "ShipperWillDropOff"
)

List of CarrierWillPickUpOption

type City 

type City string

City defines model for 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.
	Endpoint string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A callback for modifying requests which are generated before sending over
	// the network.
	RequestBefore RequestBeforeFn

	// A callback for modifying response which are generated before sending over
	// the network.
	ResponseAfter ResponseAfterFn

	// 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(endpoint 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) CancelShipmentOld 

func (c *Client) CancelShipmentOld(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) GetAdditionalSellerInputsOld 

func (c *Client) GetAdditionalSellerInputsOld(ctx context.Context, body GetAdditionalSellerInputsOldJSONRequestBody) (*http.Response, error)

func (*Client) GetAdditionalSellerInputsOldWithBody 

func (c *Client) GetAdditionalSellerInputsOldWithBody(ctx context.Context, contentType string, body io.Reader) (*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) GetEligibleShipmentServicesOld 

func (c *Client) GetEligibleShipmentServicesOld(ctx context.Context, body GetEligibleShipmentServicesOldJSONRequestBody) (*http.Response, error)

func (*Client) GetEligibleShipmentServicesOldWithBody 

func (c *Client) GetEligibleShipmentServicesOldWithBody(ctx context.Context, contentType string, body io.Reader) (*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 {
	// GetAdditionalSellerInputs 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)

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

	GetEligibleShipmentServicesOld(ctx context.Context, body GetEligibleShipmentServicesOldJSONRequestBody) (*http.Response, error)

	// GetEligibleShipmentServices 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)

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

	GetAdditionalSellerInputsOld(ctx context.Context, body GetAdditionalSellerInputsOldJSONRequestBody) (*http.Response, error)

	// CreateShipment 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)

	// CancelShipmentOld request
	CancelShipmentOld(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 WithRequestBefore 

func WithRequestBefore(fn RequestBeforeFn) ClientOption

WithRequestBefore allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithResponseAfter 

func WithResponseAfter(fn ResponseAfterFn) ClientOption

WithResponseAfter allows setting up a callback function, which will be called right after get response the request. This can be used to log.

func WithUserAgent 

func WithUserAgent(userAgent string) ClientOption

WithUserAgent set up useragent add user agent to every request automatically

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

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

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CancelShipmentOldWithResponse 

func (c *ClientWithResponses) CancelShipmentOldWithResponse(ctx context.Context, shipmentId string) (*CancelShipmentOldResp, error)

CancelShipmentOldWithResponse request returning *CancelShipmentOldResponse

func (*ClientWithResponses) CancelShipmentWithResponse 

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

CancelShipmentWithResponse request returning *CancelShipmentResponse

func (*ClientWithResponses) CreateShipmentWithBodyWithResponse 

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

CreateShipmentWithBodyWithResponse request with arbitrary body returning *CreateShipmentResponse

func (*ClientWithResponses) CreateShipmentWithResponse 

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

func (*ClientWithResponses) GetAdditionalSellerInputsOldWithBodyWithResponse 

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

GetAdditionalSellerInputsOldWithBodyWithResponse request with arbitrary body returning *GetAdditionalSellerInputsOldResponse

func (*ClientWithResponses) GetAdditionalSellerInputsOldWithResponse 

func (c *ClientWithResponses) GetAdditionalSellerInputsOldWithResponse(ctx context.Context, body GetAdditionalSellerInputsOldJSONRequestBody) (*GetAdditionalSellerInputsOldResp, error)

func (*ClientWithResponses) GetAdditionalSellerInputsWithBodyWithResponse 

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

GetAdditionalSellerInputsWithBodyWithResponse request with arbitrary body returning *GetAdditionalSellerInputsResponse

func (*ClientWithResponses) GetAdditionalSellerInputsWithResponse 

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

func (*ClientWithResponses) GetEligibleShipmentServicesOldWithBodyWithResponse 

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

GetEligibleShipmentServicesOldWithBodyWithResponse request with arbitrary body returning *GetEligibleShipmentServicesOldResponse

func (*ClientWithResponses) GetEligibleShipmentServicesOldWithResponse 

func (c *ClientWithResponses) GetEligibleShipmentServicesOldWithResponse(ctx context.Context, body GetEligibleShipmentServicesOldJSONRequestBody) (*GetEligibleShipmentServicesOldResp, error)

func (*ClientWithResponses) GetEligibleShipmentServicesWithBodyWithResponse 

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

GetEligibleShipmentServicesWithBodyWithResponse request with arbitrary body returning *GetEligibleShipmentServicesResponse

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 *GetShipmentResponse

type ClientWithResponsesInterface 

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

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

	// GetEligibleShipmentServicesOld request  with any body
	GetEligibleShipmentServicesOldWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetEligibleShipmentServicesOldResp, error)

	GetEligibleShipmentServicesOldWithResponse(ctx context.Context, body GetEligibleShipmentServicesOldJSONRequestBody) (*GetEligibleShipmentServicesOldResp, error)

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

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

	// GetAdditionalSellerInputsOld request  with any body
	GetAdditionalSellerInputsOldWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*GetAdditionalSellerInputsOldResp, error)

	GetAdditionalSellerInputsOldWithResponse(ctx context.Context, body GetAdditionalSellerInputsOldJSONRequestBody) (*GetAdditionalSellerInputsOldResp, error)

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

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

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

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

	// CancelShipmentOld request
	CancelShipmentOldWithResponse(ctx context.Context, shipmentId string) (*CancelShipmentOldResp, error)
}

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

type Constraint 

type Constraint struct {

	// A regular expression.
	ValidationRegEx *string `json:"ValidationRegEx,omitempty"`

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

Constraint defines model for Constraint.

type Constraints 

type Constraints []Constraint

Constraints defines model for Constraints.

type CountryCode 

type CountryCode string

CountryCode defines model for CountryCode.

type CreateShipmentJSONBody 

type CreateShipmentJSONBody CreateShipmentRequest

CreateShipmentJSONBody defines parameters for CreateShipment.

type CreateShipmentJSONRequestBody 

type CreateShipmentJSONRequestBody CreateShipmentJSONBody

CreateShipmentRequestBody defines body for CreateShipment for application/json ContentType.

type CreateShipmentRequest 

type CreateShipmentRequest struct {

	// 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"`

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

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

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

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

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

CreateShipmentRequest defines model for CreateShipmentRequest.

type CreateShipmentResp 

type CreateShipmentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *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 {

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

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

CreateShipmentResponse defines model for CreateShipmentResponse.

type CurrencyAmount 

type CurrencyAmount struct {

	// The currency amount.
	Amount float64 `json:"Amount"`

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

CurrencyAmount defines model for CurrencyAmount.

type CustomTextForLabel 

type CustomTextForLabel string

CustomTextForLabel defines model for CustomTextForLabel.

type DeliveryExperienceOption 

type DeliveryExperienceOption string

DeliveryExperienceOption defines model for DeliveryExperienceOption. 

const (
	DeliveryExperienceOption_DeliveryConfirmationWithAdultSignature DeliveryExperienceOption = "DeliveryConfirmationWithAdultSignature"
	DeliveryExperienceOption_DeliveryConfirmationWithSignature      DeliveryExperienceOption = "DeliveryConfirmationWithSignature"
	DeliveryExperienceOption_DeliveryConfirmationWithoutSignature   DeliveryExperienceOption = "DeliveryConfirmationWithoutSignature"
	DeliveryExperienceOption_NoPreference                           DeliveryExperienceOption = "NoPreference"
	DeliveryExperienceOption_NoTracking                             DeliveryExperienceOption = "NoTracking"
)

List of DeliveryExperienceOption

type DeliveryExperienceType 

type DeliveryExperienceType string

DeliveryExperienceType defines model for DeliveryExperienceType. 

const (
	DeliveryExperienceType_DeliveryConfirmationWithAdultSignature DeliveryExperienceType = "DeliveryConfirmationWithAdultSignature"
	DeliveryExperienceType_DeliveryConfirmationWithSignature      DeliveryExperienceType = "DeliveryConfirmationWithSignature"
	DeliveryExperienceType_DeliveryConfirmationWithoutSignature   DeliveryExperienceType = "DeliveryConfirmationWithoutSignature"
	DeliveryExperienceType_NoTracking                             DeliveryExperienceType = "NoTracking"
)

List of DeliveryExperienceType

type DistrictOrCounty 

type DistrictOrCounty string

DistrictOrCounty defines model for DistrictOrCounty.

type EmailAddress 

type EmailAddress string

EmailAddress defines model for EmailAddress.

type Error 

type Error struct {

	// An error code that identifies the type of error that occured.
	Code string `json:"code"`

	// Additional details that can help the caller understand or fix the issue.
	Details *string `json:"details,omitempty"`

	// A message that describes the error condition in a human-readable form.
	Message string `json:"message"`
}

Error defines model for Error.

type ErrorList 

type ErrorList []Error

ErrorList defines model for ErrorList.

type FileContents 

type FileContents struct {

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

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

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

FileContents defines model for FileContents.

type FileType 

type FileType string

FileType defines model for FileType. 

const (
	FileType_application_pdf FileType = "application/pdf"
	FileType_application_zpl FileType = "application/zpl"
	FileType_image_png       FileType = "image/png"
)

List of FileType

type GetAdditionalSellerInputsJSONBody 

type GetAdditionalSellerInputsJSONBody GetAdditionalSellerInputsRequest

GetAdditionalSellerInputsJSONBody defines parameters for GetAdditionalSellerInputs.

type GetAdditionalSellerInputsJSONRequestBody 

type GetAdditionalSellerInputsJSONRequestBody GetAdditionalSellerInputsJSONBody

GetAdditionalSellerInputsRequestBody defines body for GetAdditionalSellerInputs for application/json ContentType.

type GetAdditionalSellerInputsOldJSONBody 

type GetAdditionalSellerInputsOldJSONBody GetAdditionalSellerInputsRequest

GetAdditionalSellerInputsOldJSONBody defines parameters for GetAdditionalSellerInputsOld.

type GetAdditionalSellerInputsOldJSONRequestBody 

type GetAdditionalSellerInputsOldJSONRequestBody GetAdditionalSellerInputsOldJSONBody

GetAdditionalSellerInputsOldRequestBody defines body for GetAdditionalSellerInputsOld for application/json ContentType.

type GetAdditionalSellerInputsOldResp 

type GetAdditionalSellerInputsOldResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetAdditionalSellerInputsResponse
}

func ParseGetAdditionalSellerInputsOldResp 

func ParseGetAdditionalSellerInputsOldResp(rsp *http.Response) (*GetAdditionalSellerInputsOldResp, error)

ParseGetAdditionalSellerInputsOldResp parses an HTTP response from a GetAdditionalSellerInputsOldWithResponse call

func (GetAdditionalSellerInputsOldResp) Status 

func (r GetAdditionalSellerInputsOldResp) Status() string

Status returns HTTPResponse.Status

func (GetAdditionalSellerInputsOldResp) StatusCode 

func (r GetAdditionalSellerInputsOldResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAdditionalSellerInputsRequest 

type GetAdditionalSellerInputsRequest struct {

	// An Amazon-defined order identifier, in 3-7-7 format. <br>**Pattern** : `[0-9A-Z]{3}-[0-9]{7}-[0-9]{7}`.
	OrderId AmazonOrderId `json:"OrderId"`

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

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

GetAdditionalSellerInputsRequest defines model for GetAdditionalSellerInputsRequest.

type GetAdditionalSellerInputsResp 

type GetAdditionalSellerInputsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *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 {

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

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

GetAdditionalSellerInputsResponse defines model for GetAdditionalSellerInputsResponse.

type GetAdditionalSellerInputsResult 

type GetAdditionalSellerInputsResult struct {

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

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

GetAdditionalSellerInputsResult defines model for GetAdditionalSellerInputsResult.

type GetEligibleShipmentServicesJSONBody 

type GetEligibleShipmentServicesJSONBody GetEligibleShipmentServicesRequest

GetEligibleShipmentServicesJSONBody defines parameters for GetEligibleShipmentServices.

type GetEligibleShipmentServicesJSONRequestBody 

type GetEligibleShipmentServicesJSONRequestBody GetEligibleShipmentServicesJSONBody

GetEligibleShipmentServicesRequestBody defines body for GetEligibleShipmentServices for application/json ContentType.

type GetEligibleShipmentServicesOldJSONBody 

type GetEligibleShipmentServicesOldJSONBody GetEligibleShipmentServicesRequest

GetEligibleShipmentServicesOldJSONBody defines parameters for GetEligibleShipmentServicesOld.

type GetEligibleShipmentServicesOldJSONRequestBody 

type GetEligibleShipmentServicesOldJSONRequestBody GetEligibleShipmentServicesOldJSONBody

GetEligibleShipmentServicesOldRequestBody defines body for GetEligibleShipmentServicesOld for application/json ContentType.

type GetEligibleShipmentServicesOldResp 

type GetEligibleShipmentServicesOldResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetEligibleShipmentServicesResponse
}

func ParseGetEligibleShipmentServicesOldResp 

func ParseGetEligibleShipmentServicesOldResp(rsp *http.Response) (*GetEligibleShipmentServicesOldResp, error)

ParseGetEligibleShipmentServicesOldResp parses an HTTP response from a GetEligibleShipmentServicesOldWithResponse call

func (GetEligibleShipmentServicesOldResp) Status 

func (r GetEligibleShipmentServicesOldResp) Status() string

Status returns HTTPResponse.Status

func (GetEligibleShipmentServicesOldResp) StatusCode 

func (r GetEligibleShipmentServicesOldResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEligibleShipmentServicesRequest 

type GetEligibleShipmentServicesRequest struct {

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

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

GetEligibleShipmentServicesRequest defines model for GetEligibleShipmentServicesRequest.

type GetEligibleShipmentServicesResp 

type GetEligibleShipmentServicesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *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 {

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

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

GetEligibleShipmentServicesResponse defines model for GetEligibleShipmentServicesResponse.

type GetEligibleShipmentServicesResult 

type GetEligibleShipmentServicesResult struct {

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

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

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

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

GetEligibleShipmentServicesResult defines model for GetEligibleShipmentServicesResult.

type GetShipmentResp 

type GetShipmentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *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 {

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

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

GetShipmentResponse defines model for GetShipmentResponse.

type HazmatType 

type HazmatType string

HazmatType defines model for HazmatType. 

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

List of 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 InputTargetType 

type InputTargetType string

InputTargetType defines model for InputTargetType. 

const (
	InputTargetType_ITEM_LEVEL     InputTargetType = "ITEM_LEVEL"
	InputTargetType_SHIPMENT_LEVEL InputTargetType = "SHIPMENT_LEVEL"
)

List of InputTargetType

type Item 

type Item struct {

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

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

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

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

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

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

Item defines model for Item.

type ItemDescription 

type ItemDescription string

ItemDescription defines model for ItemDescription.

type ItemLevelFields 

type ItemLevelFields struct {

	// A list of additional inputs.
	AdditionalInputs AdditionalInputsList `json:"AdditionalInputs"`

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

ItemLevelFields defines model for ItemLevelFields.

type ItemLevelFieldsList 

type ItemLevelFieldsList []ItemLevelFields

ItemLevelFieldsList defines model for ItemLevelFieldsList.

type ItemList 

type ItemList []Item

ItemList defines model for ItemList.

type ItemQuantity 

type ItemQuantity int32

ItemQuantity defines model for ItemQuantity.

type Label 

type Label struct {

	// 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 for printing a shipping label.
	Dimensions LabelDimensions `json:"Dimensions"`

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

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

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

Label defines model for Label.

type LabelCustomization 

type LabelCustomization struct {

	// 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"`

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

LabelCustomization defines model for LabelCustomization.

type LabelDimension 

type LabelDimension float32

LabelDimension defines model for LabelDimension.

type LabelDimensions 

type LabelDimensions struct {

	// A label dimension.
	Length LabelDimension `json:"Length"`

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

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

LabelDimensions defines model for LabelDimensions.

type LabelFormat 

type LabelFormat string

LabelFormat defines model for LabelFormat. 

const (
	LabelFormat_PDF                    LabelFormat = "PDF"
	LabelFormat_PNG                    LabelFormat = "PNG"
	LabelFormat_ShippingServiceDefault LabelFormat = "ShippingServiceDefault"
	LabelFormat_ZPL203                 LabelFormat = "ZPL203"
	LabelFormat_ZPL300                 LabelFormat = "ZPL300"
)

List of LabelFormat

type LabelFormatList 

type LabelFormatList []LabelFormat

LabelFormatList defines model for LabelFormatList.

type LabelFormatOption 

type LabelFormatOption struct {

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

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

LabelFormatOption defines model for LabelFormatOption.

type LabelFormatOptionRequest 

type LabelFormatOptionRequest struct {

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

LabelFormatOptionRequest defines model for LabelFormatOptionRequest.

type Length 

type Length struct {

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

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

Length defines model for Length.

type OrderItemId 

type OrderItemId string

OrderItemId defines model for OrderItemId.

type PackageDimension 

type PackageDimension float64

PackageDimension defines model for PackageDimension.

type PackageDimensions 

type PackageDimensions struct {
	Height *PackageDimension `json:"Height,omitempty"`
	Length *PackageDimension `json:"Length,omitempty"`

	// 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"`

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

PackageDimensions defines model for PackageDimensions.

type PhoneNumber 

type PhoneNumber string

PhoneNumber defines model for PhoneNumber.

type PostalCode 

type PostalCode string

PostalCode defines model for PostalCode.

type PredefinedPackageDimensions 

type PredefinedPackageDimensions string

PredefinedPackageDimensions defines model for PredefinedPackageDimensions. 

const (
	PredefinedPackageDimensions_FedEx_Box_10kg                 PredefinedPackageDimensions = "FedEx_Box_10kg"
	PredefinedPackageDimensions_FedEx_Box_25kg                 PredefinedPackageDimensions = "FedEx_Box_25kg"
	PredefinedPackageDimensions_FedEx_Box_Extra_Large_1        PredefinedPackageDimensions = "FedEx_Box_Extra_Large_1"
	PredefinedPackageDimensions_FedEx_Box_Extra_Large_2        PredefinedPackageDimensions = "FedEx_Box_Extra_Large_2"
	PredefinedPackageDimensions_FedEx_Box_Large_1              PredefinedPackageDimensions = "FedEx_Box_Large_1"
	PredefinedPackageDimensions_FedEx_Box_Large_2              PredefinedPackageDimensions = "FedEx_Box_Large_2"
	PredefinedPackageDimensions_FedEx_Box_Medium_1             PredefinedPackageDimensions = "FedEx_Box_Medium_1"
	PredefinedPackageDimensions_FedEx_Box_Medium_2             PredefinedPackageDimensions = "FedEx_Box_Medium_2"
	PredefinedPackageDimensions_FedEx_Box_Small_1              PredefinedPackageDimensions = "FedEx_Box_Small_1"
	PredefinedPackageDimensions_FedEx_Box_Small_2              PredefinedPackageDimensions = "FedEx_Box_Small_2"
	PredefinedPackageDimensions_FedEx_Envelope                 PredefinedPackageDimensions = "FedEx_Envelope"
	PredefinedPackageDimensions_FedEx_Padded_Pak               PredefinedPackageDimensions = "FedEx_Padded_Pak"
	PredefinedPackageDimensions_FedEx_Pak_1                    PredefinedPackageDimensions = "FedEx_Pak_1"
	PredefinedPackageDimensions_FedEx_Pak_2                    PredefinedPackageDimensions = "FedEx_Pak_2"
	PredefinedPackageDimensions_FedEx_Tube                     PredefinedPackageDimensions = "FedEx_Tube"
	PredefinedPackageDimensions_FedEx_XL_Pak                   PredefinedPackageDimensions = "FedEx_XL_Pak"
	PredefinedPackageDimensions_UPS_Box_10kg                   PredefinedPackageDimensions = "UPS_Box_10kg"
	PredefinedPackageDimensions_UPS_Box_25kg                   PredefinedPackageDimensions = "UPS_Box_25kg"
	PredefinedPackageDimensions_UPS_Express_Box                PredefinedPackageDimensions = "UPS_Express_Box"
	PredefinedPackageDimensions_UPS_Express_Box_Large          PredefinedPackageDimensions = "UPS_Express_Box_Large"
	PredefinedPackageDimensions_UPS_Express_Box_Medium         PredefinedPackageDimensions = "UPS_Express_Box_Medium"
	PredefinedPackageDimensions_UPS_Express_Box_Small          PredefinedPackageDimensions = "UPS_Express_Box_Small"
	PredefinedPackageDimensions_UPS_Express_Envelope           PredefinedPackageDimensions = "UPS_Express_Envelope"
	PredefinedPackageDimensions_UPS_Express_Hard_Pak           PredefinedPackageDimensions = "UPS_Express_Hard_Pak"
	PredefinedPackageDimensions_UPS_Express_Legal_Envelope     PredefinedPackageDimensions = "UPS_Express_Legal_Envelope"
	PredefinedPackageDimensions_UPS_Express_Pak                PredefinedPackageDimensions = "UPS_Express_Pak"
	PredefinedPackageDimensions_UPS_Express_Tube               PredefinedPackageDimensions = "UPS_Express_Tube"
	PredefinedPackageDimensions_UPS_Laboratory_Pak             PredefinedPackageDimensions = "UPS_Laboratory_Pak"
	PredefinedPackageDimensions_UPS_Pad_Pak                    PredefinedPackageDimensions = "UPS_Pad_Pak"
	PredefinedPackageDimensions_UPS_Pallet                     PredefinedPackageDimensions = "UPS_Pallet"
	PredefinedPackageDimensions_USPS_Card                      PredefinedPackageDimensions = "USPS_Card"
	PredefinedPackageDimensions_USPS_Flat                      PredefinedPackageDimensions = "USPS_Flat"
	PredefinedPackageDimensions_USPS_FlatRateCardboardEnvelope PredefinedPackageDimensions = "USPS_FlatRateCardboardEnvelope"
	PredefinedPackageDimensions_USPS_FlatRateEnvelope          PredefinedPackageDimensions = "USPS_FlatRateEnvelope"
	PredefinedPackageDimensions_USPS_FlatRateGiftCardEnvelope  PredefinedPackageDimensions = "USPS_FlatRateGiftCardEnvelope"
	PredefinedPackageDimensions_USPS_FlatRateLegalEnvelope     PredefinedPackageDimensions = "USPS_FlatRateLegalEnvelope"
	PredefinedPackageDimensions_USPS_FlatRatePaddedEnvelope    PredefinedPackageDimensions = "USPS_FlatRatePaddedEnvelope"
	PredefinedPackageDimensions_USPS_FlatRateWindowEnvelope    PredefinedPackageDimensions = "USPS_FlatRateWindowEnvelope"
	PredefinedPackageDimensions_USPS_LargeFlatRateBoardGameBox PredefinedPackageDimensions = "USPS_LargeFlatRateBoardGameBox"
	PredefinedPackageDimensions_USPS_LargeFlatRateBox          PredefinedPackageDimensions = "USPS_LargeFlatRateBox"
	PredefinedPackageDimensions_USPS_Letter                    PredefinedPackageDimensions = "USPS_Letter"
	PredefinedPackageDimensions_USPS_MediumFlatRateBox1        PredefinedPackageDimensions = "USPS_MediumFlatRateBox1"
	PredefinedPackageDimensions_USPS_MediumFlatRateBox2        PredefinedPackageDimensions = "USPS_MediumFlatRateBox2"
	PredefinedPackageDimensions_USPS_RegionalRateBoxA1         PredefinedPackageDimensions = "USPS_RegionalRateBoxA1"
	PredefinedPackageDimensions_USPS_RegionalRateBoxA2         PredefinedPackageDimensions = "USPS_RegionalRateBoxA2"
	PredefinedPackageDimensions_USPS_RegionalRateBoxB1         PredefinedPackageDimensions = "USPS_RegionalRateBoxB1"
	PredefinedPackageDimensions_USPS_RegionalRateBoxB2         PredefinedPackageDimensions = "USPS_RegionalRateBoxB2"
	PredefinedPackageDimensions_USPS_RegionalRateBoxC          PredefinedPackageDimensions = "USPS_RegionalRateBoxC"
	PredefinedPackageDimensions_USPS_SmallFlatRateBox          PredefinedPackageDimensions = "USPS_SmallFlatRateBox"
	PredefinedPackageDimensions_USPS_SmallFlatRateEnvelope     PredefinedPackageDimensions = "USPS_SmallFlatRateEnvelope"
)

List of PredefinedPackageDimensions

type RejectedShippingService 

type RejectedShippingService struct {

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

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

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

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

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

RejectedShippingService defines model for RejectedShippingService.

type RejectedShippingServiceList 

type RejectedShippingServiceList []RejectedShippingService

RejectedShippingServiceList defines model for RejectedShippingServiceList.

type RequestBeforeFn 

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

RequestBeforeFn is the function signature for the RequestBefore callback function

type ResponseAfterFn 

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

ResponseAfterFn is the function signature for the ResponseAfter callback function

type RestrictedSetValues 

type RestrictedSetValues []string

RestrictedSetValues defines model for RestrictedSetValues.

type SellerInputDefinition 

type SellerInputDefinition struct {

	// List of constraints.
	Constraints Constraints `json:"Constraints"`

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

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

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

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

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

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

SellerInputDefinition defines model for SellerInputDefinition.

type SellerOrderId 

type SellerOrderId string

SellerOrderId defines model for SellerOrderId.

type Shipment 

type Shipment struct {

	// An Amazon-defined order identifier, in 3-7-7 format. <br>**Pattern** : `[0-9A-Z]{3}-[0-9]{7}-[0-9]{7}`.
	AmazonOrderId AmazonOrderId `json:"AmazonOrderId"`
	CreatedDate   Timestamp     `json:"CreatedDate"`

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

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

	// Data for creating a shipping label and dimensions for printing the label.
	Label           Label      `json:"Label"`
	LastUpdatedDate *Timestamp `json:"LastUpdatedDate,omitempty"`

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

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

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

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

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

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

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

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

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

Shipment defines model for Shipment.

type ShipmentId 

type ShipmentId string

ShipmentId defines model for ShipmentId.

type ShipmentRequestDetails 

type ShipmentRequestDetails struct {

	// An Amazon-defined order identifier, in 3-7-7 format. <br>**Pattern** : `[0-9A-Z]{3}-[0-9]{7}-[0-9]{7}`.
	AmazonOrderId AmazonOrderId `json:"AmazonOrderId"`

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

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

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

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

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

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

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

ShipmentRequestDetails defines model for ShipmentRequestDetails.

type ShipmentStatus 

type ShipmentStatus string

ShipmentStatus defines model for ShipmentStatus. 

const (
	ShipmentStatus_Purchased      ShipmentStatus = "Purchased"
	ShipmentStatus_RefundApplied  ShipmentStatus = "RefundApplied"
	ShipmentStatus_RefundPending  ShipmentStatus = "RefundPending"
	ShipmentStatus_RefundRejected ShipmentStatus = "RefundRejected"
)

List of ShipmentStatus

type ShippingOfferingFilter 

type ShippingOfferingFilter struct {

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

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

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

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

ShippingOfferingFilter defines model for ShippingOfferingFilter.

type ShippingService 

type ShippingService struct {

	// The available label formats.
	AvailableFormatOptionsForLabel *AvailableFormatOptionsForLabelList `json:"AvailableFormatOptionsForLabel,omitempty"`

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

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

	// The name of the carrier.
	CarrierName                   string     `json:"CarrierName"`
	EarliestEstimatedDeliveryDate *Timestamp `json:"EarliestEstimatedDeliveryDate,omitempty"`
	LatestEstimatedDeliveryDate   *Timestamp `json:"LatestEstimatedDeliveryDate,omitempty"`

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

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

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

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

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

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

ShippingService defines model for ShippingService.

type ShippingServiceIdentifier 

type ShippingServiceIdentifier string

ShippingServiceIdentifier defines model for ShippingServiceIdentifier.

type ShippingServiceList 

type ShippingServiceList []ShippingService

ShippingServiceList defines model for ShippingServiceList.

type ShippingServiceOptions 

type ShippingServiceOptions struct {

	// 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"`

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

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

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

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

ShippingServiceOptions defines model for ShippingServiceOptions.

type StandardIdForLabel 

type StandardIdForLabel string

StandardIdForLabel defines model for StandardIdForLabel. 

const (
	StandardIdForLabel_AmazonOrderId StandardIdForLabel = "AmazonOrderId"
)

List of StandardIdForLabel

type StateOrProvinceCode 

type StateOrProvinceCode string

StateOrProvinceCode defines model for StateOrProvinceCode.

type TemporarilyUnavailableCarrier 

type TemporarilyUnavailableCarrier struct {

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

TemporarilyUnavailableCarrier defines model for TemporarilyUnavailableCarrier.

type TemporarilyUnavailableCarrierList 

type TemporarilyUnavailableCarrierList []TemporarilyUnavailableCarrier

TemporarilyUnavailableCarrierList defines model for TemporarilyUnavailableCarrierList.

type TermsAndConditionsNotAcceptedCarrier 

type TermsAndConditionsNotAcceptedCarrier struct {

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

TermsAndConditionsNotAcceptedCarrier defines model for TermsAndConditionsNotAcceptedCarrier.

type TermsAndConditionsNotAcceptedCarrierList 

type TermsAndConditionsNotAcceptedCarrierList []TermsAndConditionsNotAcceptedCarrier

TermsAndConditionsNotAcceptedCarrierList defines model for TermsAndConditionsNotAcceptedCarrierList.

type Timestamp 

type Timestamp time.Time

Timestamp defines model for Timestamp.

type TrackingId 

type TrackingId string

TrackingId defines model for TrackingId.

type TransparencyCode 

type TransparencyCode string

TransparencyCode defines model for TransparencyCode.

type TransparencyCodeList 

type TransparencyCodeList []TransparencyCode

TransparencyCodeList defines model for TransparencyCodeList.

type UnitOfLength 

type UnitOfLength string

UnitOfLength defines model for UnitOfLength. 

const (
	UnitOfLength_centimeters UnitOfLength = "centimeters"
	UnitOfLength_inches      UnitOfLength = "inches"
)

List of UnitOfLength

type UnitOfWeight 

type UnitOfWeight string

UnitOfWeight defines model for UnitOfWeight. 

const (
	UnitOfWeight_g  UnitOfWeight = "g"
	UnitOfWeight_oz UnitOfWeight = "oz"
)

List of UnitOfWeight

type Weight 

type Weight struct {

	// The unit of weight.
	Unit UnitOfWeight `json:"Unit"`

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

Weight defines model for Weight.

type WeightValue 

type WeightValue float64

WeightValue defines model for WeightValue.

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.