shipment_invoicing_v0_models

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2023 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address struct {

	// The street address.
	AddressLine1 string `json:"AddressLine1,omitempty"`

	// Additional street address information, if required.
	AddressLine2 string `json:"AddressLine2,omitempty"`

	// Additional street address information, if required.
	AddressLine3 string `json:"AddressLine3,omitempty"`

	// address type
	AddressType AddressTypeEnum `json:"AddressType,omitempty"`

	// The city.
	City string `json:"City,omitempty"`

	// The country code.
	CountryCode string `json:"CountryCode,omitempty"`

	// The county.
	County string `json:"County,omitempty"`

	// The district.
	District string `json:"District,omitempty"`

	// The name.
	Name string `json:"Name,omitempty"`

	// The phone number.
	Phone string `json:"Phone,omitempty"`

	// The postal code.
	PostalCode string `json:"PostalCode,omitempty"`

	// The state or region.
	StateOrRegion string `json:"StateOrRegion,omitempty"`
}

Address The shipping address details of the shipment.

swagger:model Address

func (*Address) ContextValidate 

func (m *Address) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this address based on the context it is used

func (*Address) MarshalBinary 

func (m *Address) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Address) UnmarshalBinary 

func (m *Address) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Address) Validate 

func (m *Address) Validate(formats strfmt.Registry) error

Validate validates this address

type AddressTypeEnum 

type AddressTypeEnum string

AddressTypeEnum The shipping address type.

swagger:model AddressTypeEnum 

const (

	// AddressTypeEnumResidential captures enum value "Residential"
	AddressTypeEnumResidential AddressTypeEnum = "Residential"

	// AddressTypeEnumCommercial captures enum value "Commercial"
	AddressTypeEnumCommercial AddressTypeEnum = "Commercial"
)

func NewAddressTypeEnum 

func NewAddressTypeEnum(value AddressTypeEnum) *AddressTypeEnum

func (AddressTypeEnum) ContextValidate 

func (m AddressTypeEnum) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this address type enum based on context it is used

func (AddressTypeEnum) Pointer 

func (m AddressTypeEnum) Pointer() *AddressTypeEnum

Pointer returns a pointer to a freshly-allocated AddressTypeEnum.

func (AddressTypeEnum) Validate 

func (m AddressTypeEnum) Validate(formats strfmt.Registry) error

Validate validates this address type enum

type Blob 

type Blob strfmt.Base64

Blob Shipment invoice document content.

swagger:model Blob

func (Blob) ContextValidate 

func (m Blob) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this blob based on context it is used

func (*Blob) MarshalBinary 

func (m *Blob) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (Blob) MarshalJSON 

func (m Blob) MarshalJSON() ([]byte, error)

MarshalJSON retrieves a Blob value as JSON output

func (*Blob) UnmarshalBinary 

func (m *Blob) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Blob) UnmarshalJSON 

func (m *Blob) UnmarshalJSON(b []byte) error

UnmarshalJSON sets a Blob value from JSON input

func (Blob) Validate 

func (m Blob) Validate(formats strfmt.Registry) error

Validate validates this blob

type BuyerTaxInfo 

type BuyerTaxInfo struct {

	// The legal name of the company.
	CompanyLegalName string `json:"CompanyLegalName,omitempty"`

	// tax classifications
	TaxClassifications TaxClassificationList `json:"TaxClassifications,omitempty"`

	// The country or region imposing the tax.
	TaxingRegion string `json:"TaxingRegion,omitempty"`
}

BuyerTaxInfo Tax information about the buyer.

swagger:model BuyerTaxInfo

func (*BuyerTaxInfo) ContextValidate 

