swagger

package

v0.0.0-...-c324a2f Latest Latest Go to latest Published: May 6, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/skeleton1231/amz-sp-api-gosdk

Links

Open Source Insights

README ¶

Go API client for swagger

The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: v0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://sellercentral.amazon.com/gp/mws/contactus.html

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://sellingpartnerapi-na.amazon.com/

Class	Method	HTTP request
ApprovalsApi	GetOrderItemsApprovals	Get /orders/v0/orders/{orderId}/approvals
ApprovalsApi	UpdateOrderItemsApprovals	Post /orders/v0/orders/{orderId}/approvals
OrdersV0Api	ConfirmShipment	Post /orders/v0/orders/{orderId}/shipmentConfirmation
OrdersV0Api	GetOrder	Get /orders/v0/orders/{orderId}
OrdersV0Api	GetOrderAddress	Get /orders/v0/orders/{orderId}/address
OrdersV0Api	GetOrderBuyerInfo	Get /orders/v0/orders/{orderId}/buyerInfo
OrdersV0Api	GetOrderItems	Get /orders/v0/orders/{orderId}/orderItems
OrdersV0Api	GetOrderItemsBuyerInfo	Get /orders/v0/orders/{orderId}/orderItems/buyerInfo
OrdersV0Api	GetOrderRegulatedInfo	Get /orders/v0/orders/{orderId}/regulatedInfo
OrdersV0Api	GetOrders	Get /orders/v0/orders
OrdersV0Api	UpdateVerificationStatus	Patch /orders/v0/orders/{orderId}/regulatedInfo
ShipmentApi	UpdateShipmentStatus	Post /orders/v0/orders/{orderId}/shipment

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for Orders * * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools. * * API version: v0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type Address
type ApprovalSupportDataElement
type ApprovalsApiGetOrderItemsApprovalsOpts
type ApprovalsApiService
- func (a *ApprovalsApiService) GetOrderItemsApprovals(ctx context.Context, orderId string, ...) (GetOrderApprovalsResponse, *http.Response, error)
- func (a *ApprovalsApiService) UpdateOrderItemsApprovals(ctx context.Context, body UpdateOrderApprovalsRequest, orderId string) (*http.Response, error)
type AutomatedShippingSettings
type BasicAuth
type BusinessHours
type BuyerCustomizedInfoDetail
type BuyerInfo
type BuyerRequestedCancel
type BuyerTaxInfo
type BuyerTaxInformation
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ConfirmShipmentErrorResponse
type ConfirmShipmentOrderItem
type ConfirmShipmentRequest
type DeliveryPreferences
type EasyShipShipmentStatus
type ElectronicInvoiceStatus
type ExceptionDates
type FulfillmentInstruction
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetOrderAddressResponse
type GetOrderApprovalsResponse
type GetOrderBuyerInfoResponse
type GetOrderItemsBuyerInfoResponse
type GetOrderItemsResponse
type GetOrderRegulatedInfoResponse
type GetOrderResponse
type GetOrdersResponse
type ItemApproval
type ItemApprovalAction
type ItemApprovalActionChanges
type ItemApprovalContext
type ItemApprovalStatus
type ItemApprovalType
type ItemBuyerInfo
type ItemIdentifier
type MarketplaceTaxInfo
type ModelError
type Money
type OpenInterval
type OpenTimeInterval
type Order
type OrderAddress
type OrderApprovalsResponse
type OrderBuyerInfo
type OrderItem
type OrderItemApprovalRequest
type OrderItemApprovals
type OrderItemBuyerInfo
type OrderItemsBuyerInfoList
type OrderItemsInner
type OrderItemsList
type OrderRegulatedInfo
type OrdersList
type OrdersV0ApiGetOrderItemsBuyerInfoOpts
type OrdersV0ApiGetOrderItemsOpts
type OrdersV0ApiGetOrdersOpts
type OrdersV0ApiService
- func (a *OrdersV0ApiService) ConfirmShipment(ctx context.Context, body ConfirmShipmentRequest, orderId string) (*http.Response, error)
- func (a *OrdersV0ApiService) GetOrder(ctx context.Context, orderId string) (GetOrderResponse, *http.Response, error)
- func (a *OrdersV0ApiService) GetOrderAddress(ctx context.Context, orderId string) (GetOrderAddressResponse, *http.Response, error)
- func (a *OrdersV0ApiService) GetOrderBuyerInfo(ctx context.Context, orderId string) (GetOrderBuyerInfoResponse, *http.Response, error)
- func (a *OrdersV0ApiService) GetOrderItems(ctx context.Context, orderId string, ...) (GetOrderItemsResponse, *http.Response, error)
- func (a *OrdersV0ApiService) GetOrderItemsBuyerInfo(ctx context.Context, orderId string, ...) (GetOrderItemsBuyerInfoResponse, *http.Response, error)
- func (a *OrdersV0ApiService) GetOrderRegulatedInfo(ctx context.Context, orderId string) (GetOrderRegulatedInfoResponse, *http.Response, error)
- func (a *OrdersV0ApiService) GetOrders(ctx context.Context, marketplaceIds []string, ...) (GetOrdersResponse, *http.Response, error)
- func (a *OrdersV0ApiService) UpdateVerificationStatus(ctx context.Context, body UpdateVerificationStatusRequest, orderId string) (*http.Response, error)
type OtherDeliveryAttributes
type PackageDetail
type PaymentExecutionDetailItem
type PointsGrantedDetail
type PreferredDeliveryTime
type ProductInfoDetail
type RegulatedInformation
type RegulatedInformationField
type RegulatedOrderVerificationStatus
type RejectionReason
type ShipmentApiService
- func (a *ShipmentApiService) UpdateShipmentStatus(ctx context.Context, body UpdateShipmentStatusRequest, orderId string) (*http.Response, error)
type ShipmentStatus
type TaxClassification
type TaxCollection
type UpdateItemsApprovalsErrorResponse
type UpdateOrderApprovalsRequest
type UpdateShipmentStatusErrorResponse
type UpdateShipmentStatusRequest
type UpdateVerificationStatusErrorResponse
type UpdateVerificationStatusRequest
type UpdateVerificationStatusRequestBody
type VerificationStatus

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	ApprovalsApi *ApprovalsApiService

	OrdersV0Api *OrdersV0ApiService

	ShipmentApi *ShipmentApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Orders API vv0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Address ¶

