Documentation
¶
Index ¶
- Constants
- type Address
- type AddressExtendedFields
- type AmazonPrograms
- type AssociatedItem
- type AssociationType
- type AutomatedShippingSettings
- func (m *AutomatedShippingSettings) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AutomatedShippingSettings) MarshalBinary() ([]byte, error)
- func (m *AutomatedShippingSettings) UnmarshalBinary(b []byte) error
- func (m *AutomatedShippingSettings) Validate(formats strfmt.Registry) error
- type BusinessHours
- type BuyerCustomizedInfoDetail
- func (m *BuyerCustomizedInfoDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *BuyerCustomizedInfoDetail) MarshalBinary() ([]byte, error)
- func (m *BuyerCustomizedInfoDetail) UnmarshalBinary(b []byte) error
- func (m *BuyerCustomizedInfoDetail) Validate(formats strfmt.Registry) error
- type BuyerInfo
- type BuyerRequestedCancel
- type BuyerTaxInfo
- type BuyerTaxInformation
- type ConfirmShipmentErrorResponse
- func (m *ConfirmShipmentErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ConfirmShipmentErrorResponse) MarshalBinary() ([]byte, error)
- func (m *ConfirmShipmentErrorResponse) UnmarshalBinary(b []byte) error
- func (m *ConfirmShipmentErrorResponse) Validate(formats strfmt.Registry) error
- type ConfirmShipmentOrderItem
- func (m *ConfirmShipmentOrderItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ConfirmShipmentOrderItem) MarshalBinary() ([]byte, error)
- func (m *ConfirmShipmentOrderItem) UnmarshalBinary(b []byte) error
- func (m *ConfirmShipmentOrderItem) Validate(formats strfmt.Registry) error
- type ConfirmShipmentOrderItemsList
- type ConfirmShipmentRequest
- func (m *ConfirmShipmentRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ConfirmShipmentRequest) MarshalBinary() ([]byte, error)
- func (m *ConfirmShipmentRequest) UnmarshalBinary(b []byte) error
- func (m *ConfirmShipmentRequest) Validate(formats strfmt.Registry) error
- type ConstraintType
- type DeliveryPreferences
- type EasyShipShipmentStatus
- type ElectronicInvoiceStatus
- type Error
- type ErrorList
- type ExceptionDates
- type FulfillmentInstruction
- func (m *FulfillmentInstruction) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *FulfillmentInstruction) MarshalBinary() ([]byte, error)
- func (m *FulfillmentInstruction) UnmarshalBinary(b []byte) error
- func (m *FulfillmentInstruction) Validate(formats strfmt.Registry) error
- type GetOrderAddressResponse
- func (m *GetOrderAddressResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GetOrderAddressResponse) MarshalBinary() ([]byte, error)
- func (m *GetOrderAddressResponse) UnmarshalBinary(b []byte) error
- func (m *GetOrderAddressResponse) Validate(formats strfmt.Registry) error
- type GetOrderBuyerInfoResponse
- func (m *GetOrderBuyerInfoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GetOrderBuyerInfoResponse) MarshalBinary() ([]byte, error)
- func (m *GetOrderBuyerInfoResponse) UnmarshalBinary(b []byte) error
- func (m *GetOrderBuyerInfoResponse) Validate(formats strfmt.Registry) error
- type GetOrderItemsBuyerInfoResponse
- func (m *GetOrderItemsBuyerInfoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GetOrderItemsBuyerInfoResponse) MarshalBinary() ([]byte, error)
- func (m *GetOrderItemsBuyerInfoResponse) UnmarshalBinary(b []byte) error
- func (m *GetOrderItemsBuyerInfoResponse) Validate(formats strfmt.Registry) error
- type GetOrderItemsResponse
- type GetOrderRegulatedInfoResponse
- func (m *GetOrderRegulatedInfoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GetOrderRegulatedInfoResponse) MarshalBinary() ([]byte, error)
- func (m *GetOrderRegulatedInfoResponse) UnmarshalBinary(b []byte) error
- func (m *GetOrderRegulatedInfoResponse) Validate(formats strfmt.Registry) error
- type GetOrderResponse
- type GetOrdersResponse
- type ItemBuyerInfo
- type MarketplaceID
- type MarketplaceTaxInfo
- type Measurement
- type Money
- type OpenInterval
- type OpenTimeInterval
- type Order
- type OrderAddress
- type OrderBuyerInfo
- type OrderItem
- type OrderItemBuyerInfo
- type OrderItemBuyerInfoList
- type OrderItemList
- type OrderItems
- type OrderItemsBuyerInfoList
- func (m *OrderItemsBuyerInfoList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *OrderItemsBuyerInfoList) MarshalBinary() ([]byte, error)
- func (m *OrderItemsBuyerInfoList) UnmarshalBinary(b []byte) error
- func (m *OrderItemsBuyerInfoList) Validate(formats strfmt.Registry) error
- type OrderItemsItems0
- type OrderItemsList
- type OrderList
- type OrderRegulatedInfo
- type OrdersList
- type OtherDeliveryAttributes
- type PackageDetail
- type PackageReferenceID
- type PaymentExecutionDetailItem
- func (m *PaymentExecutionDetailItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PaymentExecutionDetailItem) MarshalBinary() ([]byte, error)
- func (m *PaymentExecutionDetailItem) UnmarshalBinary(b []byte) error
- func (m *PaymentExecutionDetailItem) Validate(formats strfmt.Registry) error
- type PaymentExecutionDetailItemList
- type PaymentMethodDetailItemList
- type PointsGrantedDetail
- type PreferredDeliveryTime
- type PrescriptionDetail
- type ProductInfoDetail
- type PromotionIDList
- type RegulatedInformation
- type RegulatedInformationField
- func (m *RegulatedInformationField) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *RegulatedInformationField) MarshalBinary() ([]byte, error)
- func (m *RegulatedInformationField) UnmarshalBinary(b []byte) error
- func (m *RegulatedInformationField) Validate(formats strfmt.Registry) error
- type RegulatedOrderVerificationStatus
- func (m *RegulatedOrderVerificationStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *RegulatedOrderVerificationStatus) MarshalBinary() ([]byte, error)
- func (m *RegulatedOrderVerificationStatus) UnmarshalBinary(b []byte) error
- func (m *RegulatedOrderVerificationStatus) Validate(formats strfmt.Registry) error
- type RejectionReason
- type ShipmentStatus
- type ShippingConstraints
- type SubstitutionOption
- type SubstitutionOptionList
- type SubstitutionPreferences
- func (m *SubstitutionPreferences) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SubstitutionPreferences) MarshalBinary() ([]byte, error)
- func (m *SubstitutionPreferences) UnmarshalBinary(b []byte) error
- func (m *SubstitutionPreferences) Validate(formats strfmt.Registry) error
- type TaxClassification
- type TaxCollection
- type TransparencyCode
- type TransparencyCodeList
- type UpdateShipmentStatusErrorResponse
- func (m *UpdateShipmentStatusErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *UpdateShipmentStatusErrorResponse) MarshalBinary() ([]byte, error)
- func (m *UpdateShipmentStatusErrorResponse) UnmarshalBinary(b []byte) error
- func (m *UpdateShipmentStatusErrorResponse) Validate(formats strfmt.Registry) error
- type UpdateShipmentStatusRequest
- func (m *UpdateShipmentStatusRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *UpdateShipmentStatusRequest) MarshalBinary() ([]byte, error)
- func (m *UpdateShipmentStatusRequest) UnmarshalBinary(b []byte) error
- func (m *UpdateShipmentStatusRequest) Validate(formats strfmt.Registry) error
- type UpdateVerificationStatusErrorResponse
- func (m *UpdateVerificationStatusErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *UpdateVerificationStatusErrorResponse) MarshalBinary() ([]byte, error)
- func (m *UpdateVerificationStatusErrorResponse) UnmarshalBinary(b []byte) error
- func (m *UpdateVerificationStatusErrorResponse) Validate(formats strfmt.Registry) error
- type UpdateVerificationStatusRequest
- func (m *UpdateVerificationStatusRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *UpdateVerificationStatusRequest) MarshalBinary() ([]byte, error)
- func (m *UpdateVerificationStatusRequest) UnmarshalBinary(b []byte) error
- func (m *UpdateVerificationStatusRequest) Validate(formats strfmt.Registry) error
- type UpdateVerificationStatusRequestBody
- func (m *UpdateVerificationStatusRequestBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *UpdateVerificationStatusRequestBody) MarshalBinary() ([]byte, error)
- func (m *UpdateVerificationStatusRequestBody) UnmarshalBinary(b []byte) error
- func (m *UpdateVerificationStatusRequestBody) Validate(formats strfmt.Registry) error
- type ValidVerificationDetail
- func (m *ValidVerificationDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ValidVerificationDetail) MarshalBinary() ([]byte, error)
- func (m *ValidVerificationDetail) UnmarshalBinary(b []byte) error
- func (m *ValidVerificationDetail) Validate(formats strfmt.Registry) error
- type VerificationDetails
- type VerificationStatus
Constants ¶
const ( // AddressAddressTypeResidential captures enum value "Residential" AddressAddressTypeResidential string = "Residential" // AddressAddressTypeCommercial captures enum value "Commercial" AddressAddressTypeCommercial string = "Commercial" )
const ( // BusinessHoursDayOfWeekSUN captures enum value "SUN" BusinessHoursDayOfWeekSUN string = "SUN" // BusinessHoursDayOfWeekMON captures enum value "MON" BusinessHoursDayOfWeekMON string = "MON" // BusinessHoursDayOfWeekTUE captures enum value "TUE" BusinessHoursDayOfWeekTUE string = "TUE" // BusinessHoursDayOfWeekWED captures enum value "WED" BusinessHoursDayOfWeekWED string = "WED" // BusinessHoursDayOfWeekTHU captures enum value "THU" BusinessHoursDayOfWeekTHU string = "THU" // BusinessHoursDayOfWeekFRI captures enum value "FRI" BusinessHoursDayOfWeekFRI string = "FRI" // BusinessHoursDayOfWeekSAT captures enum value "SAT" BusinessHoursDayOfWeekSAT string = "SAT" )
const ( // MeasurementUnitOUNCES captures enum value "OUNCES" MeasurementUnitOUNCES string = "OUNCES" // MeasurementUnitPOUNDS captures enum value "POUNDS" MeasurementUnitPOUNDS string = "POUNDS" // MeasurementUnitKILOGRAMS captures enum value "KILOGRAMS" MeasurementUnitKILOGRAMS string = "KILOGRAMS" // MeasurementUnitGRAMS captures enum value "GRAMS" MeasurementUnitGRAMS string = "GRAMS" // MeasurementUnitMILLIGRAMS captures enum value "MILLIGRAMS" MeasurementUnitMILLIGRAMS string = "MILLIGRAMS" // MeasurementUnitINCHES captures enum value "INCHES" MeasurementUnitINCHES string = "INCHES" // MeasurementUnitFEET captures enum value "FEET" MeasurementUnitFEET string = "FEET" // MeasurementUnitMETERS captures enum value "METERS" MeasurementUnitMETERS string = "METERS" // MeasurementUnitCENTIMETERS captures enum value "CENTIMETERS" MeasurementUnitCENTIMETERS string = "CENTIMETERS" // MeasurementUnitMILLIMETERS captures enum value "MILLIMETERS" MeasurementUnitMILLIMETERS string = "MILLIMETERS" // MeasurementUnitSQUAREMETERS captures enum value "SQUARE_METERS" MeasurementUnitSQUAREMETERS string = "SQUARE_METERS" // MeasurementUnitSQUARECENTIMETERS captures enum value "SQUARE_CENTIMETERS" MeasurementUnitSQUARECENTIMETERS string = "SQUARE_CENTIMETERS" // MeasurementUnitSQUAREFEET captures enum value "SQUARE_FEET" MeasurementUnitSQUAREFEET string = "SQUARE_FEET" // MeasurementUnitSQUAREINCHES captures enum value "SQUARE_INCHES" MeasurementUnitSQUAREINCHES string = "SQUARE_INCHES" // MeasurementUnitGALLONS captures enum value "GALLONS" MeasurementUnitGALLONS string = "GALLONS" // MeasurementUnitPINTS captures enum value "PINTS" MeasurementUnitPINTS string = "PINTS" // MeasurementUnitQUARTS captures enum value "QUARTS" MeasurementUnitQUARTS string = "QUARTS" // MeasurementUnitFLUIDOUNCES captures enum value "FLUID_OUNCES" MeasurementUnitFLUIDOUNCES string = "FLUID_OUNCES" // MeasurementUnitLITERS captures enum value "LITERS" MeasurementUnitLITERS string = "LITERS" // MeasurementUnitCUBICMETERS captures enum value "CUBIC_METERS" MeasurementUnitCUBICMETERS string = "CUBIC_METERS" // MeasurementUnitCUBICFEET captures enum value "CUBIC_FEET" MeasurementUnitCUBICFEET string = "CUBIC_FEET" // MeasurementUnitCUBICINCHES captures enum value "CUBIC_INCHES" MeasurementUnitCUBICINCHES string = "CUBIC_INCHES" // MeasurementUnitCUBICCENTIMETERS captures enum value "CUBIC_CENTIMETERS" MeasurementUnitCUBICCENTIMETERS string = "CUBIC_CENTIMETERS" // MeasurementUnitCOUNT captures enum value "COUNT" MeasurementUnitCOUNT string = "COUNT" )
const ( // OrderBuyerInvoicePreferenceINDIVIDUAL captures enum value "INDIVIDUAL" OrderBuyerInvoicePreferenceINDIVIDUAL string = "INDIVIDUAL" // OrderBuyerInvoicePreferenceBUSINESS captures enum value "BUSINESS" OrderBuyerInvoicePreferenceBUSINESS string = "BUSINESS" )
const ( // OrderFulfillmentChannelMFN captures enum value "MFN" OrderFulfillmentChannelMFN string = "MFN" // OrderFulfillmentChannelAFN captures enum value "AFN" OrderFulfillmentChannelAFN string = "AFN" )
const ( // OrderOrderStatusPending captures enum value "Pending" OrderOrderStatusPending string = "Pending" // OrderOrderStatusUnshipped captures enum value "Unshipped" OrderOrderStatusUnshipped string = "Unshipped" // OrderOrderStatusPartiallyShipped captures enum value "PartiallyShipped" OrderOrderStatusPartiallyShipped string = "PartiallyShipped" // OrderOrderStatusShipped captures enum value "Shipped" OrderOrderStatusShipped string = "Shipped" // OrderOrderStatusCanceled captures enum value "Canceled" OrderOrderStatusCanceled string = "Canceled" // OrderOrderStatusUnfulfillable captures enum value "Unfulfillable" OrderOrderStatusUnfulfillable string = "Unfulfillable" // OrderOrderStatusInvoiceUnconfirmed captures enum value "InvoiceUnconfirmed" OrderOrderStatusInvoiceUnconfirmed string = "InvoiceUnconfirmed" // OrderOrderStatusPendingAvailability captures enum value "PendingAvailability" OrderOrderStatusPendingAvailability string = "PendingAvailability" )
const ( // OrderOrderTypeStandardOrder captures enum value "StandardOrder" OrderOrderTypeStandardOrder string = "StandardOrder" // OrderOrderTypeLongLeadTimeOrder captures enum value "LongLeadTimeOrder" OrderOrderTypeLongLeadTimeOrder string = "LongLeadTimeOrder" // OrderOrderTypePreorder captures enum value "Preorder" OrderOrderTypePreorder string = "Preorder" // OrderOrderTypeBackOrder captures enum value "BackOrder" OrderOrderTypeBackOrder string = "BackOrder" // OrderOrderTypeSourcingOnDemandOrder captures enum value "SourcingOnDemandOrder" OrderOrderTypeSourcingOnDemandOrder string = "SourcingOnDemandOrder" )
const ( // OrderPaymentMethodCOD captures enum value "COD" OrderPaymentMethodCOD string = "COD" // OrderPaymentMethodCVS captures enum value "CVS" OrderPaymentMethodCVS string = "CVS" // OrderPaymentMethodOther captures enum value "Other" OrderPaymentMethodOther string = "Other" )
const ( // OrderItemDeemedResellerCategoryIOSS captures enum value "IOSS" OrderItemDeemedResellerCategoryIOSS string = "IOSS" // OrderItemDeemedResellerCategoryUOSS captures enum value "UOSS" OrderItemDeemedResellerCategoryUOSS string = "UOSS" )
const ( // RegulatedInformationFieldFieldTypeText captures enum value "Text" RegulatedInformationFieldFieldTypeText string = "Text" // RegulatedInformationFieldFieldTypeFileAttachment captures enum value "FileAttachment" RegulatedInformationFieldFieldTypeFileAttachment string = "FileAttachment" )
const ( // SubstitutionPreferencesSubstitutionTypeCUSTOMERPREFERENCE captures enum value "CUSTOMER_PREFERENCE" SubstitutionPreferencesSubstitutionTypeCUSTOMERPREFERENCE string = "CUSTOMER_PREFERENCE" // SubstitutionPreferencesSubstitutionTypeAMAZONRECOMMENDED captures enum value "AMAZON_RECOMMENDED" SubstitutionPreferencesSubstitutionTypeAMAZONRECOMMENDED string = "AMAZON_RECOMMENDED" // SubstitutionPreferencesSubstitutionTypeDONOTSUBSTITUTE captures enum value "DO_NOT_SUBSTITUTE" SubstitutionPreferencesSubstitutionTypeDONOTSUBSTITUTE string = "DO_NOT_SUBSTITUTE" )
const ( // ConfirmShipmentRequestCodCollectionMethodDirectPayment captures enum value "DirectPayment" ConfirmShipmentRequestCodCollectionMethodDirectPayment string = "DirectPayment" )
const ( // TaxCollectionModelMarketplaceFacilitator captures enum value "MarketplaceFacilitator" TaxCollectionModelMarketplaceFacilitator string = "MarketplaceFacilitator" )
const ( // TaxCollectionResponsiblePartyAmazonServicesIncDot captures enum value "Amazon Services, Inc." TaxCollectionResponsiblePartyAmazonServicesIncDot string = "Amazon Services, Inc." )
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"` // The address type of the shipping address. // Enum: [Residential Commercial] AddressType string `json:"AddressType,omitempty"` // The city. City string `json:"City,omitempty"` // The company name of the recipient. // // **Note**: This attribute is only available for shipping address. CompanyName string `json:"CompanyName,omitempty"` // The country code. A two-character country code, in ISO 3166-1 alpha-2 format. CountryCode string `json:"CountryCode,omitempty"` // The county. County string `json:"County,omitempty"` // The district. District string `json:"District,omitempty"` // The container for address extended fields. For example, street name or street number. // // **Note**: This attribute is currently only available with Brazil shipping addresses. ExtendedFields *AddressExtendedFields `json:"ExtendedFields,omitempty"` // The municipality. Municipality string `json:"Municipality,omitempty"` // The name. // Required: true Name *string `json:"Name"` // The phone number of the buyer. // // **Note**: // 1. This attribute is only available for shipping address. // 2. In some cases, the buyer phone number is suppressed: // a. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders. // b. Phone is suppressed for the shipped `MFN` (fulfilled by seller) order when the current date is past the Latest Delivery Date. 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 for the order.
swagger:model Address
func (*Address) ContextValidate ¶
ContextValidate validate this address based on the context it is used
func (*Address) MarshalBinary ¶
MarshalBinary interface implementation
func (*Address) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AddressExtendedFields ¶ added in v0.24.10
type AddressExtendedFields struct { // The floor number/unit number in the building/private house number. Complement string `json:"Complement,omitempty"` // The neighborhood. This value is only used in some countries (such as Brazil). Neighborhood string `json:"Neighborhood,omitempty"` // The street name. StreetName string `json:"StreetName,omitempty"` // The house, building, or property number associated with the location's street address. StreetNumber string `json:"StreetNumber,omitempty"` }
AddressExtendedFields The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses.
swagger:model AddressExtendedFields
func (*AddressExtendedFields) ContextValidate ¶ added in v0.24.10
ContextValidate validates this address extended fields based on context it is used
func (*AddressExtendedFields) MarshalBinary ¶ added in v0.24.10
func (m *AddressExtendedFields) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddressExtendedFields) UnmarshalBinary ¶ added in v0.24.10
func (m *AddressExtendedFields) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AmazonPrograms ¶ added in v0.24.10
type AmazonPrograms struct { // A list of the programs that are associated with the specified order item. // // **Possible values**: `SUBSCRIBE_AND_SAVE` // Required: true Programs []string `json:"Programs"` }
AmazonPrograms Contains the list of programs that are associated with an item.
Possible programs are:
- **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products.
swagger:model AmazonPrograms
func (*AmazonPrograms) ContextValidate ¶ added in v0.24.10
ContextValidate validates this amazon programs based on context it is used
func (*AmazonPrograms) MarshalBinary ¶ added in v0.24.10
func (m *AmazonPrograms) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AmazonPrograms) UnmarshalBinary ¶ added in v0.24.10
func (m *AmazonPrograms) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AssociatedItem ¶ added in v0.3.0
type AssociatedItem struct { // association type AssociationType AssociationType `json:"AssociationType,omitempty"` // The order item's order identifier, in 3-7-7 format. OrderID string `json:"OrderId,omitempty"` // An Amazon-defined item identifier for the associated item. OrderItemID string `json:"OrderItemId,omitempty"` }
AssociatedItem An item that is associated with an order item. For example, a tire installation service that is purchased with tires.
swagger:model AssociatedItem
func (*AssociatedItem) ContextValidate ¶ added in v0.3.0
ContextValidate validate this associated item based on the context it is used
func (*AssociatedItem) MarshalBinary ¶ added in v0.3.0
func (m *AssociatedItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AssociatedItem) UnmarshalBinary ¶ added in v0.3.0
func (m *AssociatedItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AssociationType ¶ added in v0.3.0
type AssociationType string
AssociationType The type of association an item has with an order item.
swagger:model AssociationType
const ( // AssociationTypeVALUEADDSERVICE captures enum value "VALUE_ADD_SERVICE" AssociationTypeVALUEADDSERVICE AssociationType = "VALUE_ADD_SERVICE" )
func NewAssociationType ¶ added in v0.3.0
func NewAssociationType(value AssociationType) *AssociationType
func (AssociationType) ContextValidate ¶ added in v0.3.0
ContextValidate validates this association type based on context it is used
func (AssociationType) Pointer ¶ added in v0.3.0
func (m AssociationType) Pointer() *AssociationType
Pointer returns a pointer to a freshly-allocated AssociationType.
type AutomatedShippingSettings ¶
type AutomatedShippingSettings struct { // Auto-generated carrier for SSA orders. AutomatedCarrier string `json:"AutomatedCarrier,omitempty"` // Auto-generated ship method for SSA orders. AutomatedShipMethod string `json:"AutomatedShipMethod,omitempty"` // When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order. HasAutomatedShippingSettings bool `json:"HasAutomatedShippingSettings,omitempty"` }
AutomatedShippingSettings Contains information regarding the Shipping Settings Automation program, such as whether the order's shipping settings were generated automatically, and what those settings are.
swagger:model AutomatedShippingSettings
func (*AutomatedShippingSettings) ContextValidate ¶
func (m *AutomatedShippingSettings) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this automated shipping settings based on context it is used
func (*AutomatedShippingSettings) MarshalBinary ¶
func (m *AutomatedShippingSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AutomatedShippingSettings) UnmarshalBinary ¶
func (m *AutomatedShippingSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BusinessHours ¶
type BusinessHours struct { // Day of the week. // Enum: [SUN MON TUE WED THU FRI SAT] DayOfWeek string `json:"DayOfWeek,omitempty"` // Time window during the day when the business is open. OpenIntervals []*OpenInterval `json:"OpenIntervals"` }
BusinessHours Business days and hours when the destination is open for deliveries.
swagger:model BusinessHours
func (*BusinessHours) ContextValidate ¶
ContextValidate validate this business hours based on the context it is used
func (*BusinessHours) MarshalBinary ¶
func (m *BusinessHours) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BusinessHours) UnmarshalBinary ¶
func (m *BusinessHours) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuyerCustomizedInfoDetail ¶
type BuyerCustomizedInfoDetail struct { // The location of a ZIP file containing Amazon Custom data. CustomizedURL string `json:"CustomizedURL,omitempty"` }
BuyerCustomizedInfoDetail Buyer information for custom orders from the Amazon Custom program.
swagger:model BuyerCustomizedInfoDetail
func (*BuyerCustomizedInfoDetail) ContextValidate ¶
func (m *BuyerCustomizedInfoDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this buyer customized info detail based on context it is used
func (*BuyerCustomizedInfoDetail) MarshalBinary ¶
func (m *BuyerCustomizedInfoDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuyerCustomizedInfoDetail) UnmarshalBinary ¶
func (m *BuyerCustomizedInfoDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuyerInfo ¶
type BuyerInfo struct { // The county of the buyer. // // **Note**: This attribute is only available in the Brazil marketplace. BuyerCounty string `json:"BuyerCounty,omitempty"` // The anonymized email address of the buyer. BuyerEmail string `json:"BuyerEmail,omitempty"` // The buyer name or the recipient name. BuyerName string `json:"BuyerName,omitempty"` // Tax information about the buyer. Sellers can use this data to issue electronic invoices for business orders. // // **Note**: This attribute is only available for business orders in the Brazil, Mexico and India marketplaces. BuyerTaxInfo *BuyerTaxInfo `json:"BuyerTaxInfo,omitempty"` // The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout. PurchaseOrderNumber string `json:"PurchaseOrderNumber,omitempty"` }
BuyerInfo Buyer information.
swagger:model BuyerInfo
func (*BuyerInfo) ContextValidate ¶
ContextValidate validate this buyer info based on the context it is used
func (*BuyerInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*BuyerInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BuyerRequestedCancel ¶
type BuyerRequestedCancel struct { // The reason that the buyer requested cancellation. BuyerCancelReason string `json:"BuyerCancelReason,omitempty"` // Indicate whether the buyer has requested cancellation. // // **Possible Values**: `true`, `false`. IsBuyerRequestedCancel string `json:"IsBuyerRequestedCancel,omitempty"` }
BuyerRequestedCancel Information about whether or not a buyer requested cancellation.
swagger:model BuyerRequestedCancel
func (*BuyerRequestedCancel) ContextValidate ¶
ContextValidate validates this buyer requested cancel based on context it is used
func (*BuyerRequestedCancel) MarshalBinary ¶
func (m *BuyerRequestedCancel) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuyerRequestedCancel) UnmarshalBinary ¶
func (m *BuyerRequestedCancel) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuyerTaxInfo ¶
type BuyerTaxInfo struct { // The legal name of the company. CompanyLegalName string `json:"CompanyLegalName,omitempty"` // A list of tax classifications that apply to the order. TaxClassifications []*TaxClassification `json:"TaxClassifications"` // The country or region imposing the tax. TaxingRegion string `json:"TaxingRegion,omitempty"` }
BuyerTaxInfo Tax information about the buyer.
swagger:model BuyerTaxInfo
func (*BuyerTaxInfo) ContextValidate ¶
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
type BuyerTaxInformation ¶
type BuyerTaxInformation struct { // Business buyer's address. BuyerBusinessAddress string `json:"BuyerBusinessAddress,omitempty"` // Business buyer's company legal name. BuyerLegalCompanyName string `json:"BuyerLegalCompanyName,omitempty"` // Business buyer's tax office. BuyerTaxOffice string `json:"BuyerTaxOffice,omitempty"` // Business buyer's tax registration ID. BuyerTaxRegistrationID string `json:"BuyerTaxRegistrationId,omitempty"` }
BuyerTaxInformation Contains the business invoice tax information. Available only in the TR marketplace.
swagger:model BuyerTaxInformation
func (*BuyerTaxInformation) ContextValidate ¶
ContextValidate validates this buyer tax information based on context it is used
func (*BuyerTaxInformation) MarshalBinary ¶
func (m *BuyerTaxInformation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuyerTaxInformation) UnmarshalBinary ¶
func (m *BuyerTaxInformation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfirmShipmentErrorResponse ¶
type ConfirmShipmentErrorResponse struct { // One or more unexpected errors occurred during the `confirmShipment` operation. Errors ErrorList `json:"errors,omitempty"` }
ConfirmShipmentErrorResponse The error response schema for the `confirmShipment` operation.
swagger:model ConfirmShipmentErrorResponse
func (*ConfirmShipmentErrorResponse) ContextValidate ¶
func (m *ConfirmShipmentErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this confirm shipment error response based on the context it is used
func (*ConfirmShipmentErrorResponse) MarshalBinary ¶
func (m *ConfirmShipmentErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfirmShipmentErrorResponse) UnmarshalBinary ¶
func (m *ConfirmShipmentErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfirmShipmentOrderItem ¶
type ConfirmShipmentOrderItem struct { // The order item's unique identifier. // Required: true OrderItemID *string `json:"orderItemId"` // The item's quantity. // Required: true Quantity *int64 `json:"quantity"` // The list of transparency codes. TransparencyCodes TransparencyCodeList `json:"transparencyCodes,omitempty"` }
ConfirmShipmentOrderItem A single order item.
swagger:model ConfirmShipmentOrderItem
func (*ConfirmShipmentOrderItem) ContextValidate ¶
func (m *ConfirmShipmentOrderItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this confirm shipment order item based on the context it is used
func (*ConfirmShipmentOrderItem) MarshalBinary ¶
func (m *ConfirmShipmentOrderItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfirmShipmentOrderItem) UnmarshalBinary ¶
func (m *ConfirmShipmentOrderItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfirmShipmentOrderItemsList ¶
type ConfirmShipmentOrderItemsList []*ConfirmShipmentOrderItem
ConfirmShipmentOrderItemsList A list of order items.
swagger:model ConfirmShipmentOrderItemsList
func (ConfirmShipmentOrderItemsList) ContextValidate ¶
func (m ConfirmShipmentOrderItemsList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this confirm shipment order items list based on the context it is used
type ConfirmShipmentRequest ¶
type ConfirmShipmentRequest struct { // The COD collection method (only supported in the JP marketplace). // Enum: [DirectPayment] CodCollectionMethod string `json:"codCollectionMethod,omitempty"` // marketplace Id // Required: true MarketplaceID *MarketplaceID `json:"marketplaceId"` // package detail // Required: true PackageDetail *PackageDetail `json:"packageDetail"` }
ConfirmShipmentRequest The request schema for an shipment confirmation.
swagger:model ConfirmShipmentRequest
func (*ConfirmShipmentRequest) ContextValidate ¶
func (m *ConfirmShipmentRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this confirm shipment request based on the context it is used
func (*ConfirmShipmentRequest) MarshalBinary ¶
func (m *ConfirmShipmentRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfirmShipmentRequest) UnmarshalBinary ¶
func (m *ConfirmShipmentRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConstraintType ¶ added in v0.24.10
type ConstraintType string
ConstraintType Details the importance of the constraint present on the item
swagger:model ConstraintType
const ( // ConstraintTypeMANDATORY captures enum value "MANDATORY" ConstraintTypeMANDATORY ConstraintType = "MANDATORY" )
func NewConstraintType ¶ added in v0.24.10
func NewConstraintType(value ConstraintType) *ConstraintType
func (ConstraintType) ContextValidate ¶ added in v0.24.10
ContextValidate validates this constraint type based on context it is used
func (ConstraintType) Pointer ¶ added in v0.24.10
func (m ConstraintType) Pointer() *ConstraintType
Pointer returns a pointer to a freshly-allocated ConstraintType.
type DeliveryPreferences ¶
type DeliveryPreferences struct { // Building instructions, nearby landmark or navigation instructions. AddressInstructions string `json:"AddressInstructions,omitempty"` // Drop-off location selected by the customer. DropOffLocation string `json:"DropOffLocation,omitempty"` // Enumerated list of miscellaneous delivery attributes associated with the shipping address. OtherAttributes []OtherDeliveryAttributes `json:"OtherAttributes"` // Business hours and days when the delivery is preferred. PreferredDeliveryTime *PreferredDeliveryTime `json:"PreferredDeliveryTime,omitempty"` }
DeliveryPreferences Contains all of the delivery instructions provided by the customer for the shipping address.
swagger:model DeliveryPreferences
func (*DeliveryPreferences) ContextValidate ¶
ContextValidate validate this delivery preferences based on the context it is used
func (*DeliveryPreferences) MarshalBinary ¶
func (m *DeliveryPreferences) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeliveryPreferences) UnmarshalBinary ¶
func (m *DeliveryPreferences) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EasyShipShipmentStatus ¶
type EasyShipShipmentStatus string
EasyShipShipmentStatus The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.
swagger:model EasyShipShipmentStatus
const ( // EasyShipShipmentStatusPendingSchedule captures enum value "PendingSchedule" EasyShipShipmentStatusPendingSchedule EasyShipShipmentStatus = "PendingSchedule" // EasyShipShipmentStatusPendingPickUp captures enum value "PendingPickUp" EasyShipShipmentStatusPendingPickUp EasyShipShipmentStatus = "PendingPickUp" // EasyShipShipmentStatusPendingDropOff captures enum value "PendingDropOff" EasyShipShipmentStatusPendingDropOff EasyShipShipmentStatus = "PendingDropOff" // EasyShipShipmentStatusLabelCanceled captures enum value "LabelCanceled" EasyShipShipmentStatusLabelCanceled EasyShipShipmentStatus = "LabelCanceled" // EasyShipShipmentStatusPickedUp captures enum value "PickedUp" EasyShipShipmentStatusPickedUp EasyShipShipmentStatus = "PickedUp" // EasyShipShipmentStatusDroppedOff captures enum value "DroppedOff" EasyShipShipmentStatusDroppedOff EasyShipShipmentStatus = "DroppedOff" // EasyShipShipmentStatusAtOriginFC captures enum value "AtOriginFC" EasyShipShipmentStatusAtOriginFC EasyShipShipmentStatus = "AtOriginFC" // EasyShipShipmentStatusAtDestinationFC captures enum value "AtDestinationFC" EasyShipShipmentStatusAtDestinationFC EasyShipShipmentStatus = "AtDestinationFC" // EasyShipShipmentStatusDelivered captures enum value "Delivered" EasyShipShipmentStatusDelivered EasyShipShipmentStatus = "Delivered" // EasyShipShipmentStatusRejectedByBuyer captures enum value "RejectedByBuyer" EasyShipShipmentStatusRejectedByBuyer EasyShipShipmentStatus = "RejectedByBuyer" // EasyShipShipmentStatusUndeliverable captures enum value "Undeliverable" EasyShipShipmentStatusUndeliverable EasyShipShipmentStatus = "Undeliverable" // EasyShipShipmentStatusReturningToSeller captures enum value "ReturningToSeller" EasyShipShipmentStatusReturningToSeller EasyShipShipmentStatus = "ReturningToSeller" // EasyShipShipmentStatusReturnedToSeller captures enum value "ReturnedToSeller" EasyShipShipmentStatusReturnedToSeller EasyShipShipmentStatus = "ReturnedToSeller" // EasyShipShipmentStatusLost captures enum value "Lost" EasyShipShipmentStatusLost EasyShipShipmentStatus = "Lost" // EasyShipShipmentStatusOutForDelivery captures enum value "OutForDelivery" EasyShipShipmentStatusOutForDelivery EasyShipShipmentStatus = "OutForDelivery" // EasyShipShipmentStatusDamaged captures enum value "Damaged" EasyShipShipmentStatusDamaged EasyShipShipmentStatus = "Damaged" )
func NewEasyShipShipmentStatus ¶
func NewEasyShipShipmentStatus(value EasyShipShipmentStatus) *EasyShipShipmentStatus
func (EasyShipShipmentStatus) ContextValidate ¶
ContextValidate validates this easy ship shipment status based on context it is used
func (EasyShipShipmentStatus) Pointer ¶
func (m EasyShipShipmentStatus) Pointer() *EasyShipShipmentStatus
Pointer returns a pointer to a freshly-allocated EasyShipShipmentStatus.
type ElectronicInvoiceStatus ¶
type ElectronicInvoiceStatus string
ElectronicInvoiceStatus The status of the electronic invoice. Only available for Easy Ship orders and orders in the BR marketplace.
swagger:model ElectronicInvoiceStatus
const ( // ElectronicInvoiceStatusNotRequired captures enum value "NotRequired" ElectronicInvoiceStatusNotRequired ElectronicInvoiceStatus = "NotRequired" // ElectronicInvoiceStatusNotFound captures enum value "NotFound" ElectronicInvoiceStatusNotFound ElectronicInvoiceStatus = "NotFound" // ElectronicInvoiceStatusProcessing captures enum value "Processing" ElectronicInvoiceStatusProcessing ElectronicInvoiceStatus = "Processing" // ElectronicInvoiceStatusErrored captures enum value "Errored" ElectronicInvoiceStatusErrored ElectronicInvoiceStatus = "Errored" // ElectronicInvoiceStatusAccepted captures enum value "Accepted" ElectronicInvoiceStatusAccepted ElectronicInvoiceStatus = "Accepted" )
func NewElectronicInvoiceStatus ¶
func NewElectronicInvoiceStatus(value ElectronicInvoiceStatus) *ElectronicInvoiceStatus
func (ElectronicInvoiceStatus) ContextValidate ¶
func (m ElectronicInvoiceStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this electronic invoice status based on context it is used
func (ElectronicInvoiceStatus) Pointer ¶
func (m ElectronicInvoiceStatus) Pointer() *ElectronicInvoiceStatus
Pointer returns a pointer to a freshly-allocated ElectronicInvoiceStatus.
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 Error response returned when the request is unsuccessful.
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ErrorList ¶
type ErrorList []*Error
ErrorList A list of error responses returned when a request is unsuccessful.
swagger:model ErrorList
func (ErrorList) ContextValidate ¶
ContextValidate validate this error list based on the context it is used
type ExceptionDates ¶
type ExceptionDates struct { // Date when the business is closed, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date format. ExceptionDate string `json:"ExceptionDate,omitempty"` // Boolean indicating if the business is closed or open on that date. IsOpen bool `json:"IsOpen,omitempty"` // Time window during the day when the business is open. OpenIntervals []*OpenInterval `json:"OpenIntervals"` }
ExceptionDates Dates when the business is closed or open with a different time window.
swagger:model ExceptionDates
func (*ExceptionDates) ContextValidate ¶
ContextValidate validate this exception dates based on the context it is used
func (*ExceptionDates) MarshalBinary ¶
func (m *ExceptionDates) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExceptionDates) UnmarshalBinary ¶
func (m *ExceptionDates) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FulfillmentInstruction ¶
type FulfillmentInstruction struct { // The `sourceId` of the location from where you want the order fulfilled. FulfillmentSupplySourceID string `json:"FulfillmentSupplySourceId,omitempty"` }
FulfillmentInstruction Contains the instructions about the fulfillment, such as the location from where you want the order filled.
swagger:model FulfillmentInstruction
func (*FulfillmentInstruction) ContextValidate ¶
func (m *FulfillmentInstruction) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this fulfillment instruction based on context it is used
func (*FulfillmentInstruction) MarshalBinary ¶
func (m *FulfillmentInstruction) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FulfillmentInstruction) UnmarshalBinary ¶
func (m *FulfillmentInstruction) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetOrderAddressResponse ¶
type GetOrderAddressResponse struct { // One or more unexpected errors occurred during the `getOrderAddress` operation. Errors ErrorList `json:"errors,omitempty"` // The payload for the `getOrderAddress` operations. Payload *OrderAddress `json:"payload,omitempty"` }
GetOrderAddressResponse The response schema for the `getOrderAddress` operation.
swagger:model GetOrderAddressResponse
func (*GetOrderAddressResponse) ContextValidate ¶
func (m *GetOrderAddressResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this get order address response based on the context it is used
func (*GetOrderAddressResponse) MarshalBinary ¶
func (m *GetOrderAddressResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetOrderAddressResponse) UnmarshalBinary ¶
func (m *GetOrderAddressResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetOrderBuyerInfoResponse ¶
type GetOrderBuyerInfoResponse struct { // One or more unexpected errors occurred during the `getOrderBuyerInfo` operation. Errors ErrorList `json:"errors,omitempty"` // The payload for the `getOrderBuyerInfo` operation. Payload *OrderBuyerInfo `json:"payload,omitempty"` }
GetOrderBuyerInfoResponse The response schema for the `getOrderBuyerInfo` operation.
swagger:model GetOrderBuyerInfoResponse
func (*GetOrderBuyerInfoResponse) ContextValidate ¶
func (m *GetOrderBuyerInfoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this get order buyer info response based on the context it is used
func (*GetOrderBuyerInfoResponse) MarshalBinary ¶
func (m *GetOrderBuyerInfoResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetOrderBuyerInfoResponse) UnmarshalBinary ¶
func (m *GetOrderBuyerInfoResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetOrderItemsBuyerInfoResponse ¶
type GetOrderItemsBuyerInfoResponse struct { // One or more unexpected errors occurred during the `getOrderItemsBuyerInfo` operation. Errors ErrorList `json:"errors,omitempty"` // The payload for the `getOrderItemsBuyerInfo` operation. Payload *OrderItemsBuyerInfoList `json:"payload,omitempty"` }
GetOrderItemsBuyerInfoResponse The response schema for the `getOrderItemsBuyerInfo` operation.
swagger:model GetOrderItemsBuyerInfoResponse
func (*GetOrderItemsBuyerInfoResponse) ContextValidate ¶
func (m *GetOrderItemsBuyerInfoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this get order items buyer info response based on the context it is used
func (*GetOrderItemsBuyerInfoResponse) MarshalBinary ¶
func (m *GetOrderItemsBuyerInfoResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetOrderItemsBuyerInfoResponse) UnmarshalBinary ¶
func (m *GetOrderItemsBuyerInfoResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetOrderItemsResponse ¶
type GetOrderItemsResponse struct { // One or more unexpected errors occurred during the `getOrderItems` operation. Errors ErrorList `json:"errors,omitempty"` // The payload for the `getOrderItems` operation. Payload *OrderItemsList `json:"payload,omitempty"` }
GetOrderItemsResponse The response schema for the `getOrderItems` operation.
swagger:model GetOrderItemsResponse
func (*GetOrderItemsResponse) ContextValidate ¶
ContextValidate validate this get order items response based on the context it is used
func (*GetOrderItemsResponse) MarshalBinary ¶
func (m *GetOrderItemsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetOrderItemsResponse) UnmarshalBinary ¶
func (m *GetOrderItemsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetOrderRegulatedInfoResponse ¶
type GetOrderRegulatedInfoResponse struct { // One or more unexpected errors occurred during the `getOrderRegulatedInfo` operation. Errors ErrorList `json:"errors,omitempty"` // The payload for the `getOrderRegulatedInfo` operation. Payload *OrderRegulatedInfo `json:"payload,omitempty"` }
GetOrderRegulatedInfoResponse The response schema for the `getOrderRegulatedInfo` operation.
swagger:model GetOrderRegulatedInfoResponse
func (*GetOrderRegulatedInfoResponse) ContextValidate ¶
func (m *GetOrderRegulatedInfoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this get order regulated info response based on the context it is used
func (*GetOrderRegulatedInfoResponse) MarshalBinary ¶
func (m *GetOrderRegulatedInfoResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetOrderRegulatedInfoResponse) UnmarshalBinary ¶
func (m *GetOrderRegulatedInfoResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetOrderResponse ¶
type GetOrderResponse struct { // One or more unexpected errors occurred during the `getOrder` operation. Errors ErrorList `json:"errors,omitempty"` // The payload for the `getOrder` operation. Payload *Order `json:"payload,omitempty"` }
GetOrderResponse The response schema for the `getOrder` operation.
swagger:model GetOrderResponse
func (*GetOrderResponse) ContextValidate ¶
ContextValidate validate this get order response based on the context it is used
func (*GetOrderResponse) MarshalBinary ¶
func (m *GetOrderResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetOrderResponse) UnmarshalBinary ¶
func (m *GetOrderResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetOrdersResponse ¶
type GetOrdersResponse struct { // One or more unexpected errors occurred during the `getOrders` operation. Errors ErrorList `json:"errors,omitempty"` // The payload for the `getOrders` operation. Payload *OrdersList `json:"payload,omitempty"` }
GetOrdersResponse The response schema for the `getOrders` operation.
swagger:model GetOrdersResponse
func (*GetOrdersResponse) ContextValidate ¶
ContextValidate validate this get orders response based on the context it is used
func (*GetOrdersResponse) MarshalBinary ¶
func (m *GetOrdersResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetOrdersResponse) UnmarshalBinary ¶
func (m *GetOrdersResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ItemBuyerInfo ¶
type ItemBuyerInfo struct { // Buyer information for custom orders from the Amazon Custom program. // // **Note**: This attribute is only available for MFN (fulfilled by seller) orders. BuyerCustomizedInfo *BuyerCustomizedInfoDetail `json:"BuyerCustomizedInfo,omitempty"` // A gift message provided by the buyer. // // **Note**: This attribute is only available for MFN (fulfilled by seller) orders. GiftMessageText string `json:"GiftMessageText,omitempty"` // The gift wrap level specified by the buyer. GiftWrapLevel string `json:"GiftWrapLevel,omitempty"` // The gift wrap price of the item. GiftWrapPrice *Money `json:"GiftWrapPrice,omitempty"` // The tax on the gift wrap price. GiftWrapTax *Money `json:"GiftWrapTax,omitempty"` }
ItemBuyerInfo A single item's buyer information.
swagger:model ItemBuyerInfo
func (*ItemBuyerInfo) ContextValidate ¶
ContextValidate validate this item buyer info based on the context it is used
func (*ItemBuyerInfo) MarshalBinary ¶
func (m *ItemBuyerInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ItemBuyerInfo) UnmarshalBinary ¶
func (m *ItemBuyerInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MarketplaceID ¶
type MarketplaceID string
MarketplaceID The unobfuscated marketplace identifier.
swagger:model MarketplaceId
func (MarketplaceID) ContextValidate ¶
ContextValidate validates this marketplace Id based on context it is used
type MarketplaceTaxInfo ¶
type MarketplaceTaxInfo struct { // A list of tax classifications that apply to the order. TaxClassifications []*TaxClassification `json:"TaxClassifications"` }
MarketplaceTaxInfo Tax information about the marketplace.
swagger:model MarketplaceTaxInfo
func (*MarketplaceTaxInfo) ContextValidate ¶
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
type Measurement ¶ added in v0.3.0
type Measurement struct { // The unit of measure. // Required: true // Enum: [OUNCES POUNDS KILOGRAMS GRAMS MILLIGRAMS INCHES FEET METERS CENTIMETERS MILLIMETERS SQUARE_METERS SQUARE_CENTIMETERS SQUARE_FEET SQUARE_INCHES GALLONS PINTS QUARTS FLUID_OUNCES LITERS CUBIC_METERS CUBIC_FEET CUBIC_INCHES CUBIC_CENTIMETERS COUNT] Unit *string `json:"Unit"` // The measurement value. // Required: true Value *float64 `json:"Value"` }
Measurement Measurement information for an order item.
swagger:model Measurement
func (*Measurement) ContextValidate ¶ added in v0.3.0
ContextValidate validates this measurement based on context it is used
func (*Measurement) MarshalBinary ¶ added in v0.3.0
func (m *Measurement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Measurement) UnmarshalBinary ¶ added in v0.3.0
func (m *Measurement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Money ¶
type Money struct { // The currency amount. Amount string `json:"Amount,omitempty"` // The three-digit currency code. In ISO 4217 format. CurrencyCode string `json:"CurrencyCode,omitempty"` }
Money The monetary value of the order.
swagger:model Money
func (*Money) ContextValidate ¶
ContextValidate validates this money based on context it is used
func (*Money) MarshalBinary ¶
MarshalBinary interface implementation
func (*Money) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type OpenInterval ¶
type OpenInterval struct { // The time when the business closes. EndTime *OpenTimeInterval `json:"EndTime,omitempty"` // The time when the business opens. StartTime *OpenTimeInterval `json:"StartTime,omitempty"` }
OpenInterval The time interval for which the business is open.
swagger:model OpenInterval
func (*OpenInterval) ContextValidate ¶
ContextValidate validate this open interval based on the context it is used
func (*OpenInterval) MarshalBinary ¶
func (m *OpenInterval) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OpenInterval) UnmarshalBinary ¶
func (m *OpenInterval) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OpenTimeInterval ¶
type OpenTimeInterval struct { // The hour when the business opens or closes. Hour int64 `json:"Hour,omitempty"` // The minute when the business opens or closes. Minute int64 `json:"Minute,omitempty"` }
OpenTimeInterval The time when the business opens or closes.
swagger:model OpenTimeInterval
func (*OpenTimeInterval) ContextValidate ¶
ContextValidate validates this open time interval based on context it is used
func (*OpenTimeInterval) MarshalBinary ¶
func (m *OpenTimeInterval) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OpenTimeInterval) UnmarshalBinary ¶
func (m *OpenTimeInterval) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Order ¶
type Order struct { // An Amazon-defined order identifier, in 3-7-7 format. // Required: true AmazonOrderID *string `json:"AmazonOrderId"` // Contains information regarding the Shipping Settings Automaton program, such as whether the order's shipping settings were generated automatically, and what those settings are. AutomatedShippingSettings *AutomatedShippingSettings `json:"AutomatedShippingSettings,omitempty"` // Buyer information. // // **Note**: The `BuyerInfo` contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in `BuyerInfo`. For example, `BuyerName`, `BuyerTaxInfo`, and `PurchaseOrderNumber`. BuyerInfo *BuyerInfo `json:"BuyerInfo,omitempty"` // The buyer's invoicing preference. Sellers can use this data to issue electronic invoices for orders in Turkey. // // **Note**: This attribute is only available in the Turkey marketplace. // Enum: [INDIVIDUAL BUSINESS] BuyerInvoicePreference string `json:"BuyerInvoicePreference,omitempty"` // Contains the business invoice tax information. Sellers could use this data to issue electronic invoices for business orders in Turkey. // // **Note**: // 1. This attribute is only available in the Turkey marketplace for the orders that `BuyerInvoicePreference` is BUSINESS. // 2. The `BuyerTaxInformation` is a restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access this restricted data. BuyerTaxInformation *BuyerTaxInformation `json:"BuyerTaxInformation,omitempty"` // Custom ship label for Checkout by Amazon (CBA). CbaDisplayableShippingLabel string `json:"CbaDisplayableShippingLabel,omitempty"` // The recommended location for the seller to ship the items from. It is calculated at checkout. The seller may or may not choose to ship from this location. DefaultShipFromLocationAddress *Address `json:"DefaultShipFromLocationAddress,omitempty"` // The start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. EarliestDeliveryDate string `json:"EarliestDeliveryDate,omitempty"` // The start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. // // __Note__: `EarliestShipDate` might not be returned for orders placed before February 1, 2013. EarliestShipDate string `json:"EarliestShipDate,omitempty"` // The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders. EasyShipShipmentStatus EasyShipShipmentStatus `json:"EasyShipShipmentStatus,omitempty"` // The status of the electronic invoice. ElectronicInvoiceStatus ElectronicInvoiceStatus `json:"ElectronicInvoiceStatus,omitempty"` // Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`). // Enum: [MFN AFN] FulfillmentChannel string `json:"FulfillmentChannel,omitempty"` // Contains the instructions about the fulfillment, such as the location from where you want the order filled. FulfillmentInstruction *FulfillmentInstruction `json:"FulfillmentInstruction,omitempty"` // Whether the order contains regulated items which may require additional approval steps before being fulfilled. HasRegulatedItems bool `json:"HasRegulatedItems,omitempty"` // When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers. IsAccessPointOrder bool `json:"IsAccessPointOrder,omitempty"` // When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer. IsBusinessOrder bool `json:"IsBusinessOrder,omitempty"` // When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders. IsEstimatedShipDateSet bool `json:"IsEstimatedShipDateSet,omitempty"` // When true, the order is a `GlobalExpress` order. IsGlobalExpressEnabled bool `json:"IsGlobalExpressEnabled,omitempty"` // When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller. IsIBA bool `json:"IsIBA,omitempty"` // When true, this order is marked to be picked up from a store rather than delivered. IsISPU bool `json:"IsISPU,omitempty"` // When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to "Premium Shipping Options" in the Seller Central Help for your marketplace. IsPremiumOrder bool `json:"IsPremiumOrder,omitempty"` // When true, the order is a seller-fulfilled Amazon Prime order. IsPrime bool `json:"IsPrime,omitempty"` // When true, this is a replacement order. IsReplacementOrder bool `json:"IsReplacementOrder,omitempty"` // When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller. IsSoldByAB bool `json:"IsSoldByAB,omitempty"` // The date when the order was last updated. // // __Note__: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01. // Required: true LastUpdateDate *string `json:"LastUpdateDate"` // The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pending`, or `Canceled` status. LatestDeliveryDate string `json:"LatestDeliveryDate,omitempty"` // The end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders. // // __Note__: `LatestShipDate` might not be returned for orders placed before February 1, 2013. LatestShipDate string `json:"LatestShipDate,omitempty"` // The identifier for the marketplace where the order was placed. MarketplaceID string `json:"MarketplaceId,omitempty"` // Tax information about the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil. // // **Note**: This attribute is only available in the Brazil marketplace for the orders with `Pending` or `Unshipped` status. MarketplaceTaxInfo *MarketplaceTaxInfo `json:"MarketplaceTaxInfo,omitempty"` // The number of items shipped. NumberOfItemsShipped int64 `json:"NumberOfItemsShipped,omitempty"` // The number of items unshipped. NumberOfItemsUnshipped int64 `json:"NumberOfItemsUnshipped,omitempty"` // The order channel for the first item in the order. OrderChannel string `json:"OrderChannel,omitempty"` // The current order status. // Required: true // Enum: [Pending Unshipped PartiallyShipped Shipped Canceled Unfulfillable InvoiceUnconfirmed PendingAvailability] OrderStatus *string `json:"OrderStatus"` // The total charge for this order. OrderTotal *Money `json:"OrderTotal,omitempty"` // The order's type. // Enum: [StandardOrder LongLeadTimeOrder Preorder BackOrder SourcingOnDemandOrder] OrderType string `json:"OrderType,omitempty"` // Information about sub-payment methods for a cash-on-delivery (COD) order. // // __Note__: For a COD order that is paid for using one sub-payment method, one `PaymentExecutionDetailItem` object is returned, with `PaymentExecutionDetailItem`/`PaymentMethod = COD`. For a COD order that is paid for using multiple sub-payment methods, two or more `PaymentExecutionDetailItem` objects are returned. PaymentExecutionDetail PaymentExecutionDetailItemList `json:"PaymentExecutionDetail,omitempty"` // The payment method for the order. This property is limited to COD and CVS payment methods. Unless you need the specific COD payment information provided by the `PaymentExecutionDetailItem` object, we recommend using the `PaymentMethodDetails` property to get payment method information. // Enum: [COD CVS Other] PaymentMethod string `json:"PaymentMethod,omitempty"` // A list of payment methods for the order. PaymentMethodDetails PaymentMethodDetailItemList `json:"PaymentMethodDetails,omitempty"` // Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders. PromiseResponseDueDate string `json:"PromiseResponseDueDate,omitempty"` // The date when the order was created. // Required: true PurchaseDate *string `json:"PurchaseDate"` // The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true. ReplacedOrderID string `json:"ReplacedOrderId,omitempty"` // The sales channel for the first item in the order. SalesChannel string `json:"SalesChannel,omitempty"` // The seller’s friendly name registered in the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil. // // **Note**: This attribute is only available in the Brazil marketplace for the orders with `Pending` or `Unshipped` status. SellerDisplayName string `json:"SellerDisplayName,omitempty"` // A seller-defined order identifier. SellerOrderID string `json:"SellerOrderId,omitempty"` // The order's shipment service level. ShipServiceLevel string `json:"ShipServiceLevel,omitempty"` // The shipment service level category for the order. // // **Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`. ShipmentServiceLevelCategory string `json:"ShipmentServiceLevelCategory,omitempty"` // The shipping address for the order. // // **Note**: // 1. `ShippingAddress` is only available for orders with the following status values: Unshipped, `PartiallyShipped`, Shipped and `InvoiceUnconfirmed`. // 2. The `ShippingAddress` contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in `ShippingAddress`. For example, `Name`, `AddressLine1`, `AddressLine2`, `AddressLine3`, `Phone`, `AddressType`, and `ExtendedFields`. ShippingAddress *Address `json:"ShippingAddress,omitempty"` }
Order Order information.
swagger:model Order
func (*Order) ContextValidate ¶
ContextValidate validate this order based on the context it is used
func (*Order) MarshalBinary ¶
MarshalBinary interface implementation
func (*Order) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type OrderAddress ¶
type OrderAddress struct { // An Amazon-defined order identifier, in 3-7-7 format. // Required: true AmazonOrderID *string `json:"AmazonOrderId"` // The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities. BuyerCompanyName string `json:"BuyerCompanyName,omitempty"` // delivery preferences DeliveryPreferences *DeliveryPreferences `json:"DeliveryPreferences,omitempty"` // The shipping address for the order. // // **Note**: `ShippingAddress` is only available for orders with the following status values: `Unshipped`, `PartiallyShipped`, `Shipped`, and `InvoiceUnconfirmed`. ShippingAddress *Address `json:"ShippingAddress,omitempty"` }
OrderAddress The shipping address for the order.
swagger:model OrderAddress
func (*OrderAddress) ContextValidate ¶
ContextValidate validate this order address based on the context it is used
func (*OrderAddress) MarshalBinary ¶
func (m *OrderAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderAddress) UnmarshalBinary ¶
func (m *OrderAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OrderBuyerInfo ¶
type OrderBuyerInfo struct { // An Amazon-defined order identifier, in 3-7-7 format. // Required: true AmazonOrderID *string `json:"AmazonOrderId"` // The county of the buyer. // // **Note**: This attribute is only available in the Brazil marketplace. BuyerCounty string `json:"BuyerCounty,omitempty"` // The anonymized email address of the buyer. BuyerEmail string `json:"BuyerEmail,omitempty"` // The buyer name or the recipient name. BuyerName string `json:"BuyerName,omitempty"` // Tax information about the buyer. Sellers can use this data to issue electronic invoices for business orders. // // **Note**: This attribute is only available for business orders in the Brazil, Mexico and India marketplaces. BuyerTaxInfo *BuyerTaxInfo `json:"BuyerTaxInfo,omitempty"` // The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout. PurchaseOrderNumber string `json:"PurchaseOrderNumber,omitempty"` }
OrderBuyerInfo Buyer information for an order.
swagger:model OrderBuyerInfo
func (*OrderBuyerInfo) ContextValidate ¶
ContextValidate validate this order buyer info based on the context it is used
func (*OrderBuyerInfo) MarshalBinary ¶
func (m *OrderBuyerInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderBuyerInfo) UnmarshalBinary ¶
func (m *OrderBuyerInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OrderItem ¶
type OrderItem struct { // The item's Amazon Standard Identification Number (ASIN). // Required: true ASIN *string `json:"ASIN"` // Contains the list of programs that are associated with an item. AmazonPrograms *AmazonPrograms `json:"AmazonPrograms,omitempty"` // A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires. AssociatedItems []*AssociatedItem `json:"AssociatedItems"` // A single item's buyer information. // // **Note**: The `BuyerInfo` contains restricted data. Use the Restricted Data Token (RDT) and restricted SPDS roles to access the restricted data in `BuyerInfo`. For example, `BuyerCustomizedInfo` and `GiftMessageText`. BuyerInfo *ItemBuyerInfo `json:"BuyerInfo,omitempty"` // Information about whether or not a buyer requested cancellation. BuyerRequestedCancel *BuyerRequestedCancel `json:"BuyerRequestedCancel,omitempty"` // The fee charged for COD service. CODFee *Money `json:"CODFee,omitempty"` // The discount on the COD fee. CODFeeDiscount *Money `json:"CODFeeDiscount,omitempty"` // The condition of the item. // // **Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`. ConditionID string `json:"ConditionId,omitempty"` // The condition of the item, as described by the seller. ConditionNote string `json:"ConditionNote,omitempty"` // The subcondition of the item. // // **Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, and `Other`. ConditionSubtypeID string `json:"ConditionSubtypeId,omitempty"` // The category of deemed reseller. This applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK. // Enum: [IOSS UOSS] DeemedResellerCategory string `json:"DeemedResellerCategory,omitempty"` // The IOSS number of the marketplace. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale. IossNumber string `json:"IossNumber,omitempty"` // Indicates whether the item is a gift. // // **Possible values**: `true` and `false`. IsGift string `json:"IsGift,omitempty"` // When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by: // // **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 is 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. IsTransparency bool `json:"IsTransparency,omitempty"` // The selling price of the order item. Note that an order item is an item and a quantity. This means that the value of `ItemPrice` is equal to the selling price of the item multiplied by the quantity ordered. `ItemPrice` excludes `ShippingPrice` and GiftWrapPrice. ItemPrice *Money `json:"ItemPrice,omitempty"` // The tax on the item price. ItemTax *Money `json:"ItemTax,omitempty"` // Measurement information for the order item. Measurement *Measurement `json:"Measurement,omitempty"` // An Amazon-defined order item identifier. // Required: true OrderItemID *string `json:"OrderItemId"` // The number and value of Amazon Points granted with the purchase of an item. PointsGranted *PointsGrantedDetail `json:"PointsGranted,omitempty"` // Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). // // **Possible values**: `BusinessPrice` PriceDesignation string `json:"PriceDesignation,omitempty"` // The item's product information. ProductInfo *ProductInfoDetail `json:"ProductInfo,omitempty"` // The total of all promotional discounts in the offer. PromotionDiscount *Money `json:"PromotionDiscount,omitempty"` // The tax on the total of all promotional discounts in the offer. PromotionDiscountTax *Money `json:"PromotionDiscountTax,omitempty"` // promotion ids PromotionIds PromotionIDList `json:"PromotionIds,omitempty"` // The number of items in the order. // Required: true QuantityOrdered *int64 `json:"QuantityOrdered"` // The number of items shipped. QuantityShipped int64 `json:"QuantityShipped,omitempty"` // The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. ScheduledDeliveryEndDate string `json:"ScheduledDeliveryEndDate,omitempty"` // The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. ScheduledDeliveryStartDate string `json:"ScheduledDeliveryStartDate,omitempty"` // The item's seller stock keeping unit (SKU). SellerSKU string `json:"SellerSKU,omitempty"` // When true, the product type for this item has a serial number. // // Only returned for Amazon Easy Ship orders. SerialNumberRequired bool `json:"SerialNumberRequired,omitempty"` // A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only. SerialNumbers []string `json:"SerialNumbers"` // Shipping constraints applicable to this order. ShippingConstraints *ShippingConstraints `json:"ShippingConstraints,omitempty"` // The discount on the shipping price. ShippingDiscount *Money `json:"ShippingDiscount,omitempty"` // The tax on the discount on the shipping price. ShippingDiscountTax *Money `json:"ShippingDiscountTax,omitempty"` // The item's shipping price. ShippingPrice *Money `json:"ShippingPrice,omitempty"` // The tax on the shipping price. ShippingTax *Money `json:"ShippingTax,omitempty"` // The store chain store identifier. Linked to a specific store in a store chain. StoreChainStoreID string `json:"StoreChainStoreId,omitempty"` // Substitution preferences for the order item. This is an optional field that is only present if a seller supports substitutions, as is the case with some grocery sellers. SubstitutionPreferences *SubstitutionPreferences `json:"SubstitutionPreferences,omitempty"` // Information about withheld taxes. TaxCollection *TaxCollection `json:"TaxCollection,omitempty"` // The item's name. Title string `json:"Title,omitempty"` }
OrderItem A single order item.
swagger:model OrderItem
func (*OrderItem) ContextValidate ¶
ContextValidate validate this order item based on the context it is used
func (*OrderItem) MarshalBinary ¶
MarshalBinary interface implementation
func (*OrderItem) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type OrderItemBuyerInfo ¶
type OrderItemBuyerInfo struct { // Buyer information for custom orders from the Amazon Custom program. // // **Note**: This attribute is only available for MFN (fulfilled by seller) orders. BuyerCustomizedInfo *BuyerCustomizedInfoDetail `json:"BuyerCustomizedInfo,omitempty"` // A gift message provided by the buyer. // // **Note**: This attribute is only available for MFN (fulfilled by seller) orders. GiftMessageText string `json:"GiftMessageText,omitempty"` // The gift wrap level specified by the buyer. GiftWrapLevel string `json:"GiftWrapLevel,omitempty"` // The gift wrap price of the item. GiftWrapPrice *Money `json:"GiftWrapPrice,omitempty"` // The tax on the gift wrap price. GiftWrapTax *Money `json:"GiftWrapTax,omitempty"` // An Amazon-defined order item identifier. // Required: true OrderItemID *string `json:"OrderItemId"` }
OrderItemBuyerInfo A single order item's buyer information.
swagger:model OrderItemBuyerInfo
func (*OrderItemBuyerInfo) ContextValidate ¶
ContextValidate validate this order item buyer info based on the context it is used
func (*OrderItemBuyerInfo) MarshalBinary ¶
func (m *OrderItemBuyerInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderItemBuyerInfo) UnmarshalBinary ¶
func (m *OrderItemBuyerInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OrderItemBuyerInfoList ¶
type OrderItemBuyerInfoList []*OrderItemBuyerInfo
OrderItemBuyerInfoList A single order item's buyer information list.
swagger:model OrderItemBuyerInfoList
func (OrderItemBuyerInfoList) ContextValidate ¶
ContextValidate validate this order item buyer info list based on the context it is used
type OrderItemList ¶
type OrderItemList []*OrderItem
OrderItemList A list of order items.
swagger:model OrderItemList
func (OrderItemList) ContextValidate ¶
ContextValidate validate this order item list based on the context it is used
type OrderItems ¶
type OrderItems []*OrderItemsItems0
OrderItems For partial shipment status updates, the list of order items and quantities to be updated.
swagger:model OrderItems
func (OrderItems) ContextValidate ¶
ContextValidate validate this order items based on the context it is used
type OrderItemsBuyerInfoList ¶
type OrderItemsBuyerInfoList struct { // An Amazon-defined order identifier, in 3-7-7 format. // Required: true AmazonOrderID *string `json:"AmazonOrderId"` // When present and not empty, pass this string token in the next request to return the next response page. NextToken string `json:"NextToken,omitempty"` // order items // Required: true OrderItems OrderItemBuyerInfoList `json:"OrderItems"` }
OrderItemsBuyerInfoList A single order item's buyer information list with the order ID.
swagger:model OrderItemsBuyerInfoList
func (*OrderItemsBuyerInfoList) ContextValidate ¶
func (m *OrderItemsBuyerInfoList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this order items buyer info list based on the context it is used
func (*OrderItemsBuyerInfoList) MarshalBinary ¶
func (m *OrderItemsBuyerInfoList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderItemsBuyerInfoList) UnmarshalBinary ¶
func (m *OrderItemsBuyerInfoList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OrderItemsItems0 ¶
type OrderItemsItems0 struct { // The order item's unique identifier. OrderItemID string `json:"orderItemId,omitempty"` // The quantity for which to update the shipment status. Quantity int64 `json:"quantity,omitempty"` }
OrderItemsItems0 order items items0
swagger:model OrderItemsItems0
func (*OrderItemsItems0) ContextValidate ¶
ContextValidate validates this order items items0 based on context it is used
func (*OrderItemsItems0) MarshalBinary ¶
func (m *OrderItemsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderItemsItems0) UnmarshalBinary ¶
func (m *OrderItemsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OrderItemsList ¶
type OrderItemsList struct { // An Amazon-defined order identifier, in 3-7-7 format. // Required: true AmazonOrderID *string `json:"AmazonOrderId"` // When present and not empty, pass this string token in the next request to return the next response page. NextToken string `json:"NextToken,omitempty"` // order items // Required: true OrderItems OrderItemList `json:"OrderItems"` }
OrderItemsList The order items list along with the order ID.
swagger:model OrderItemsList
func (*OrderItemsList) ContextValidate ¶
ContextValidate validate this order items list based on the context it is used
func (*OrderItemsList) MarshalBinary ¶
func (m *OrderItemsList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderItemsList) UnmarshalBinary ¶
func (m *OrderItemsList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OrderList ¶
type OrderList []*Order
OrderList A list of orders.
swagger:model OrderList
func (OrderList) ContextValidate ¶
ContextValidate validate this order list based on the context it is used
type OrderRegulatedInfo ¶
type OrderRegulatedInfo struct { // An Amazon-defined order identifier, in 3-7-7 format. // Required: true AmazonOrderID *string `json:"AmazonOrderId"` // The regulated information collected during purchase and used to verify the order. // Required: true RegulatedInformation *RegulatedInformation `json:"RegulatedInformation"` // The order's verification status. // Required: true RegulatedOrderVerificationStatus *RegulatedOrderVerificationStatus `json:"RegulatedOrderVerificationStatus"` // When true, the order requires attaching a dosage information label when shipped. // Required: true RequiresDosageLabel *bool `json:"RequiresDosageLabel"` }
OrderRegulatedInfo The order's regulated information along with its verification status.
swagger:model OrderRegulatedInfo
func (*OrderRegulatedInfo) ContextValidate ¶
ContextValidate validate this order regulated info based on the context it is used
func (*OrderRegulatedInfo) MarshalBinary ¶
func (m *OrderRegulatedInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderRegulatedInfo) UnmarshalBinary ¶
func (m *OrderRegulatedInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OrdersList ¶
type OrdersList struct { // Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. CreatedBefore string `json:"CreatedBefore,omitempty"` // Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. All dates must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. LastUpdatedBefore string `json:"LastUpdatedBefore,omitempty"` // When present and not empty, pass this string token in the next request to return the next response page. NextToken string `json:"NextToken,omitempty"` // orders // Required: true Orders OrderList `json:"Orders"` }
OrdersList A list of orders along with additional information to make subsequent API calls.
swagger:model OrdersList
func (*OrdersList) ContextValidate ¶
ContextValidate validate this orders list based on the context it is used
func (*OrdersList) MarshalBinary ¶
func (m *OrdersList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrdersList) UnmarshalBinary ¶
func (m *OrdersList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OtherDeliveryAttributes ¶
type OtherDeliveryAttributes string
OtherDeliveryAttributes Miscellaneous delivery attributes associated with the shipping address.
swagger:model OtherDeliveryAttributes
const ( // OtherDeliveryAttributesHASACCESSPOINT captures enum value "HAS_ACCESS_POINT" OtherDeliveryAttributesHASACCESSPOINT OtherDeliveryAttributes = "HAS_ACCESS_POINT" // OtherDeliveryAttributesPALLETENABLED captures enum value "PALLET_ENABLED" OtherDeliveryAttributesPALLETENABLED OtherDeliveryAttributes = "PALLET_ENABLED" // OtherDeliveryAttributesPALLETDISABLED captures enum value "PALLET_DISABLED" OtherDeliveryAttributesPALLETDISABLED OtherDeliveryAttributes = "PALLET_DISABLED" )
func NewOtherDeliveryAttributes ¶
func NewOtherDeliveryAttributes(value OtherDeliveryAttributes) *OtherDeliveryAttributes
func (OtherDeliveryAttributes) ContextValidate ¶
func (m OtherDeliveryAttributes) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this other delivery attributes based on context it is used
func (OtherDeliveryAttributes) Pointer ¶
func (m OtherDeliveryAttributes) Pointer() *OtherDeliveryAttributes
Pointer returns a pointer to a freshly-allocated OtherDeliveryAttributes.
type PackageDetail ¶
type PackageDetail struct { // Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the [`CarrierCode` announcement](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces). // Required: true CarrierCode *string `json:"carrierCode"` // Carrier Name that will deliver the package. Required when `carrierCode` is "Others" CarrierName string `json:"carrierName,omitempty"` // The list of order items and quantities to be updated. // Required: true OrderItems ConfirmShipmentOrderItemsList `json:"orderItems"` // package reference Id // Required: true PackageReferenceID *PackageReferenceID `json:"packageReferenceId"` // The shipping date for the package. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format. // Required: true // Format: date-time ShipDate *strfmt.DateTime `json:"shipDate"` // The unique identifier for the supply source. ShipFromSupplySourceID string `json:"shipFromSupplySourceId,omitempty"` // Ship method to be used for shipping the order. ShippingMethod string `json:"shippingMethod,omitempty"` // The tracking number used to obtain tracking and delivery information. // Required: true TrackingNumber *string `json:"trackingNumber"` }
PackageDetail Properties of packages
swagger:model PackageDetail
func (*PackageDetail) ContextValidate ¶
ContextValidate validate this package detail based on the context it is used
func (*PackageDetail) MarshalBinary ¶
func (m *PackageDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PackageDetail) UnmarshalBinary ¶
func (m *PackageDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PackageReferenceID ¶
type PackageReferenceID string
PackageReferenceID A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported.
swagger:model PackageReferenceId
func (PackageReferenceID) ContextValidate ¶
ContextValidate validates this package reference Id based on context it is used
type PaymentExecutionDetailItem ¶
type PaymentExecutionDetailItem struct { // payment // Required: true Payment *Money `json:"Payment"` // A sub-payment method for a COD order. // // **Possible values**: // * `COD`: Cash on delivery // * `GC`: Gift card // * `PointsAccount`: Amazon Points // * `Invoice`: Invoice // Required: true PaymentMethod *string `json:"PaymentMethod"` }
PaymentExecutionDetailItem Information about a sub-payment method used to pay for a COD order.
swagger:model PaymentExecutionDetailItem
func (*PaymentExecutionDetailItem) ContextValidate ¶
func (m *PaymentExecutionDetailItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this payment execution detail item based on the context it is used
func (*PaymentExecutionDetailItem) MarshalBinary ¶
func (m *PaymentExecutionDetailItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaymentExecutionDetailItem) UnmarshalBinary ¶
func (m *PaymentExecutionDetailItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PaymentExecutionDetailItemList ¶
type PaymentExecutionDetailItemList []*PaymentExecutionDetailItem
PaymentExecutionDetailItemList A list of payment execution detail items.
swagger:model PaymentExecutionDetailItemList
func (PaymentExecutionDetailItemList) ContextValidate ¶
func (m PaymentExecutionDetailItemList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this payment execution detail item list based on the context it is used
type PaymentMethodDetailItemList ¶
type PaymentMethodDetailItemList []string
PaymentMethodDetailItemList A list of payment method detail items.
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
type PointsGrantedDetail ¶
type PointsGrantedDetail struct { // The monetary value of the Amazon Points granted. PointsMonetaryValue *Money `json:"PointsMonetaryValue,omitempty"` // The number of Amazon Points granted with the purchase of an item. PointsNumber int64 `json:"PointsNumber,omitempty"` }
PointsGrantedDetail The number of Amazon Points offered with the purchase of an item, and their monetary value.
swagger:model PointsGrantedDetail
func (*PointsGrantedDetail) ContextValidate ¶
ContextValidate validate this points granted detail based on the context it is used
func (*PointsGrantedDetail) MarshalBinary ¶
func (m *PointsGrantedDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PointsGrantedDetail) UnmarshalBinary ¶
func (m *PointsGrantedDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PreferredDeliveryTime ¶
type PreferredDeliveryTime struct { // Business hours when the business is open for deliveries. BusinessHours []*BusinessHours `json:"BusinessHours"` // Dates when the business is closed during the next 30 days. ExceptionDates []*ExceptionDates `json:"ExceptionDates"` }
PreferredDeliveryTime The time window when the delivery is preferred.
swagger:model PreferredDeliveryTime
func (*PreferredDeliveryTime) ContextValidate ¶
ContextValidate validate this preferred delivery time based on the context it is used
func (*PreferredDeliveryTime) MarshalBinary ¶
func (m *PreferredDeliveryTime) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PreferredDeliveryTime) UnmarshalBinary ¶
func (m *PreferredDeliveryTime) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PrescriptionDetail ¶ added in v0.24.10
type PrescriptionDetail struct { // The identifier for the clinic which provided the prescription used to verify the regulated product. // Required: true ClinicID *string `json:"clinicId"` // The expiration date of the prescription used to verify the regulated product, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. // Required: true // Format: date-time ExpirationDate *strfmt.DateTime `json:"expirationDate"` // The identifier for the prescription used to verify the regulated product. // Required: true PrescriptionID *string `json:"prescriptionId"` // The number of refills remaining for the prescription used to verify the regulated product. If a prescription originally had 10 total refills, this value must be `10` for the first order, `9` for the second order, and `0` for the eleventh order. If a prescription originally had no refills, this value must be 0. // Required: true // Minimum: 0 RefillsRemaining *int64 `json:"refillsRemaining"` // The total number of refills written in the original prescription used to verify the regulated product. If a prescription originally had no refills, this value must be 0. // Required: true // Minimum: 0 TotalRefillsAuthorized *int64 `json:"totalRefillsAuthorized"` // The instructions for the prescription as provided by the approver of the regulated product. // Required: true UsageInstructions *string `json:"usageInstructions"` // The number of units in each fill as provided in the prescription. // Required: true // Minimum: 1 WrittenQuantity *int64 `json:"writtenQuantity"` }
PrescriptionDetail Information about the prescription that is used to verify a regulated product. This must be provided once per order and reflect the seller’s own records. Only approved orders can have prescriptions.
swagger:model PrescriptionDetail
func (*PrescriptionDetail) ContextValidate ¶ added in v0.24.10
ContextValidate validates this prescription detail based on context it is used
func (*PrescriptionDetail) MarshalBinary ¶ added in v0.24.10
func (m *PrescriptionDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PrescriptionDetail) UnmarshalBinary ¶ added in v0.24.10
func (m *PrescriptionDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductInfoDetail ¶
type ProductInfoDetail struct { // The total number of items that are included in the ASIN. NumberOfItems string `json:"NumberOfItems,omitempty"` }
ProductInfoDetail Product information on the number of items.
swagger:model ProductInfoDetail
func (*ProductInfoDetail) ContextValidate ¶
ContextValidate validates this product info detail based on context it is used
func (*ProductInfoDetail) MarshalBinary ¶
func (m *ProductInfoDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductInfoDetail) UnmarshalBinary ¶
func (m *ProductInfoDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PromotionIDList ¶
type PromotionIDList []string
PromotionIDList A list of promotion identifiers provided by the seller when the promotions were created.
swagger:model PromotionIdList
func (PromotionIDList) ContextValidate ¶
ContextValidate validates this promotion Id list based on context it is used
type RegulatedInformation ¶
type RegulatedInformation struct { // A list of regulated information fields as collected from the regulatory form. // Required: true Fields []*RegulatedInformationField `json:"Fields"` }
RegulatedInformation The regulated information collected during purchase and used to verify the order.
swagger:model RegulatedInformation
func (*RegulatedInformation) ContextValidate ¶
ContextValidate validate this regulated information based on the context it is used
func (*RegulatedInformation) MarshalBinary ¶
func (m *RegulatedInformation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RegulatedInformation) UnmarshalBinary ¶
func (m *RegulatedInformation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RegulatedInformationField ¶
type RegulatedInformationField struct { // The unique identifier of the field. // Required: true FieldID *string `json:"FieldId"` // The name of the field. // Required: true FieldLabel *string `json:"FieldLabel"` // The type of field. // Required: true // Enum: [Text FileAttachment] FieldType *string `json:"FieldType"` // The content of the field as collected in regulatory form. Note that `FileAttachment` type fields contain a URL where you can download the attachment. // Required: true FieldValue *string `json:"FieldValue"` }
RegulatedInformationField A field collected from the regulatory form.
swagger:model RegulatedInformationField
func (*RegulatedInformationField) ContextValidate ¶
func (m *RegulatedInformationField) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this regulated information field based on context it is used
func (*RegulatedInformationField) MarshalBinary ¶
func (m *RegulatedInformationField) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RegulatedInformationField) UnmarshalBinary ¶
func (m *RegulatedInformationField) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RegulatedOrderVerificationStatus ¶
type RegulatedOrderVerificationStatus struct { // The identifier for the order's regulated information reviewer. ExternalReviewerID string `json:"ExternalReviewerId,omitempty"` // The reason for rejecting the order's regulated information. Not present if the order isn't rejected. RejectionReason *RejectionReason `json:"RejectionReason,omitempty"` // When true, the regulated information provided in the order requires a review by the merchant. // Required: true RequiresMerchantAction *bool `json:"RequiresMerchantAction"` // The date the order was reviewed. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. ReviewDate string `json:"ReviewDate,omitempty"` // The verification status of the order. // Required: true Status *VerificationStatus `json:"Status"` // A list of valid rejection reasons that may be used to reject the order's regulated information. // Required: true ValidRejectionReasons []*RejectionReason `json:"ValidRejectionReasons"` // A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided. ValidVerificationDetails []*ValidVerificationDetail `json:"ValidVerificationDetails"` }
RegulatedOrderVerificationStatus The verification status of the order, along with associated approval or rejection metadata.
swagger:model RegulatedOrderVerificationStatus
func (*RegulatedOrderVerificationStatus) ContextValidate ¶
func (m *RegulatedOrderVerificationStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this regulated order verification status based on the context it is used
func (*RegulatedOrderVerificationStatus) MarshalBinary ¶
func (m *RegulatedOrderVerificationStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RegulatedOrderVerificationStatus) UnmarshalBinary ¶
func (m *RegulatedOrderVerificationStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RejectionReason ¶
type RejectionReason struct { // The description of this rejection reason. // Required: true RejectionReasonDescription *string `json:"RejectionReasonDescription"` // The unique identifier for the rejection reason. // Required: true RejectionReasonID *string `json:"RejectionReasonId"` }
RejectionReason The reason for rejecting the order's regulated information. This is only present if the order is rejected.
swagger:model RejectionReason
func (*RejectionReason) ContextValidate ¶
ContextValidate validates this rejection reason based on context it is used
func (*RejectionReason) MarshalBinary ¶
func (m *RejectionReason) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RejectionReason) UnmarshalBinary ¶
func (m *RejectionReason) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ShipmentStatus ¶
type ShipmentStatus string
ShipmentStatus The shipment status to apply.
swagger:model ShipmentStatus
const ( // ShipmentStatusReadyForPickup captures enum value "ReadyForPickup" ShipmentStatusReadyForPickup ShipmentStatus = "ReadyForPickup" // ShipmentStatusPickedUp captures enum value "PickedUp" ShipmentStatusPickedUp ShipmentStatus = "PickedUp" // ShipmentStatusRefusedPickup captures enum value "RefusedPickup" ShipmentStatusRefusedPickup ShipmentStatus = "RefusedPickup" )
func NewShipmentStatus ¶
func NewShipmentStatus(value ShipmentStatus) *ShipmentStatus
func (ShipmentStatus) ContextValidate ¶
ContextValidate validates this shipment status based on context it is used
func (ShipmentStatus) Pointer ¶
func (m ShipmentStatus) Pointer() *ShipmentStatus
Pointer returns a pointer to a freshly-allocated ShipmentStatus.
type ShippingConstraints ¶ added in v0.24.10
type ShippingConstraints struct { // Indicates if the line item needs to be delivered by pallet. PalletDelivery ConstraintType `json:"PalletDelivery,omitempty"` // Indicates that the carrier must confirm the recipient is of the legal age to receive the line item upon delivery. RecipientAgeVerification ConstraintType `json:"RecipientAgeVerification,omitempty"` // Indicates that the person receiving the line item must be the same as the intended recipient of the order. RecipientIdentityVerification ConstraintType `json:"RecipientIdentityVerification,omitempty"` // Indicates that the recipient of the line item must sign to confirm its delivery. SignatureConfirmation ConstraintType `json:"SignatureConfirmation,omitempty"` }
ShippingConstraints Delivery constraints applicable to this order.
swagger:model ShippingConstraints
func (*ShippingConstraints) ContextValidate ¶ added in v0.24.10
ContextValidate validate this shipping constraints based on the context it is used
func (*ShippingConstraints) MarshalBinary ¶ added in v0.24.10
func (m *ShippingConstraints) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ShippingConstraints) UnmarshalBinary ¶ added in v0.24.10
func (m *ShippingConstraints) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SubstitutionOption ¶ added in v0.3.0
type SubstitutionOption struct { // The item's Amazon Standard Identification Number (ASIN). ASIN string `json:"ASIN,omitempty"` // Measurement information for the substitution option. Measurement *Measurement `json:"Measurement,omitempty"` // The number of items to be picked for this substitution option. QuantityOrdered int64 `json:"QuantityOrdered,omitempty"` // The item's seller stock keeping unit (SKU). SellerSKU string `json:"SellerSKU,omitempty"` // The item's title. Title string `json:"Title,omitempty"` }
SubstitutionOption Substitution options for an order item.
swagger:model SubstitutionOption
func (*SubstitutionOption) ContextValidate ¶ added in v0.3.0
ContextValidate validate this substitution option based on the context it is used
func (*SubstitutionOption) MarshalBinary ¶ added in v0.3.0
func (m *SubstitutionOption) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SubstitutionOption) UnmarshalBinary ¶ added in v0.3.0
func (m *SubstitutionOption) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SubstitutionOptionList ¶ added in v0.3.0
type SubstitutionOptionList []*SubstitutionOption
SubstitutionOptionList A collection of substitution options.
swagger:model SubstitutionOptionList
func (SubstitutionOptionList) ContextValidate ¶ added in v0.3.0
ContextValidate validate this substitution option list based on the context it is used
type SubstitutionPreferences ¶ added in v0.3.0
type SubstitutionPreferences struct { // Substitution options for the order item. SubstitutionOptions SubstitutionOptionList `json:"SubstitutionOptions,omitempty"` // The type of substitution that these preferences represent. // Required: true // Enum: [CUSTOMER_PREFERENCE AMAZON_RECOMMENDED DO_NOT_SUBSTITUTE] SubstitutionType *string `json:"SubstitutionType"` }
SubstitutionPreferences Substitution preferences for an order item.
swagger:model SubstitutionPreferences
func (*SubstitutionPreferences) ContextValidate ¶ added in v0.3.0
func (m *SubstitutionPreferences) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this substitution preferences based on the context it is used
func (*SubstitutionPreferences) MarshalBinary ¶ added in v0.3.0
func (m *SubstitutionPreferences) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SubstitutionPreferences) UnmarshalBinary ¶ added in v0.3.0
func (m *SubstitutionPreferences) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaxClassification ¶
type TaxClassification struct { // The type of tax. Name string `json:"Name,omitempty"` // The buyer's tax identifier. Value string `json:"Value,omitempty"` }
TaxClassification The tax classification of the order.
swagger:model TaxClassification
func (*TaxClassification) ContextValidate ¶
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
type TaxCollection ¶
type TaxCollection struct { // The tax collection model applied to the item. // Enum: [MarketplaceFacilitator] Model string `json:"Model,omitempty"` // The party responsible for withholding the taxes and remitting them to the taxing authority. // Enum: [Amazon Services, Inc.] ResponsibleParty string `json:"ResponsibleParty,omitempty"` }
TaxCollection Information about withheld taxes.
swagger:model TaxCollection
func (*TaxCollection) ContextValidate ¶
ContextValidate validates this tax collection based on context it is used
func (*TaxCollection) MarshalBinary ¶
func (m *TaxCollection) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaxCollection) UnmarshalBinary ¶
func (m *TaxCollection) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransparencyCode ¶
type TransparencyCode string
TransparencyCode The transparency code associated with the item.
swagger:model TransparencyCode
func (TransparencyCode) ContextValidate ¶
ContextValidate validates this transparency code based on context it is used
type TransparencyCodeList ¶
type TransparencyCodeList []TransparencyCode
TransparencyCodeList A list of order items.
swagger:model TransparencyCodeList
func (TransparencyCodeList) ContextValidate ¶
ContextValidate validate this transparency code list based on the context it is used
type UpdateShipmentStatusErrorResponse ¶
type UpdateShipmentStatusErrorResponse struct { // One or more unexpected errors occurred during the `UpdateShipmentStatus` operation. Errors ErrorList `json:"errors,omitempty"` }
UpdateShipmentStatusErrorResponse The error response schema for the `UpdateShipmentStatus` operation.
swagger:model UpdateShipmentStatusErrorResponse
func (*UpdateShipmentStatusErrorResponse) ContextValidate ¶
func (m *UpdateShipmentStatusErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this update shipment status error response based on the context it is used
func (*UpdateShipmentStatusErrorResponse) MarshalBinary ¶
func (m *UpdateShipmentStatusErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateShipmentStatusErrorResponse) UnmarshalBinary ¶
func (m *UpdateShipmentStatusErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateShipmentStatusRequest ¶
type UpdateShipmentStatusRequest struct { // marketplace Id // Required: true MarketplaceID *MarketplaceID `json:"marketplaceId"` // order items OrderItems OrderItems `json:"orderItems,omitempty"` // shipment status // Required: true ShipmentStatus *ShipmentStatus `json:"shipmentStatus"` }
UpdateShipmentStatusRequest The request body for the `updateShipmentStatus` operation.
swagger:model UpdateShipmentStatusRequest
func (*UpdateShipmentStatusRequest) ContextValidate ¶
func (m *UpdateShipmentStatusRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this update shipment status request based on the context it is used
func (*UpdateShipmentStatusRequest) MarshalBinary ¶
func (m *UpdateShipmentStatusRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateShipmentStatusRequest) UnmarshalBinary ¶
func (m *UpdateShipmentStatusRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateVerificationStatusErrorResponse ¶
type UpdateVerificationStatusErrorResponse struct { // One or more unexpected errors occurred during the `UpdateVerificationStatus` operation. Errors ErrorList `json:"errors,omitempty"` }
UpdateVerificationStatusErrorResponse The error response schema for the `UpdateVerificationStatus` operation.
swagger:model UpdateVerificationStatusErrorResponse
func (*UpdateVerificationStatusErrorResponse) ContextValidate ¶
func (m *UpdateVerificationStatusErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this update verification status error response based on the context it is used
func (*UpdateVerificationStatusErrorResponse) MarshalBinary ¶
func (m *UpdateVerificationStatusErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateVerificationStatusErrorResponse) UnmarshalBinary ¶
func (m *UpdateVerificationStatusErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateVerificationStatusRequest ¶
type UpdateVerificationStatusRequest struct { // The updated values of the `VerificationStatus` field. // Required: true RegulatedOrderVerificationStatus *UpdateVerificationStatusRequestBody `json:"regulatedOrderVerificationStatus"` }
UpdateVerificationStatusRequest The request body for the `updateVerificationStatus` operation.
swagger:model UpdateVerificationStatusRequest
func (*UpdateVerificationStatusRequest) ContextValidate ¶
func (m *UpdateVerificationStatusRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this update verification status request based on the context it is used
func (*UpdateVerificationStatusRequest) MarshalBinary ¶
func (m *UpdateVerificationStatusRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateVerificationStatusRequest) UnmarshalBinary ¶
func (m *UpdateVerificationStatusRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateVerificationStatusRequestBody ¶
type UpdateVerificationStatusRequestBody struct { // The identifier of the order's regulated information reviewer. // Required: true ExternalReviewerID *string `json:"externalReviewerId"` // The unique identifier of the rejection reason used for rejecting the order's regulated information. Only required if the new status is rejected. RejectionReasonID string `json:"rejectionReasonId,omitempty"` // The new verification status of the order. Status VerificationStatus `json:"status,omitempty"` // Additional information regarding the verification of the order. VerificationDetails *VerificationDetails `json:"verificationDetails,omitempty"` }
UpdateVerificationStatusRequestBody The updated values of the `VerificationStatus` field.
swagger:model UpdateVerificationStatusRequestBody
func (*UpdateVerificationStatusRequestBody) ContextValidate ¶
func (m *UpdateVerificationStatusRequestBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this update verification status request body based on the context it is used
func (*UpdateVerificationStatusRequestBody) MarshalBinary ¶
func (m *UpdateVerificationStatusRequestBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateVerificationStatusRequestBody) UnmarshalBinary ¶
func (m *UpdateVerificationStatusRequestBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ValidVerificationDetail ¶ added in v0.24.10
type ValidVerificationDetail struct { // A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is ["Approved"], calls to provide the associated verification detail will fail for orders with a `VerificationStatus` of `Pending`, `Rejected`, `Expired`, or `Cancelled`. // Required: true ValidVerificationStatuses []VerificationStatus `json:"ValidVerificationStatuses"` // A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid value: `prescriptionDetail`. // Required: true VerificationDetailType *string `json:"VerificationDetailType"` }
ValidVerificationDetail The types of verification details that may be provided for the order and the criteria required for when the type of verification detail can be provided. The types of verification details allowed depend on the type of regulated product and will not change order to order.
swagger:model ValidVerificationDetail
func (*ValidVerificationDetail) ContextValidate ¶ added in v0.24.10
func (m *ValidVerificationDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this valid verification detail based on the context it is used
func (*ValidVerificationDetail) MarshalBinary ¶ added in v0.24.10
func (m *ValidVerificationDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ValidVerificationDetail) UnmarshalBinary ¶ added in v0.24.10
func (m *ValidVerificationDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VerificationDetails ¶ added in v0.24.10
type VerificationDetails struct { // Information regarding the prescription tied to the order. PrescriptionDetail *PrescriptionDetail `json:"prescriptionDetail,omitempty"` }
VerificationDetails Additional information related to the verification of a regulated order.
swagger:model VerificationDetails
func (*VerificationDetails) ContextValidate ¶ added in v0.24.10
ContextValidate validate this verification details based on the context it is used
func (*VerificationDetails) MarshalBinary ¶ added in v0.24.10
func (m *VerificationDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VerificationDetails) UnmarshalBinary ¶ added in v0.24.10
func (m *VerificationDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VerificationStatus ¶
type VerificationStatus string
VerificationStatus The verification status of the order.
swagger:model VerificationStatus
const ( // VerificationStatusPending captures enum value "Pending" VerificationStatusPending VerificationStatus = "Pending" // VerificationStatusApproved captures enum value "Approved" VerificationStatusApproved VerificationStatus = "Approved" // VerificationStatusRejected captures enum value "Rejected" VerificationStatusRejected VerificationStatus = "Rejected" // VerificationStatusExpired captures enum value "Expired" VerificationStatusExpired VerificationStatus = "Expired" // VerificationStatusCancelled captures enum value "Cancelled" VerificationStatusCancelled VerificationStatus = "Cancelled" )
func NewVerificationStatus ¶
func NewVerificationStatus(value VerificationStatus) *VerificationStatus
func (VerificationStatus) ContextValidate ¶
ContextValidate validates this verification status based on context it is used
func (VerificationStatus) Pointer ¶
func (m VerificationStatus) Pointer() *VerificationStatus
Pointer returns a pointer to a freshly-allocated VerificationStatus.
Source Files
¶
- address.go
- address_extended_fields.go
- amazon_programs.go
- associated_item.go
- association_type.go
- automated_shipping_settings.go
- business_hours.go
- buyer_customized_info_detail.go
- buyer_info.go
- buyer_requested_cancel.go
- buyer_tax_info.go
- buyer_tax_information.go
- confirm_shipment_error_response.go
- confirm_shipment_order_item.go
- confirm_shipment_order_items_list.go
- confirm_shipment_request.go
- constraint_type.go
- delivery_preferences.go
- easy_ship_shipment_status.go
- electronic_invoice_status.go
- error.go
- error_list.go
- exception_dates.go
- fulfillment_instruction.go
- get_order_address_response.go
- get_order_buyer_info_response.go
- get_order_items_buyer_info_response.go
- get_order_items_response.go
- get_order_regulated_info_response.go
- get_order_response.go
- get_orders_response.go
- item_buyer_info.go
- marketplace_id.go
- marketplace_tax_info.go
- measurement.go
- money.go
- open_interval.go
- open_time_interval.go
- order.go
- order_address.go
- order_buyer_info.go
- order_item.go
- order_item_buyer_info.go
- order_item_buyer_info_list.go
- order_item_list.go
- order_items.go
- order_items_buyer_info_list.go
- order_items_list.go
- order_list.go
- order_regulated_info.go
- orders_list.go
- other_delivery_attributes.go
- package_detail.go
- package_reference_id.go
- payment_execution_detail_item.go
- payment_execution_detail_item_list.go
- payment_method_detail_item_list.go
- points_granted_detail.go
- preferred_delivery_time.go
- prescription_detail.go
- product_info_detail.go
- promotion_id_list.go
- regulated_information.go
- regulated_information_field.go
- regulated_order_verification_status.go
- rejection_reason.go
- shipment_status.go
- shipping_constraints.go
- substitution_option.go
- substitution_option_list.go
- substitution_preferences.go
- tax_classification.go
- tax_collection.go
- transparency_code.go
- transparency_code_list.go
- update_shipment_status_error_response.go
- update_shipment_status_request.go
- update_verification_status_error_response.go
- update_verification_status_request.go
- update_verification_status_request_body.go
- valid_verification_detail.go
- verification_details.go
- verification_status.go