func (m *BuyerTaxInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this buyer tax info based on the context it is used

func (*BuyerTaxInfo) MarshalBinary 

func (m *BuyerTaxInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BuyerTaxInfo) UnmarshalBinary 

func (m *BuyerTaxInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BuyerTaxInfo) Validate 

func (m *BuyerTaxInfo) Validate(formats strfmt.Registry) error

Validate validates this buyer tax info

type Error 

type Error struct {

	// An error code that identifies the type of error that occurred.
	// Required: true
	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.
	// Required: true
	Message *string `json:"message"`
}

Error An error response returned when the request is unsuccessful.

swagger:model Error

func (*Error) ContextValidate 

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type ErrorList 

type ErrorList []*Error

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

swagger:model ErrorList

func (ErrorList) ContextValidate 

func (m ErrorList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error list based on the context it is used

func (ErrorList) Validate 

func (m ErrorList) Validate(formats strfmt.Registry) error

Validate validates this error list

type GetInvoiceStatusResponse 

type GetInvoiceStatusResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

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

GetInvoiceStatusResponse The response schema for the getInvoiceStatus operation.

swagger:model GetInvoiceStatusResponse

func (*GetInvoiceStatusResponse) ContextValidate 

func (m *GetInvoiceStatusResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get invoice status response based on the context it is used

func (*GetInvoiceStatusResponse) MarshalBinary 

func (m *GetInvoiceStatusResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetInvoiceStatusResponse) UnmarshalBinary 

func (m *GetInvoiceStatusResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetInvoiceStatusResponse) Validate 

func (m *GetInvoiceStatusResponse) Validate(formats strfmt.Registry) error

Validate validates this get invoice status response

type GetShipmentDetailsResponse 

type GetShipmentDetailsResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// The payload for the getShipmentDetails operation
	Payload *ShipmentDetail `json:"payload,omitempty"`
}

GetShipmentDetailsResponse The response schema for the getShipmentDetails operation.

swagger:model GetShipmentDetailsResponse

func (*GetShipmentDetailsResponse) ContextValidate 

func (m *GetShipmentDetailsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get shipment details response based on the context it is used

func (*GetShipmentDetailsResponse) MarshalBinary 

func (m *GetShipmentDetailsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetShipmentDetailsResponse) UnmarshalBinary 

func (m *GetShipmentDetailsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetShipmentDetailsResponse) Validate 

func (m *GetShipmentDetailsResponse) Validate(formats strfmt.Registry) error

Validate validates this get shipment details response

type MarketplaceTaxInfo 

type MarketplaceTaxInfo struct {

	// The legal name of the company.
	CompanyLegalName string `json:"CompanyLegalName,omitempty"`

	// tax classifications
	TaxClassifications TaxClassificationList `json:"TaxClassifications,omitempty"`

	// The country or region imposing the tax.
	TaxingRegion string `json:"TaxingRegion,omitempty"`
}

MarketplaceTaxInfo Tax information about the marketplace.

swagger:model MarketplaceTaxInfo

func (*MarketplaceTaxInfo) ContextValidate 

func (m *MarketplaceTaxInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this marketplace tax info based on the context it is used

func (*MarketplaceTaxInfo) MarshalBinary 

func (m *MarketplaceTaxInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MarketplaceTaxInfo) UnmarshalBinary 

func (m *MarketplaceTaxInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MarketplaceTaxInfo) Validate 

func (m *MarketplaceTaxInfo) Validate(formats strfmt.Registry) error

Validate validates this marketplace tax info

type Money 

type Money struct {

	// The currency amount.
	Amount string `json:"Amount,omitempty"`

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

Money The currency type and amount.

swagger:model Money

func (*Money) ContextValidate 

func (m *Money) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this money based on context it is used

func (*Money) MarshalBinary 

func (m *Money) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Money) UnmarshalBinary 

func (m *Money) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Money) Validate 

func (m *Money) Validate(formats strfmt.Registry) error

Validate validates this money

type PaymentMethodDetailItemList 

type PaymentMethodDetailItemList []string

PaymentMethodDetailItemList The list of payment method details.

swagger:model PaymentMethodDetailItemList

func (PaymentMethodDetailItemList) ContextValidate 

func (m PaymentMethodDetailItemList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this payment method detail item list based on context it is used

func (PaymentMethodDetailItemList) Validate 

func (m PaymentMethodDetailItemList) Validate(formats strfmt.Registry) error

Validate validates this payment method detail item list

type SerialNumbersList 

type SerialNumbersList []string

SerialNumbersList The list of serial numbers.

swagger:model SerialNumbersList

func (SerialNumbersList) ContextValidate 

func (m SerialNumbersList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this serial numbers list based on context it is used

func (SerialNumbersList) Validate 

func (m SerialNumbersList) Validate(formats strfmt.Registry) error

Validate validates this serial numbers list

type ShipmentDetail 

type ShipmentDetail struct {

	// The Amazon-defined identifier for the order.
	AmazonOrderID string `json:"AmazonOrderId,omitempty"`

	// The Amazon-defined identifier for the shipment.
	AmazonShipmentID string `json:"AmazonShipmentId,omitempty"`

	// The county of the buyer.
	BuyerCounty string `json:"BuyerCounty,omitempty"`

	// The name of the buyer.
	BuyerName string `json:"BuyerName,omitempty"`

	// buyer tax info
	BuyerTaxInfo *BuyerTaxInfo `json:"BuyerTaxInfo,omitempty"`

	// The identifier for the marketplace where the order was placed.
	MarketplaceID string `json:"MarketplaceId,omitempty"`

	// marketplace tax info
	MarketplaceTaxInfo *MarketplaceTaxInfo `json:"MarketplaceTaxInfo,omitempty"`

	// payment method details
	PaymentMethodDetails PaymentMethodDetailItemList `json:"PaymentMethodDetails,omitempty"`

	// The date and time when the order was created.
	// Format: date-time
	PurchaseDate strfmt.DateTime `json:"PurchaseDate,omitempty"`

	// The seller’s friendly name registered in the marketplace.
	SellerDisplayName string `json:"SellerDisplayName,omitempty"`

	// The seller identifier.
	SellerID string `json:"SellerId,omitempty"`

	// shipment items
	ShipmentItems ShipmentItems `json:"ShipmentItems,omitempty"`

	// shipping address
	ShippingAddress *Address `json:"ShippingAddress,omitempty"`

	// The Amazon-defined identifier for the warehouse.
	WarehouseID string `json:"WarehouseId,omitempty"`
}

ShipmentDetail The information required by a selling partner to issue a shipment invoice.

swagger:model ShipmentDetail

func (*ShipmentDetail) ContextValidate 

func (m *ShipmentDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this shipment detail based on the context it is used

func (*ShipmentDetail) MarshalBinary 

func (m *ShipmentDetail) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ShipmentDetail) UnmarshalBinary 

func (m *ShipmentDetail) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ShipmentDetail) Validate 

func (m *ShipmentDetail) Validate(formats strfmt.Registry) error

Validate validates this shipment detail

type ShipmentInvoiceStatus 

type ShipmentInvoiceStatus string

ShipmentInvoiceStatus The shipment invoice status.

swagger:model ShipmentInvoiceStatus 

const (

	// ShipmentInvoiceStatusProcessing captures enum value "Processing"
	ShipmentInvoiceStatusProcessing ShipmentInvoiceStatus = "Processing"

	// ShipmentInvoiceStatusAccepted captures enum value "Accepted"
	ShipmentInvoiceStatusAccepted ShipmentInvoiceStatus = "Accepted"

	// ShipmentInvoiceStatusErrored captures enum value "Errored"
	ShipmentInvoiceStatusErrored ShipmentInvoiceStatus = "Errored"

	// ShipmentInvoiceStatusNotFound captures enum value "NotFound"
	ShipmentInvoiceStatusNotFound ShipmentInvoiceStatus = "NotFound"
)

func NewShipmentInvoiceStatus 

func NewShipmentInvoiceStatus(value ShipmentInvoiceStatus) *ShipmentInvoiceStatus

func (ShipmentInvoiceStatus) ContextValidate 

func (m ShipmentInvoiceStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this shipment invoice status based on context it is used

func (ShipmentInvoiceStatus) Pointer 

func (m ShipmentInvoiceStatus) Pointer() *ShipmentInvoiceStatus

Pointer returns a pointer to a freshly-allocated ShipmentInvoiceStatus.

func (ShipmentInvoiceStatus) Validate 

func (m ShipmentInvoiceStatus) Validate(formats strfmt.Registry) error

Validate validates this shipment invoice status

type ShipmentInvoiceStatusInfo 

type ShipmentInvoiceStatusInfo struct {

	// The Amazon-defined shipment identifier.
	AmazonShipmentID string `json:"AmazonShipmentId,omitempty"`

	// invoice status
	InvoiceStatus ShipmentInvoiceStatus `json:"InvoiceStatus,omitempty"`
}

ShipmentInvoiceStatusInfo The shipment invoice status information.

swagger:model ShipmentInvoiceStatusInfo

func (*ShipmentInvoiceStatusInfo) ContextValidate 

func (m *ShipmentInvoiceStatusInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this shipment invoice status info based on the context it is used

func (*ShipmentInvoiceStatusInfo) MarshalBinary 

func (m *ShipmentInvoiceStatusInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ShipmentInvoiceStatusInfo) UnmarshalBinary 

func (m *ShipmentInvoiceStatusInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ShipmentInvoiceStatusInfo) Validate 

func (m *ShipmentInvoiceStatusInfo) Validate(formats strfmt.Registry) error

Validate validates this shipment invoice status info

type ShipmentInvoiceStatusResponse 

type ShipmentInvoiceStatusResponse struct {

	// shipments
	Shipments *ShipmentInvoiceStatusInfo `json:"Shipments,omitempty"`
}

ShipmentInvoiceStatusResponse The shipment invoice status response.

swagger:model ShipmentInvoiceStatusResponse

func (*ShipmentInvoiceStatusResponse) ContextValidate 

func (m *ShipmentInvoiceStatusResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this shipment invoice status response based on the context it is used

func (*ShipmentInvoiceStatusResponse) MarshalBinary 

func (m *ShipmentInvoiceStatusResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ShipmentInvoiceStatusResponse) UnmarshalBinary 

func (m *ShipmentInvoiceStatusResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ShipmentInvoiceStatusResponse) Validate 

func (m *ShipmentInvoiceStatusResponse) Validate(formats strfmt.Registry) error

Validate validates this shipment invoice status response

type ShipmentItem 

type ShipmentItem struct {

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

	// The gift wrap price of the item.
	GiftWrapPrice *Money `json:"GiftWrapPrice,omitempty"`

	// The selling price of the item multiplied by the quantity ordered. Note that ItemPrice excludes ShippingPrice and GiftWrapPrice.
	ItemPrice *Money `json:"ItemPrice,omitempty"`

	// The Amazon-defined identifier for the order item.
	OrderItemID string `json:"OrderItemId,omitempty"`

	// The total of all promotional discounts in the offer.
	PromotionDiscount *Money `json:"PromotionDiscount,omitempty"`

	// The number of items ordered.
	QuantityOrdered float64 `json:"QuantityOrdered,omitempty"`

	// The seller SKU of the item.
	SellerSKU string `json:"SellerSKU,omitempty"`

	// The list of serial numbers.
	SerialNumbers SerialNumbersList `json:"SerialNumbers,omitempty"`

	// The discount on the shipping price.
	ShippingDiscount *Money `json:"ShippingDiscount,omitempty"`

	// The shipping price of the item.
	ShippingPrice *Money `json:"ShippingPrice,omitempty"`

	// The name of the item.
	Title string `json:"Title,omitempty"`
}

ShipmentItem The shipment item information required by a seller to issue a shipment invoice.

swagger:model ShipmentItem

func (*ShipmentItem) ContextValidate 

func (m *ShipmentItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this shipment item based on the context it is used

func (*ShipmentItem) MarshalBinary 

func (m *ShipmentItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ShipmentItem) UnmarshalBinary 

func (m *ShipmentItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ShipmentItem) Validate 

func (m *ShipmentItem) Validate(formats strfmt.Registry) error

Validate validates this shipment item

type ShipmentItems 

type ShipmentItems []*ShipmentItem

ShipmentItems A list of shipment items.

swagger:model ShipmentItems

func (ShipmentItems) ContextValidate 

func (m ShipmentItems) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this shipment items based on the context it is used

func (ShipmentItems) Validate 

func (m ShipmentItems) Validate(formats strfmt.Registry) error

Validate validates this shipment items

type SubmitInvoiceRequest 

type SubmitInvoiceRequest struct {

	// MD5 sum for validating the invoice data. For more information about calculating this value, see [Working with Content-MD5 Checksums](https://docs.developer.amazonservices.com/en_US/dev_guide/DG_MD5.html).
	// Required: true
	ContentMD5Value *string `json:"ContentMD5Value"`

	// invoice content
	// Required: true
	// Format: byte
	InvoiceContent *Blob `json:"InvoiceContent"`

	// An Amazon marketplace identifier.
	MarketplaceID string `json:"MarketplaceId,omitempty"`
}

SubmitInvoiceRequest The request schema for the submitInvoice operation.

swagger:model SubmitInvoiceRequest

func (*SubmitInvoiceRequest) ContextValidate 

func (m *SubmitInvoiceRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this submit invoice request based on the context it is used

func (*SubmitInvoiceRequest) MarshalBinary 

func (m *SubmitInvoiceRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SubmitInvoiceRequest) UnmarshalBinary 

func (m *SubmitInvoiceRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SubmitInvoiceRequest) Validate 

func (m *SubmitInvoiceRequest) Validate(formats strfmt.Registry) error

Validate validates this submit invoice request

type SubmitInvoiceResponse 

type SubmitInvoiceResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`
}

SubmitInvoiceResponse The response schema for the submitInvoice operation.

swagger:model SubmitInvoiceResponse

func (*SubmitInvoiceResponse) ContextValidate 

func (m *SubmitInvoiceResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this submit invoice response based on the context it is used

func (*SubmitInvoiceResponse) MarshalBinary 

func (m *SubmitInvoiceResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SubmitInvoiceResponse) UnmarshalBinary 

func (m *SubmitInvoiceResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SubmitInvoiceResponse) Validate 

func (m *SubmitInvoiceResponse) Validate(formats strfmt.Registry) error

Validate validates this submit invoice response

type TaxClassification 

type TaxClassification struct {

	// The type of tax.
	Name string `json:"Name,omitempty"`

	// The entity's tax identifier.
	Value string `json:"Value,omitempty"`
}

TaxClassification The tax classification for the entity.

swagger:model TaxClassification

func (*TaxClassification) ContextValidate 

func (m *TaxClassification) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this tax classification based on context it is used

func (*TaxClassification) MarshalBinary 

func (m *TaxClassification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TaxClassification) UnmarshalBinary 

func (m *TaxClassification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TaxClassification) Validate 

func (m *TaxClassification) Validate(formats strfmt.Registry) error

Validate validates this tax classification

type TaxClassificationList 

type TaxClassificationList []*TaxClassification

TaxClassificationList The list of tax classifications.

swagger:model TaxClassificationList

func (TaxClassificationList) ContextValidate 

func (m TaxClassificationList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this tax classification list based on the context it is used

func (TaxClassificationList) Validate 

func (m TaxClassificationList) Validate(formats strfmt.Registry) error

Validate validates this tax classification list

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.