type Address struct {
	// The name.
	Name string `json:"Name"`
	// 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 city
	City string `json:"City,omitempty"`
	// The county.
	County string `json:"County,omitempty"`
	// The district.
	District string `json:"District,omitempty"`
	// The state or region.
	StateOrRegion string `json:"StateOrRegion,omitempty"`
	// The municipality.
	Municipality string `json:"Municipality,omitempty"`
	// The postal code.
	PostalCode string `json:"PostalCode,omitempty"`
	// The country code. A two-character country code, in ISO 3166-1 alpha-2 format.
	CountryCode string `json:"CountryCode,omitempty"`
	// The phone number. Not returned for Fulfillment by Amazon (FBA) orders.
	Phone string `json:"Phone,omitempty"`
	// The address type of the shipping address.
	AddressType string `json:"AddressType,omitempty"`
}

The shipping address for the order.

type ApprovalSupportDataElement ¶

type ApprovalSupportDataElement struct {
	// Name of the approval support element. Allowed names are defined in specific approval types schemas.
	Name string `json:"Name"`
	// String value of the approval support element.
	Value string `json:"Value"`
}

<Name, Value> tuple to define item approval support data elements.

type ApprovalsApiGetOrderItemsApprovalsOpts ¶

type ApprovalsApiGetOrderItemsApprovalsOpts struct {
	NextToken          optional.String
	ItemApprovalTypes  optional.Interface
	ItemApprovalStatus optional.Interface
}

type ApprovalsApiService ¶

type ApprovalsApiService service

func (*ApprovalsApiService) GetOrderItemsApprovals ¶

func (a *ApprovalsApiService) GetOrderItemsApprovals(ctx context.Context, orderId string, localVarOptionals *ApprovalsApiGetOrderItemsApprovalsOpts) (GetOrderApprovalsResponse, *http.Response, error)

func (*ApprovalsApiService) UpdateOrderItemsApprovals ¶

func (a *ApprovalsApiService) UpdateOrderItemsApprovals(ctx context.Context, body UpdateOrderApprovalsRequest, orderId string) (*http.Response, error)

ApprovalsApiService Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The request body for the updateOrderItemsApprovals operation.
@param orderId An Amazon-defined order identifier, in 3-7-7 format.

type AutomatedShippingSettings ¶

type AutomatedShippingSettings struct {
	// 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"`
	// Auto-generated carrier for SSA orders.
	AutomatedCarrier string `json:"AutomatedCarrier,omitempty"`
	// Auto-generated ship method for SSA orders.
	AutomatedShipMethod string `json:"AutomatedShipMethod,omitempty"`
}

Contains information regarding the Shipping Settings Automation program, such as whether the order's shipping settings were generated automatically, and what those settings are.

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BusinessHours ¶

type BusinessHours struct {
	// Day of the week.
	DayOfWeek string `json:"DayOfWeek,omitempty"`
	// Time window during the day when the business is open.
	OpenIntervals []OpenInterval `json:"OpenIntervals,omitempty"`
}

Business days and hours when the destination is open for deliveries.

type BuyerCustomizedInfoDetail ¶

type BuyerCustomizedInfoDetail struct {
	// The location of a zip file containing Amazon Custom data.
	CustomizedURL string `json:"CustomizedURL,omitempty"`
}

Buyer information for custom orders from the Amazon Custom program.

type BuyerInfo ¶

type BuyerInfo struct {
	// The anonymized email address of the buyer.
	BuyerEmail string `json:"BuyerEmail,omitempty"`
	// The buyer name or the recipient name.
	BuyerName string `json:"BuyerName,omitempty"`
	// The county of the buyer.
	BuyerCounty  string        `json:"BuyerCounty,omitempty"`
	BuyerTaxInfo *BuyerTaxInfo `json:"BuyerTaxInfo,omitempty"`
	// The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout.
	PurchaseOrderNumber string `json:"PurchaseOrderNumber,omitempty"`
}

Buyer information.

type BuyerRequestedCancel ¶

type BuyerRequestedCancel struct {
	// When true, the buyer has requested cancellation.
	IsBuyerRequestedCancel bool `json:"IsBuyerRequestedCancel,omitempty"`
	// The reason that the buyer requested cancellation.
	BuyerCancelReason string `json:"BuyerCancelReason,omitempty"`
}

Information about whether or not a buyer requested cancellation.

type BuyerTaxInfo ¶

type BuyerTaxInfo struct {
	// The legal name of the company.
	CompanyLegalName string `json:"CompanyLegalName,omitempty"`
	// The country or region imposing the tax.
	TaxingRegion string `json:"TaxingRegion,omitempty"`
	// A list of tax classifications that apply to the order.
	TaxClassifications []TaxClassification `json:"TaxClassifications,omitempty"`
}

Tax information about the buyer.

type BuyerTaxInformation ¶

type BuyerTaxInformation struct {
	// Business buyer's company legal name.
	BuyerLegalCompanyName string `json:"BuyerLegalCompanyName,omitempty"`
	// Business buyer's address.
	BuyerBusinessAddress string `json:"BuyerBusinessAddress,omitempty"`
	// Business buyer's tax registration ID.
	BuyerTaxRegistrationId string `json:"BuyerTaxRegistrationId,omitempty"`
	// Business buyer's tax office.
	BuyerTaxOffice string `json:"BuyerTaxOffice,omitempty"`
}

Contains the business invoice tax information. Available only in the TR marketplace.

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConfirmShipmentErrorResponse ¶

type ConfirmShipmentErrorResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The error response schema for an shipment confirmation.

type ConfirmShipmentOrderItem ¶

type ConfirmShipmentOrderItem struct {
	// The unique identifier of the order item.
	OrderItemId string `json:"orderItemId"`
	// The quantity of the item.
	Quantity          int32     `json:"quantity"`
	TransparencyCodes *[]string `json:"transparencyCodes,omitempty"`
}

A single order item.

type ConfirmShipmentRequest ¶

type ConfirmShipmentRequest struct {
	PackageDetail *PackageDetail `json:"packageDetail"`
	// The cod collection method, support in JP only.
	CodCollectionMethod string `json:"codCollectionMethod,omitempty"`
	MarketplaceId       string `json:"marketplaceId"`
}

The request schema for an shipment confirmation.

type DeliveryPreferences ¶

type DeliveryPreferences struct {
	// Drop-off location selected by the customer.
	DropOffLocation       string                 `json:"DropOffLocation,omitempty"`
	PreferredDeliveryTime *PreferredDeliveryTime `json:"PreferredDeliveryTime,omitempty"`
	// Enumerated list of miscellaneous delivery attributes associated with the shipping address.
	OtherAttributes []OtherDeliveryAttributes `json:"OtherAttributes,omitempty"`
	// Building instructions, nearby landmark or navigation instructions.
	AddressInstructions string `json:"AddressInstructions,omitempty"`
}

Contains all of the delivery instructions provided by the customer for the shipping address.

type EasyShipShipmentStatus ¶

type EasyShipShipmentStatus string

EasyShipShipmentStatus : The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.

const (
	PENDING_SCHEDULE_EasyShipShipmentStatus    EasyShipShipmentStatus = "PendingSchedule"
	PENDING_PICK_UP_EasyShipShipmentStatus     EasyShipShipmentStatus = "PendingPickUp"
	PENDING_DROP_OFF_EasyShipShipmentStatus    EasyShipShipmentStatus = "PendingDropOff"
	LABEL_CANCELED_EasyShipShipmentStatus      EasyShipShipmentStatus = "LabelCanceled"
	PICKED_UP_EasyShipShipmentStatus           EasyShipShipmentStatus = "PickedUp"
	DROPPED_OFF_EasyShipShipmentStatus         EasyShipShipmentStatus = "DroppedOff"
	AT_ORIGIN_FC_EasyShipShipmentStatus        EasyShipShipmentStatus = "AtOriginFC"
	AT_DESTINATION_FC_EasyShipShipmentStatus   EasyShipShipmentStatus = "AtDestinationFC"
	DELIVERED_EasyShipShipmentStatus           EasyShipShipmentStatus = "Delivered"
	REJECTED_BY_BUYER_EasyShipShipmentStatus   EasyShipShipmentStatus = "RejectedByBuyer"
	UNDELIVERABLE_EasyShipShipmentStatus       EasyShipShipmentStatus = "Undeliverable"
	RETURNING_TO_SELLER_EasyShipShipmentStatus EasyShipShipmentStatus = "ReturningToSeller"
	RETURNED_TO_SELLER_EasyShipShipmentStatus  EasyShipShipmentStatus = "ReturnedToSeller"
	LOST_EasyShipShipmentStatus                EasyShipShipmentStatus = "Lost"
	OUT_FOR_DELIVERY_EasyShipShipmentStatus    EasyShipShipmentStatus = "OutForDelivery"
	DAMAGED_EasyShipShipmentStatus             EasyShipShipmentStatus = "Damaged"
)

List of EasyShipShipmentStatus

type ElectronicInvoiceStatus ¶

type ElectronicInvoiceStatus string

ElectronicInvoiceStatus : The status of the electronic invoice.

const (
	NOT_REQUIRED_ElectronicInvoiceStatus ElectronicInvoiceStatus = "NotRequired"
	NOT_FOUND_ElectronicInvoiceStatus    ElectronicInvoiceStatus = "NotFound"
	PROCESSING_ElectronicInvoiceStatus   ElectronicInvoiceStatus = "Processing"
	ERRORED_ElectronicInvoiceStatus      ElectronicInvoiceStatus = "Errored"
	ACCEPTED_ElectronicInvoiceStatus     ElectronicInvoiceStatus = "Accepted"
)

List of ElectronicInvoiceStatus

type ExceptionDates ¶

type ExceptionDates struct {
	// Date when the business is closed, in ISO-8601 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,omitempty"`
}

Dates when the business is closed or open with a different time window.

type FulfillmentInstruction ¶

type FulfillmentInstruction struct {
	// Denotes the recommended sourceId where the order should be fulfilled from.
	FulfillmentSupplySourceId string `json:"FulfillmentSupplySourceId,omitempty"`
}

Contains the instructions about the fulfillment like where should it be fulfilled from.

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetOrderAddressResponse ¶

type GetOrderAddressResponse struct {
	Payload *OrderAddress `json:"payload,omitempty"`
	Errors  *[]ModelError `json:"errors,omitempty"`
}

The response schema for the getOrderAddress operation.

type GetOrderApprovalsResponse ¶

type GetOrderApprovalsResponse struct {
	Payload *OrderApprovalsResponse `json:"payload,omitempty"`
	Errors  *[]ModelError           `json:"errors,omitempty"`
}

The response schema for the getOrderApprovalsItems operation.

type GetOrderBuyerInfoResponse ¶

type GetOrderBuyerInfoResponse struct {
	Payload *OrderBuyerInfo `json:"payload,omitempty"`
	Errors  *[]ModelError   `json:"errors,omitempty"`
}

The response schema for the getOrderBuyerInfo operation.

type GetOrderItemsBuyerInfoResponse ¶

type GetOrderItemsBuyerInfoResponse struct {
	Payload *OrderItemsBuyerInfoList `json:"payload,omitempty"`
	Errors  *[]ModelError            `json:"errors,omitempty"`
}

The response schema for the getOrderItemsBuyerInfo operation.

type GetOrderItemsResponse ¶

type GetOrderItemsResponse struct {
	Payload *OrderItemsList `json:"payload,omitempty"`
	Errors  *[]ModelError   `json:"errors,omitempty"`
}

The response schema for the getOrderItems operation.

type GetOrderRegulatedInfoResponse ¶

type GetOrderRegulatedInfoResponse struct {
	Payload *OrderRegulatedInfo `json:"payload,omitempty"`
	Errors  *[]ModelError       `json:"errors,omitempty"`
}

The response schema for the getOrderRegulatedInfo operation.

type GetOrderResponse ¶

type GetOrderResponse struct {
	Payload *Order        `json:"payload,omitempty"`
	Errors  *[]ModelError `json:"errors,omitempty"`
}

The response schema for the getOrder operation.

type GetOrdersResponse ¶

type GetOrdersResponse struct {
	Payload *OrdersList   `json:"payload,omitempty"`
	Errors  *[]ModelError `json:"errors,omitempty"`
}

The response schema for the getOrders operation.

type ItemApproval ¶

type ItemApproval struct {
	// Sequence number of the item approval. Each ItemApproval gets its sequenceId automatically from a monotonic increasing function.
	SequenceId int32 `json:"SequenceId"`
	// Timestamp when the ItemApproval was recorded by Amazon's internal order approvals system. In ISO 8601 date time format.
	Timestamp string `json:"Timestamp"`
	// High level actors involved in the approval process.
	Actor string `json:"Actor"`
	// Person or system that triggers the approval actions on behalf of the actor.
	Approver       string              `json:"Approver,omitempty"`
	ApprovalAction *ItemApprovalAction `json:"ApprovalAction"`
	// Status of approval action.
	ApprovalActionProcessStatus string `json:"ApprovalActionProcessStatus"`
	// Optional message to communicate optional additional context about the current status of the approval action.
	ApprovalActionProcessStatusMessage string `json:"ApprovalActionProcessStatusMessage,omitempty"`
}

Generic item approval. Check the applicable restrictions at the specific approval type schemas.

type ItemApprovalAction ¶

type ItemApprovalAction struct {
	// Defines the type of action for the approval.
	ActionType string `json:"ActionType"`
	// Comment message to provide optional additional context on the approval action.
	Comment string                     `json:"Comment,omitempty"`
	Changes *ItemApprovalActionChanges `json:"Changes,omitempty"`
}

This object represents an approval action used by the actors in the order item approval process. Check the applicable restrictions at the specific approval type schemas.

type ItemApprovalActionChanges ¶

type ItemApprovalActionChanges struct {
	ItemPrice *Money `json:"ItemPrice,omitempty"`
	// Quantity approved. If substitutedBy is specified, this value applies to the substitution item.
	Quantity      int32           `json:"Quantity,omitempty"`
	SubstitutedBy *ItemIdentifier `json:"SubstitutedBy,omitempty"`
}

Changes required for the approval. Each approval type defines the allowed changes valid sub-set in its specific schema.

type ItemApprovalContext ¶

type ItemApprovalContext struct {
	ApprovalType        *ItemApprovalType             `json:"ApprovalType"`
	ApprovalStatus      *ItemApprovalStatus           `json:"ApprovalStatus"`
	ApprovalSupportData *[]ApprovalSupportDataElement `json:"ApprovalSupportData,omitempty"`
}

Generic item approval context. Check the applicable restrictions at the specific approval type schemas.

type ItemApprovalStatus ¶

type ItemApprovalStatus string

ItemApprovalStatus : Defines the possible status of an order item approval.

const (
	PENDING_SELLING_PARTNER_APPROVAL_ItemApprovalStatus    ItemApprovalStatus = "PENDING_SELLING_PARTNER_APPROVAL"
	PROCESSING_SELLING_PARTNER_APPROVAL_ItemApprovalStatus ItemApprovalStatus = "PROCESSING_SELLING_PARTNER_APPROVAL"
	PENDING_AMAZON_APPROVAL_ItemApprovalStatus             ItemApprovalStatus = "PENDING_AMAZON_APPROVAL"
	APPROVED_ItemApprovalStatus                            ItemApprovalStatus = "APPROVED"
	APPROVED_WITH_CHANGES_ItemApprovalStatus               ItemApprovalStatus = "APPROVED_WITH_CHANGES"
	DECLINED_ItemApprovalStatus                            ItemApprovalStatus = "DECLINED"
)

List of ItemApprovalStatus

type ItemApprovalType ¶

type ItemApprovalType string

ItemApprovalType : Defines the approval process types available for order items.

const (
	LEONARDI_APPROVAL_ItemApprovalType ItemApprovalType = "LEONARDI_APPROVAL"
)

List of ItemApprovalType

type ItemBuyerInfo ¶

type ItemBuyerInfo struct {
	BuyerCustomizedInfo *BuyerCustomizedInfoDetail `json:"BuyerCustomizedInfo,omitempty"`
	GiftWrapPrice       *Money                     `json:"GiftWrapPrice,omitempty"`
	GiftWrapTax         *Money                     `json:"GiftWrapTax,omitempty"`
	// A gift message provided by the buyer.
	GiftMessageText string `json:"GiftMessageText,omitempty"`
	// The gift wrap level specified by the buyer.
	GiftWrapLevel string `json:"GiftWrapLevel,omitempty"`
}

A single item's buyer information.

type ItemIdentifier ¶

type ItemIdentifier struct {
	// Defines the type of identifiers allowed to specify a substitution.
	IdentifierType string `json:"IdentifierType"`
	Identifier     string `json:"Identifier"`
}

Item identifiers used in the context of approvals operations.

type MarketplaceTaxInfo ¶

type MarketplaceTaxInfo struct {
	// A list of tax classifications that apply to the order.
	TaxClassifications []TaxClassification `json:"TaxClassifications,omitempty"`
}

Tax information about the marketplace.

type ModelError ¶

type ModelError struct {
	// An error code that identifies the type of error that occurred.
	Code string `json:"code"`
	// A message that describes the error condition.
	Message string `json:"message"`
	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`
}

Error response returned when the request is unsuccessful.

type Money ¶

type Money struct {
	// The three-digit currency code. In ISO 4217 format.
	CurrencyCode string `json:"CurrencyCode,omitempty"`
	// The currency amount.
	Amount string `json:"Amount,omitempty"`
}

The monetary value of the order.

type OpenInterval ¶

type OpenInterval struct {
	StartTime *OpenTimeInterval `json:"StartTime,omitempty"`
	EndTime   *OpenTimeInterval `json:"EndTime,omitempty"`
}

The time interval for which the business is open.

type OpenTimeInterval ¶

type OpenTimeInterval struct {
	// The hour when the business opens or closes.
	Hour int32 `json:"Hour,omitempty"`
	// The minute when the business opens or closes.
	Minute int32 `json:"Minute,omitempty"`
}

The time when the business opens or closes.

type Order ¶

type Order struct {
	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId string `json:"AmazonOrderId"`
	// A seller-defined order identifier.
	SellerOrderId string `json:"SellerOrderId,omitempty"`
	// The date when the order was created.
	PurchaseDate string `json:"PurchaseDate"`
	// 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.
	LastUpdateDate string `json:"LastUpdateDate"`
	// The current order status.
	OrderStatus string `json:"OrderStatus"`
	// Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN).
	FulfillmentChannel string `json:"FulfillmentChannel,omitempty"`
	// The sales channel of the first item in the order.
	SalesChannel string `json:"SalesChannel,omitempty"`
	// The order channel of the first item in the order.
	OrderChannel string `json:"OrderChannel,omitempty"`
	// The shipment service level of the order.
	ShipServiceLevel string `json:"ShipServiceLevel,omitempty"`
	OrderTotal       *Money `json:"OrderTotal,omitempty"`
	// The number of items shipped.
	NumberOfItemsShipped int32 `json:"NumberOfItemsShipped,omitempty"`
	// The number of items unshipped.
	NumberOfItemsUnshipped int32                         `json:"NumberOfItemsUnshipped,omitempty"`
	PaymentExecutionDetail *[]PaymentExecutionDetailItem `json:"PaymentExecutionDetail,omitempty"`
	// The payment method for the order. This property is limited to Cash On Delivery (COD) and Convenience Store (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.
	PaymentMethod        string    `json:"PaymentMethod,omitempty"`
	PaymentMethodDetails *[]string `json:"PaymentMethodDetails,omitempty"`
	// The identifier for the marketplace where the order was placed.
	MarketplaceId string `json:"MarketplaceId,omitempty"`
	// The shipment service level category of the order.  Possible values: Expedited, FreeEconomy, NextDay, SameDay, SecondDay, Scheduled, Standard.
	ShipmentServiceLevelCategory string                  `json:"ShipmentServiceLevelCategory,omitempty"`
	EasyShipShipmentStatus       *EasyShipShipmentStatus `json:"EasyShipShipmentStatus,omitempty"`
	// Custom ship label for Checkout by Amazon (CBA).
	CbaDisplayableShippingLabel string `json:"CbaDisplayableShippingLabel,omitempty"`
	// The type of the order.
	OrderType string `json:"OrderType,omitempty"`
	// The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.  __Note__: EarliestShipDate might not be returned for orders placed before February 1, 2013.
	EarliestShipDate string `json:"EarliestShipDate,omitempty"`
	// The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.  __Note__: LatestShipDate might not be returned for orders placed before February 1, 2013.
	LatestShipDate string `json:"LatestShipDate,omitempty"`
	// The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.
	EarliestDeliveryDate string `json:"EarliestDeliveryDate,omitempty"`
	// The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status.
	LatestDeliveryDate string `json:"LatestDeliveryDate,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 order is a seller-fulfilled Amazon Prime order.
	IsPrime bool `json:"IsPrime,omitempty"`
	// When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, see \"Premium Shipping Options\" in the Seller Central Help for your marketplace.
	IsPremiumOrder bool `json:"IsPremiumOrder,omitempty"`
	// When true, the order is a GlobalExpress order.
	IsGlobalExpressEnabled bool `json:"IsGlobalExpressEnabled,omitempty"`
	// The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true.
	ReplacedOrderId string `json:"ReplacedOrderId,omitempty"`
	// When true, this is a replacement order.
	IsReplacementOrder bool `json:"IsReplacementOrder,omitempty"`
	// Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders.
	PromiseResponseDueDate string `json:"PromiseResponseDueDate,omitempty"`
	// When true, the estimated ship date is set for the order. Returned only for Sourcing on Demand orders.
	IsEstimatedShipDateSet bool `json:"IsEstimatedShipDateSet,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"`
	// 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"`
	DefaultShipFromLocationAddress *Address `json:"DefaultShipFromLocationAddress,omitempty"`
	// The buyer's invoicing preference. Available only in the TR marketplace.
	BuyerInvoicePreference string                  `json:"BuyerInvoicePreference,omitempty"`
	BuyerTaxInformation    *BuyerTaxInformation    `json:"BuyerTaxInformation,omitempty"`
	FulfillmentInstruction *FulfillmentInstruction `json:"FulfillmentInstruction,omitempty"`
	// When true, this order is marked to be picked up from a store rather than delivered.
	IsISPU bool `json:"IsISPU,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"`
	MarketplaceTaxInfo *MarketplaceTaxInfo `json:"MarketplaceTaxInfo,omitempty"`
	// The seller’s friendly name registered in the marketplace.
	SellerDisplayName         string                     `json:"SellerDisplayName,omitempty"`
	ShippingAddress           *Address                   `json:"ShippingAddress,omitempty"`
	BuyerInfo                 *BuyerInfo                 `json:"BuyerInfo,omitempty"`
	AutomatedShippingSettings *AutomatedShippingSettings `json:"AutomatedShippingSettings,omitempty"`
	// Whether the order contains regulated items which may require additional approval steps before being fulfilled.
	HasRegulatedItems       bool                     `json:"HasRegulatedItems,omitempty"`
	ElectronicInvoiceStatus *ElectronicInvoiceStatus `json:"ElectronicInvoiceStatus,omitempty"`
	// Set of approval types which applies to at least one order item in the order.
	ItemApprovalTypes []ItemApprovalType `json:"ItemApprovalTypes,omitempty"`
	// Subset of all ItemApprovalStatus that are set in at least one of the order items subject to approvals.
	ItemApprovalStatus []ItemApprovalStatus `json:"ItemApprovalStatus,omitempty"`
}

Order information.

type OrderAddress ¶

type OrderAddress struct {
	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId string `json:"AmazonOrderId"`
	// Company name of the destination address.
	BuyerCompanyName    string               `json:"BuyerCompanyName,omitempty"`
	ShippingAddress     *Address             `json:"ShippingAddress,omitempty"`
	DeliveryPreferences *DeliveryPreferences `json:"DeliveryPreferences,omitempty"`
}

The shipping address for the order.

type OrderApprovalsResponse ¶

type OrderApprovalsResponse struct {
	// When present and not empty, pass this string token in the next request to return the next response page.
	NextToken string `json:"NextToken,omitempty"`
	// List of OrderItemApprovals.
	OrderItemsApprovalsList []OrderItemApprovals `json:"OrderItemsApprovalsList"`
}

The order items list with approvals along with the order ID.

type OrderBuyerInfo ¶

type OrderBuyerInfo struct {
	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId string `json:"AmazonOrderId"`
	// The anonymized email address of the buyer.
	BuyerEmail string `json:"BuyerEmail,omitempty"`
	// The buyer name or the recipient name.
	BuyerName string `json:"BuyerName,omitempty"`
	// The county of the buyer.
	BuyerCounty  string        `json:"BuyerCounty,omitempty"`
	BuyerTaxInfo *BuyerTaxInfo `json:"BuyerTaxInfo,omitempty"`
	// The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout.
	PurchaseOrderNumber string `json:"PurchaseOrderNumber,omitempty"`
}

Buyer information for an order.

type OrderItem ¶

type OrderItem struct {
	// The Amazon Standard Identification Number (ASIN) of the item.
	ASIN string `json:"ASIN"`
	// The seller stock keeping unit (SKU) of the item.
	SellerSKU string `json:"SellerSKU,omitempty"`
	// An Amazon-defined order item identifier.
	OrderItemId string `json:"OrderItemId"`
	// The name of the item.
	Title string `json:"Title,omitempty"`
	// The number of items in the order.
	QuantityOrdered int32 `json:"QuantityOrdered"`
	// The number of items shipped.
	QuantityShipped      int32                `json:"QuantityShipped,omitempty"`
	ProductInfo          *ProductInfoDetail   `json:"ProductInfo,omitempty"`
	PointsGranted        *PointsGrantedDetail `json:"PointsGranted,omitempty"`
	ItemPrice            *Money               `json:"ItemPrice,omitempty"`
	ShippingPrice        *Money               `json:"ShippingPrice,omitempty"`
	ItemTax              *Money               `json:"ItemTax,omitempty"`
	ShippingTax          *Money               `json:"ShippingTax,omitempty"`
	ShippingDiscount     *Money               `json:"ShippingDiscount,omitempty"`
	ShippingDiscountTax  *Money               `json:"ShippingDiscountTax,omitempty"`
	PromotionDiscount    *Money               `json:"PromotionDiscount,omitempty"`
	PromotionDiscountTax *Money               `json:"PromotionDiscountTax,omitempty"`
	PromotionIds         *[]string            `json:"PromotionIds,omitempty"`
	CODFee               *Money               `json:"CODFee,omitempty"`
	CODFeeDiscount       *Money               `json:"CODFeeDiscount,omitempty"`
	// When true, the item is a gift.
	IsGift bool `json:"IsGift,omitempty"`
	// The condition of the item as described by the seller.
	ConditionNote string `json:"ConditionNote,omitempty"`
	// The condition of the item.  Possible values: New, Used, Collectible, Refurbished, Preorder, Club.
	ConditionId string `json:"ConditionId,omitempty"`
	// The subcondition of the item.  Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, Any, Other.
	ConditionSubtypeId string `json:"ConditionSubtypeId,omitempty"`
	// The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format.
	ScheduledDeliveryStartDate string `json:"ScheduledDeliveryStartDate,omitempty"`
	// The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format.
	ScheduledDeliveryEndDate string `json:"ScheduledDeliveryEndDate,omitempty"`
	// Indicates that the selling price is a special price that is available only for Amazon Business orders. For more information about the Amazon Business Seller Program, see the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business).   Possible values: BusinessPrice - A special price that is available only for Amazon Business orders.
	PriceDesignation string         `json:"PriceDesignation,omitempty"`
	TaxCollection    *TaxCollection `json:"TaxCollection,omitempty"`
	// When true, the product type for this item has a serial number.  Returned only for Amazon Easy Ship orders.
	SerialNumberRequired bool `json:"SerialNumberRequired,omitempty"`
	// When true, transparency codes are required.
	IsTransparency bool `json:"IsTransparency,omitempty"`
	// The IOSS number for the marketplace. Sellers shipping to the European Union (EU) from outside of the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.
	IossNumber string `json:"IossNumber,omitempty"`
	// The store chain store identifier. Linked to a specific store in a store chain.
	StoreChainStoreId string `json:"StoreChainStoreId,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.
	DeemedResellerCategory string                `json:"DeemedResellerCategory,omitempty"`
	BuyerInfo              *ItemBuyerInfo        `json:"BuyerInfo,omitempty"`
	BuyerRequestedCancel   *BuyerRequestedCancel `json:"BuyerRequestedCancel,omitempty"`
	ItemApprovalContext    *ItemApprovalContext  `json:"ItemApprovalContext,omitempty"`
	// A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.
	SerialNumbers []string `json:"SerialNumbers,omitempty"`
}

A single order item.

type OrderItemApprovalRequest ¶

type OrderItemApprovalRequest struct {
	// The unique identifier of the order item.
	OrderItemId    string              `json:"OrderItemId"`
	ApprovalAction *ItemApprovalAction `json:"ApprovalAction"`
}

Order item apecific approval request.

type OrderItemApprovals ¶

type OrderItemApprovals struct {
	// The unique identifier of the order item.
	OrderItemId    string              `json:"OrderItemId"`
	ApprovalType   *ItemApprovalType   `json:"ApprovalType"`
	ApprovalStatus *ItemApprovalStatus `json:"ApprovalStatus"`
	ItemApprovals  []ItemApproval      `json:"ItemApprovals"`
}

List of item approvals gathered during the approval process.

type OrderItemBuyerInfo ¶

type OrderItemBuyerInfo struct {
	// An Amazon-defined order item identifier.
	OrderItemId         string                     `json:"OrderItemId"`
	BuyerCustomizedInfo *BuyerCustomizedInfoDetail `json:"BuyerCustomizedInfo,omitempty"`
	GiftWrapPrice       *Money                     `json:"GiftWrapPrice,omitempty"`
	GiftWrapTax         *Money                     `json:"GiftWrapTax,omitempty"`
	// A gift message provided by the buyer.
	GiftMessageText string `json:"GiftMessageText,omitempty"`
	// The gift wrap level specified by the buyer.
	GiftWrapLevel string `json:"GiftWrapLevel,omitempty"`
}

A single order item's buyer information.

type OrderItemsBuyerInfoList ¶

type OrderItemsBuyerInfoList struct {
	OrderItems *[]OrderItemBuyerInfo `json:"OrderItems"`
	// When present and not empty, pass this string token in the next request to return the next response page.
	NextToken string `json:"NextToken,omitempty"`
	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId string `json:"AmazonOrderId"`
}

A single order item's buyer information list with the order ID.

type OrderItemsInner ¶

type OrderItemsInner struct {
	// The unique identifier of the order item.
	OrderItemId string `json:"orderItemId,omitempty"`
	// The quantity for which to update the shipment status.
	Quantity int32 `json:"quantity,omitempty"`
}

type OrderItemsList ¶

type OrderItemsList struct {
	OrderItems *[]OrderItem `json:"OrderItems"`
	// When present and not empty, pass this string token in the next request to return the next response page.
	NextToken string `json:"NextToken,omitempty"`
	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId string `json:"AmazonOrderId"`
}

The order items list along with the order ID.

type OrderRegulatedInfo ¶

type OrderRegulatedInfo struct {
	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId        string                `json:"AmazonOrderId"`
	RegulatedInformation *RegulatedInformation `json:"RegulatedInformation"`
	// When true, the order requires attaching a dosage information label when shipped.
	RequiresDosageLabel              bool                              `json:"RequiresDosageLabel"`
	RegulatedOrderVerificationStatus *RegulatedOrderVerificationStatus `json:"RegulatedOrderVerificationStatus"`
}

The order's regulated information along with its verification status.

type OrdersList ¶

type OrdersList struct {
	Orders *[]Order `json:"Orders"`
	// When present and not empty, pass this string token in the next request to return the next response page.
	NextToken string `json:"NextToken,omitempty"`
	// A date used for selecting 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 format.
	LastUpdatedBefore string `json:"LastUpdatedBefore,omitempty"`
	// A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
	CreatedBefore string `json:"CreatedBefore,omitempty"`
}

A list of orders along with additional information to make subsequent API calls.

type OrdersV0ApiGetOrderItemsBuyerInfoOpts ¶

type OrdersV0ApiGetOrderItemsBuyerInfoOpts struct {
	NextToken optional.String
}

type OrdersV0ApiGetOrderItemsOpts ¶

type OrdersV0ApiGetOrderItemsOpts struct {
	NextToken optional.String
}

type OrdersV0ApiGetOrdersOpts ¶

type OrdersV0ApiGetOrdersOpts struct {
	CreatedAfter                    optional.String
	CreatedBefore                   optional.String
	LastUpdatedAfter                optional.String
	LastUpdatedBefore               optional.String
	OrderStatuses                   optional.Interface
	FulfillmentChannels             optional.Interface
	PaymentMethods                  optional.Interface
	BuyerEmail                      optional.String
	SellerOrderId                   optional.String
	MaxResultsPerPage               optional.Int32
	EasyShipShipmentStatuses        optional.Interface
	ElectronicInvoiceStatuses       optional.Interface
	NextToken                       optional.String
	AmazonOrderIds                  optional.Interface
	ActualFulfillmentSupplySourceId optional.String
	IsISPU                          optional.Bool
	StoreChainStoreId               optional.String
	ItemApprovalTypes               optional.Interface
	ItemApprovalStatus              optional.Interface
}

type OrdersV0ApiService ¶

type OrdersV0ApiService service

func (*OrdersV0ApiService) ConfirmShipment ¶

func (a *OrdersV0ApiService) ConfirmShipment(ctx context.Context, body ConfirmShipmentRequest, orderId string) (*http.Response, error)

OrdersV0ApiService Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Request body of confirmShipment.
@param orderId An Amazon-defined order identifier, in 3-7-7 format.

func (*OrdersV0ApiService) GetOrder ¶

func (a *OrdersV0ApiService) GetOrder(ctx context.Context, orderId string) (GetOrderResponse, *http.Response, error)

OrdersV0ApiService Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId An Amazon-defined order identifier, in 3-7-7 format.

@return GetOrderResponse

func (*OrdersV0ApiService) GetOrderAddress ¶

func (a *OrdersV0ApiService) GetOrderAddress(ctx context.Context, orderId string) (GetOrderAddressResponse, *http.Response, error)

OrdersV0ApiService Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.

@return GetOrderAddressResponse

func (*OrdersV0ApiService) GetOrderBuyerInfo ¶

func (a *OrdersV0ApiService) GetOrderBuyerInfo(ctx context.Context, orderId string) (GetOrderBuyerInfoResponse, *http.Response, error)

OrdersV0ApiService Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.

@return GetOrderBuyerInfoResponse

func (*OrdersV0ApiService) GetOrderItems ¶

func (a *OrdersV0ApiService) GetOrderItems(ctx context.Context, orderId string, localVarOptionals *OrdersV0ApiGetOrderItemsOpts) (GetOrderItemsResponse, *http.Response, error)

func (*OrdersV0ApiService) GetOrderItemsBuyerInfo ¶

func (a *OrdersV0ApiService) GetOrderItemsBuyerInfo(ctx context.Context, orderId string, localVarOptionals *OrdersV0ApiGetOrderItemsBuyerInfoOpts) (GetOrderItemsBuyerInfoResponse, *http.Response, error)

func (*OrdersV0ApiService) GetOrderRegulatedInfo ¶

func (a *OrdersV0ApiService) GetOrderRegulatedInfo(ctx context.Context, orderId string) (GetOrderRegulatedInfoResponse, *http.Response, error)

OrdersV0ApiService Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.

@return GetOrderRegulatedInfoResponse

func (*OrdersV0ApiService) GetOrders ¶

func (a *OrdersV0ApiService) GetOrders(ctx context.Context, marketplaceIds []string, localVarOptionals *OrdersV0ApiGetOrdersOpts) (GetOrdersResponse, *http.Response, error)

func (*OrdersV0ApiService) UpdateVerificationStatus ¶

func (a *OrdersV0ApiService) UpdateVerificationStatus(ctx context.Context, body UpdateVerificationStatusRequest, orderId string) (*http.Response, error)

OrdersV0ApiService Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The request body for the updateVerificationStatus operation.
@param orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.

type OtherDeliveryAttributes ¶

type OtherDeliveryAttributes string

OtherDeliveryAttributes : Miscellaneous delivery attributes associated with the shipping address.

const (
	HAS_ACCESS_POINT_OtherDeliveryAttributes OtherDeliveryAttributes = "HAS_ACCESS_POINT"
	PALLET_ENABLED_OtherDeliveryAttributes   OtherDeliveryAttributes = "PALLET_ENABLED"
	PALLET_DISABLED_OtherDeliveryAttributes  OtherDeliveryAttributes = "PALLET_DISABLED"
)

List of OtherDeliveryAttributes

type PackageDetail ¶

type PackageDetail struct {
	PackageReferenceId string `json:"packageReferenceId"`
	// Identifies the carrier that will deliver the package. This field is required for all marketplaces, see [reference](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces).
	CarrierCode string `json:"carrierCode"`
	// Carrier Name that will deliver the package. Required when carrierCode is \"Others\"
	CarrierName string `json:"carrierName,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.
	TrackingNumber string `json:"trackingNumber"`
	// The shipping date for the package. Must be in ISO-8601 date/time format.
	ShipDate time.Time `json:"shipDate"`
	// The unique identifier of the supply source.
	ShipFromSupplySourceId string                      `json:"shipFromSupplySourceId,omitempty"`
	OrderItems             *[]ConfirmShipmentOrderItem `json:"orderItems"`
}

Properties of packages

type PaymentExecutionDetailItem ¶

type PaymentExecutionDetailItem struct {
	Payment *Money `json:"Payment"`
	// A sub-payment method for a COD order.  Possible values:  * COD - Cash On Delivery.  * GC - Gift Card.  * PointsAccount - Amazon Points.
	PaymentMethod string `json:"PaymentMethod"`
}

Information about a sub-payment method used to pay for a COD order.

type PointsGrantedDetail ¶

type PointsGrantedDetail struct {
	// The number of Amazon Points granted with the purchase of an item.
	PointsNumber        int32  `json:"PointsNumber,omitempty"`
	PointsMonetaryValue *Money `json:"PointsMonetaryValue,omitempty"`
}

The number of Amazon Points offered with the purchase of an item, and their monetary value.

type PreferredDeliveryTime ¶

type PreferredDeliveryTime struct {
	// Business hours when the business is open for deliveries.
	BusinessHours []BusinessHours `json:"BusinessHours,omitempty"`
	// Dates when the business is closed in the next 30 days.
	ExceptionDates []ExceptionDates `json:"ExceptionDates,omitempty"`
}

The time window when the delivery is preferred.

type ProductInfoDetail ¶

type ProductInfoDetail struct {
	// The total number of items that are included in the ASIN.
	NumberOfItems int32 `json:"NumberOfItems,omitempty"`
}

Product information on the number of items.

type RegulatedInformation ¶

type RegulatedInformation struct {
	// A list of regulated information fields as collected from the regulatory form.
	Fields []RegulatedInformationField `json:"Fields"`
}

The regulated information collected during purchase and used to verify the order.

type RegulatedInformationField ¶

type RegulatedInformationField struct {
	// The unique identifier for the field.
	FieldId string `json:"FieldId"`
	// The name for the field.
	FieldLabel string `json:"FieldLabel"`
	// The type of field.
	FieldType string `json:"FieldType"`
	// The content of the field as collected in regulatory form. Note that FileAttachment type fields will contain a URL to download the attachment here.
	FieldValue string `json:"FieldValue"`
}

A field collected from the regulatory form.

type RegulatedOrderVerificationStatus ¶

type RegulatedOrderVerificationStatus struct {
	Status *VerificationStatus `json:"Status"`
	// When true, the regulated information provided in the order requires a review by the merchant.
	RequiresMerchantAction bool `json:"RequiresMerchantAction"`
	// A list of valid rejection reasons that may be used to reject the order's regulated information.
	ValidRejectionReasons []RejectionReason `json:"ValidRejectionReasons"`
	RejectionReason       *RejectionReason  `json:"RejectionReason,omitempty"`
	// The date the order was reviewed. In ISO 8601 date time format.
	ReviewDate string `json:"ReviewDate,omitempty"`
	// The identifier for the order's regulated information reviewer.
	ExternalReviewerId string `json:"ExternalReviewerId,omitempty"`
}

The verification status of the order along with associated approval or rejection metadata.

type RejectionReason ¶

type RejectionReason struct {
	// The unique identifier for the rejection reason.
	RejectionReasonId string `json:"RejectionReasonId"`
	// The description of this rejection reason.
	RejectionReasonDescription string `json:"RejectionReasonDescription"`
}

The reason for rejecting the order's regulated information. Not present if the order isn't rejected.

type ShipmentApiService ¶

type ShipmentApiService service

func (*ShipmentApiService) UpdateShipmentStatus ¶

func (a *ShipmentApiService) UpdateShipmentStatus(ctx context.Context, body UpdateShipmentStatusRequest, orderId string) (*http.Response, error)

ShipmentApiService Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The request body for the updateShipmentStatus operation.
@param orderId An Amazon-defined order identifier, in 3-7-7 format.

type ShipmentStatus ¶

type ShipmentStatus string

ShipmentStatus : The shipment status to apply.

const (
	READY_FOR_PICKUP_ShipmentStatus ShipmentStatus = "ReadyForPickup"
	PICKED_UP_ShipmentStatus        ShipmentStatus = "PickedUp"
	REFUSED_PICKUP_ShipmentStatus   ShipmentStatus = "RefusedPickup"
)

List of ShipmentStatus

type TaxClassification ¶

type TaxClassification struct {
	// The type of tax.
	Name string `json:"Name,omitempty"`
	// The buyer's tax identifier.
	Value string `json:"Value,omitempty"`
}

The tax classification for the order.

type TaxCollection ¶

type TaxCollection struct {
	// The tax collection model applied to the item.
	Model string `json:"Model,omitempty"`
	// The party responsible for withholding the taxes and remitting them to the taxing authority.
	ResponsibleParty string `json:"ResponsibleParty,omitempty"`
}

Information about withheld taxes.

type UpdateItemsApprovalsErrorResponse ¶

type UpdateItemsApprovalsErrorResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The error response schema for the updateOrderItemsApprovals operation.

type UpdateOrderApprovalsRequest ¶

type UpdateOrderApprovalsRequest struct {
	// Person or system that triggers the approval actions on behalf of the actor.
	Approver string `json:"Approver,omitempty"`
	// A list of item approval requests.
	OrderItemsApprovalRequests []OrderItemApprovalRequest `json:"OrderItemsApprovalRequests"`
}

The request body for the updateOrderItemsApprovals operation.

type UpdateShipmentStatusErrorResponse ¶

type UpdateShipmentStatusErrorResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The error response schema for the UpdateShipmentStatus operation.

type UpdateShipmentStatusRequest ¶

type UpdateShipmentStatusRequest struct {
	MarketplaceId  string             `json:"marketplaceId"`
	ShipmentStatus *ShipmentStatus    `json:"shipmentStatus"`
	OrderItems     *[]OrderItemsInner `json:"orderItems,omitempty"`
}

The request body for the updateShipmentStatus operation.

type UpdateVerificationStatusErrorResponse ¶

type UpdateVerificationStatusErrorResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The error response schema for the UpdateVerificationStatus operation.

type UpdateVerificationStatusRequest ¶

type UpdateVerificationStatusRequest struct {
	RegulatedOrderVerificationStatus *UpdateVerificationStatusRequestBody `json:"regulatedOrderVerificationStatus"`
}

The request body for the updateVerificationStatus operation.

type UpdateVerificationStatusRequestBody ¶

type UpdateVerificationStatusRequestBody struct {
	Status *VerificationStatus `json:"status"`
	// The identifier for the order's regulated information reviewer.
	ExternalReviewerId string `json:"externalReviewerId"`
	// The unique identifier for 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 updated values of the VerificationStatus field.

type VerificationStatus ¶

type VerificationStatus string

VerificationStatus : The verification status of the order.

const (
	PENDING_VerificationStatus   VerificationStatus = "Pending"
	APPROVED_VerificationStatus  VerificationStatus = "Approved"
	REJECTED_VerificationStatus  VerificationStatus = "Rejected"
	EXPIRED_VerificationStatus   VerificationStatus = "Expired"
	CANCELLED_VerificationStatus VerificationStatus = "Cancelled"
)

List of VerificationStatus

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL