ordersV0

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

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

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

Documentation

Overview

Package ordersV0 provides primitives to interact the openapi HTTP API.

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

Package ordersV0 provides primitives to interact the openapi HTTP API.

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetOrderAddressRequest 

func NewGetOrderAddressRequest(endpoint string, orderId string) (*http.Request, error)

NewGetOrderAddressRequest generates requests for GetOrderAddress

func NewGetOrderBuyerInfoRequest 

func NewGetOrderBuyerInfoRequest(endpoint string, orderId string) (*http.Request, error)

NewGetOrderBuyerInfoRequest generates requests for GetOrderBuyerInfo

func NewGetOrderItemsBuyerInfoRequest 

func NewGetOrderItemsBuyerInfoRequest(endpoint string, orderId string, params *GetOrderItemsBuyerInfoParams) (*http.Request, error)

NewGetOrderItemsBuyerInfoRequest generates requests for GetOrderItemsBuyerInfo

func NewGetOrderItemsRequest 

func NewGetOrderItemsRequest(endpoint string, orderId string, params *GetOrderItemsParams) (*http.Request, error)

NewGetOrderItemsRequest generates requests for GetOrderItems

func NewGetOrderRequest 

func NewGetOrderRequest(endpoint string, orderId string) (*http.Request, error)

NewGetOrderRequest generates requests for GetOrder

func NewGetOrdersRequest 

func NewGetOrdersRequest(endpoint string, params *GetOrdersParams) (*http.Request, error)

NewGetOrdersRequest generates requests for GetOrders

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.
	AddressType *string `json:"AddressType,omitempty"`

	// The city
	City *string `json:"City,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 municipality.
	Municipality *string `json:"Municipality,omitempty"`

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

	// The phone number. Not returned for Fulfillment by Amazon (FBA) orders.
	Phone *string `json:"Phone,omitempty"`

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

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

Address defines model for Address.

type BuyerCustomizedInfoDetail 

type BuyerCustomizedInfoDetail struct {

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

BuyerCustomizedInfoDetail defines model for BuyerCustomizedInfoDetail.

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,omitempty"`

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

BuyerTaxInfo defines model for BuyerTaxInfo.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Endpoint string

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

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

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

	// The user agent header identifies your application, its version number, and the platform and programming language you are using.
	// You must include a user agent header in each request submitted to the sales partner API.
	UserAgent string
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(endpoint string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetOrder 

func (c *Client) GetOrder(ctx context.Context, orderId string) (*http.Response, error)

func (*Client) GetOrderAddress 

func (c *Client) GetOrderAddress(ctx context.Context, orderId string) (*http.Response, error)

func (*Client) GetOrderBuyerInfo 

func (c *Client) GetOrderBuyerInfo(ctx context.Context, orderId string) (*http.Response, error)

func (*Client) GetOrderItems 

func (c *Client) GetOrderItems(ctx context.Context, orderId string, params *GetOrderItemsParams) (*http.Response, error)

func (*Client) GetOrderItemsBuyerInfo 

func (c *Client) GetOrderItemsBuyerInfo(ctx context.Context, orderId string, params *GetOrderItemsBuyerInfoParams) (*http.Response, error)

func (*Client) GetOrders 

func (c *Client) GetOrders(ctx context.Context, params *GetOrdersParams) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetOrders request
	GetOrders(ctx context.Context, params *GetOrdersParams) (*http.Response, error)

	// GetOrder request
	GetOrder(ctx context.Context, orderId string) (*http.Response, error)

	// GetOrderAddress request
	GetOrderAddress(ctx context.Context, orderId string) (*http.Response, error)

	// GetOrderBuyerInfo request
	GetOrderBuyerInfo(ctx context.Context, orderId string) (*http.Response, error)

	// GetOrderItems request
	GetOrderItems(ctx context.Context, orderId string, params *GetOrderItemsParams) (*http.Response, error)

	// GetOrderItemsBuyerInfo request
	GetOrderItemsBuyerInfo(ctx context.Context, orderId string, params *GetOrderItemsBuyerInfoParams) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestBefore 

func WithRequestBefore(fn RequestBeforeFn) ClientOption

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

func WithResponseAfter 

func WithResponseAfter(fn ResponseAfterFn) ClientOption

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

func WithUserAgent 

func WithUserAgent(userAgent string) ClientOption

WithUserAgent set up useragent add user agent to every request automatically

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

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

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

func (*ClientWithResponses) GetOrderAddressWithResponse 

func (c *ClientWithResponses) GetOrderAddressWithResponse(ctx context.Context, orderId string) (*GetOrderAddressResp, error)

GetOrderAddressWithResponse request returning *GetOrderAddressResponse

func (*ClientWithResponses) GetOrderBuyerInfoWithResponse 

func (c *ClientWithResponses) GetOrderBuyerInfoWithResponse(ctx context.Context, orderId string) (*GetOrderBuyerInfoResp, error)

GetOrderBuyerInfoWithResponse request returning *GetOrderBuyerInfoResponse

func (*ClientWithResponses) GetOrderItemsBuyerInfoWithResponse 

func (c *ClientWithResponses) GetOrderItemsBuyerInfoWithResponse(ctx context.Context, orderId string, params *GetOrderItemsBuyerInfoParams) (*GetOrderItemsBuyerInfoResp, error)

GetOrderItemsBuyerInfoWithResponse request returning *GetOrderItemsBuyerInfoResponse

func (*ClientWithResponses) GetOrderItemsWithResponse 

func (c *ClientWithResponses) GetOrderItemsWithResponse(ctx context.Context, orderId string, params *GetOrderItemsParams) (*GetOrderItemsResp, error)

GetOrderItemsWithResponse request returning *GetOrderItemsResponse

func (*ClientWithResponses) GetOrderWithResponse 

func (c *ClientWithResponses) GetOrderWithResponse(ctx context.Context, orderId string) (*GetOrderResp, error)

GetOrderWithResponse request returning *GetOrderResponse

func (*ClientWithResponses) GetOrdersWithResponse 

func (c *ClientWithResponses) GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams) (*GetOrdersResp, error)

GetOrdersWithResponse request returning *GetOrdersResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetOrders request
	GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams) (*GetOrdersResp, error)

	// GetOrder request
	GetOrderWithResponse(ctx context.Context, orderId string) (*GetOrderResp, error)

	// GetOrderAddress request
	GetOrderAddressWithResponse(ctx context.Context, orderId string) (*GetOrderAddressResp, error)

	// GetOrderBuyerInfo request
	GetOrderBuyerInfoWithResponse(ctx context.Context, orderId string) (*GetOrderBuyerInfoResp, error)

	// GetOrderItems request
	GetOrderItemsWithResponse(ctx context.Context, orderId string, params *GetOrderItemsParams) (*GetOrderItemsResp, error)

	// GetOrderItemsBuyerInfo request
	GetOrderItemsBuyerInfoWithResponse(ctx context.Context, orderId string, params *GetOrderItemsBuyerInfoParams) (*GetOrderItemsBuyerInfoResp, error)
}

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

type Error 

type Error struct {

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

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

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

Error defines model for Error.

type ErrorList 

type ErrorList []Error

ErrorList defines model for ErrorList.

type FulfillmentInstruction 

type FulfillmentInstruction struct {

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

FulfillmentInstruction defines model for FulfillmentInstruction.

type GetOrderAddressResp 

type GetOrderAddressResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetOrderAddressResponse
}

func ParseGetOrderAddressResp 

func ParseGetOrderAddressResp(rsp *http.Response) (*GetOrderAddressResp, error)

ParseGetOrderAddressResp parses an HTTP response from a GetOrderAddressWithResponse call

func (GetOrderAddressResp) Status 

func (r GetOrderAddressResp) Status() string

Status returns HTTPResponse.Status

func (GetOrderAddressResp) StatusCode 

func (r GetOrderAddressResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderAddressResponse 

type GetOrderAddressResponse struct {

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

	// The shipping address for the order.
	Payload *OrderAddress `json:"payload,omitempty"`
}

GetOrderAddressResponse defines model for GetOrderAddressResponse.

type GetOrderBuyerInfoResp 

type GetOrderBuyerInfoResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetOrderBuyerInfoResponse
}

func ParseGetOrderBuyerInfoResp 

func ParseGetOrderBuyerInfoResp(rsp *http.Response) (*GetOrderBuyerInfoResp, error)

ParseGetOrderBuyerInfoResp parses an HTTP response from a GetOrderBuyerInfoWithResponse call

func (GetOrderBuyerInfoResp) Status 

func (r GetOrderBuyerInfoResp) Status() string

Status returns HTTPResponse.Status

func (GetOrderBuyerInfoResp) StatusCode 

func (r GetOrderBuyerInfoResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderBuyerInfoResponse 

type GetOrderBuyerInfoResponse struct {

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

	// Buyer information for an order.
	Payload *OrderBuyerInfo `json:"payload,omitempty"`
}

GetOrderBuyerInfoResponse defines model for GetOrderBuyerInfoResponse.

type GetOrderItemsBuyerInfoParams 

type GetOrderItemsBuyerInfoParams struct {

	// A string token returned in the response of your previous request.
	NextToken *string `json:"NextToken,omitempty"`
}

GetOrderItemsBuyerInfoParams defines parameters for GetOrderItemsBuyerInfo.

type GetOrderItemsBuyerInfoResp 

type GetOrderItemsBuyerInfoResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetOrderItemsBuyerInfoResponse
}

func ParseGetOrderItemsBuyerInfoResp 

func ParseGetOrderItemsBuyerInfoResp(rsp *http.Response) (*GetOrderItemsBuyerInfoResp, error)

ParseGetOrderItemsBuyerInfoResp parses an HTTP response from a GetOrderItemsBuyerInfoWithResponse call

func (GetOrderItemsBuyerInfoResp) Status 

func (r GetOrderItemsBuyerInfoResp) Status() string

Status returns HTTPResponse.Status

func (GetOrderItemsBuyerInfoResp) StatusCode 

func (r GetOrderItemsBuyerInfoResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderItemsBuyerInfoResponse 

type GetOrderItemsBuyerInfoResponse struct {

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

	// A single order item's buyer information list with the order ID.
	Payload *OrderItemsBuyerInfoList `json:"payload,omitempty"`
}

GetOrderItemsBuyerInfoResponse defines model for GetOrderItemsBuyerInfoResponse.

type GetOrderItemsParams 

type GetOrderItemsParams struct {

	// A string token returned in the response of your previous request.
	NextToken *string `json:"NextToken,omitempty"`
}

GetOrderItemsParams defines parameters for GetOrderItems.

type GetOrderItemsResp 

type GetOrderItemsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetOrderItemsResponse
}

func ParseGetOrderItemsResp 

func ParseGetOrderItemsResp(rsp *http.Response) (*GetOrderItemsResp, error)

ParseGetOrderItemsResp parses an HTTP response from a GetOrderItemsWithResponse call

func (GetOrderItemsResp) Status 

func (r GetOrderItemsResp) Status() string

Status returns HTTPResponse.Status

func (GetOrderItemsResp) StatusCode 

func (r GetOrderItemsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderItemsResponse 

type GetOrderItemsResponse struct {

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

	// The order items list along with the order ID.
	Payload *OrderItemsList `json:"payload,omitempty"`
}

GetOrderItemsResponse defines model for GetOrderItemsResponse.

type GetOrderResp 

type GetOrderResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetOrderResponse
}

func ParseGetOrderResp 

func ParseGetOrderResp(rsp *http.Response) (*GetOrderResp, error)

ParseGetOrderResp parses an HTTP response from a GetOrderWithResponse call

func (GetOrderResp) Status 

func (r GetOrderResp) Status() string

Status returns HTTPResponse.Status

func (GetOrderResp) StatusCode 

func (r GetOrderResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderResponse 

type GetOrderResponse struct {

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

	// Order information.
	Payload *Order `json:"payload,omitempty"`
}

GetOrderResponse defines model for GetOrderResponse.

type GetOrdersParams 

type GetOrdersParams struct {

	// A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
	CreatedAfter *string `json:"CreatedAfter,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 date used for selecting orders that were last updated after (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. The date must be in ISO 8601 format.
	LastUpdatedAfter *string `json:"LastUpdatedAfter,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. The date must be in ISO 8601 format.
	LastUpdatedBefore *string `json:"LastUpdatedBefore,omitempty"`

	// A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.).
	OrderStatuses *[]string `json:"OrderStatuses,omitempty"`

	// A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
	MarketplaceIds []string `json:"MarketplaceIds"`

	// A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).
	FulfillmentChannels *[]string `json:"FulfillmentChannels,omitempty"`

	// A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
	PaymentMethods *[]string `json:"PaymentMethods,omitempty"`

	// The email address of a buyer. Used to select orders that contain the specified email address.
	BuyerEmail *string `json:"BuyerEmail,omitempty"`

	// An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
	SellerOrderId *string `json:"SellerOrderId,omitempty"`

	// A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
	MaxResultsPerPage *int `json:"MaxResultsPerPage,omitempty"`

	// A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified  values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller).
	EasyShipShipmentStatuses *[]string `json:"EasyShipShipmentStatuses,omitempty"`

	// A string token returned in the response of your previous request.
	NextToken *string `json:"NextToken,omitempty"`

	// A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderIds *[]string `json:"AmazonOrderIds,omitempty"`
}

GetOrdersParams defines parameters for GetOrders.

type GetOrdersResp 

type GetOrdersResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetOrdersResponse
}

func ParseGetOrdersResp 

func ParseGetOrdersResp(rsp *http.Response) (*GetOrdersResp, error)

ParseGetOrdersResp parses an HTTP response from a GetOrdersWithResponse call

func (GetOrdersResp) Status 

func (r GetOrdersResp) Status() string

Status returns HTTPResponse.Status

func (GetOrdersResp) StatusCode 

func (r GetOrdersResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrdersResponse 

type GetOrdersResponse struct {

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

	// A list of orders along with additional information to make subsequent API calls.
	Payload *OrdersList `json:"payload,omitempty"`
}

GetOrdersResponse defines model for GetOrdersResponse.

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

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 defines model for Money.

type Order 

type Order struct {

	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId string `json:"AmazonOrderId"`

	// The shipping address for the order.
	AssignedShipFromLocationAddress *Address `json:"AssignedShipFromLocationAddress,omitempty"`

	// Custom ship label for Checkout by Amazon (CBA).
	CbaDisplayableShippingLabel *string `json:"CbaDisplayableShippingLabel,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 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 status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.
	//
	// Possible values: PendingPickUp, LabelCanceled, PickedUp, OutForDelivery, Damaged, Delivered, RejectedByBuyer, Undeliverable, ReturnedToSeller, ReturningToSeller.
	EasyShipShipmentStatus *string `json:"EasyShipShipmentStatus,omitempty"`

	// Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN).
	FulfillmentChannel *string `json:"FulfillmentChannel,omitempty"`

	// Contains the instructions about the fulfillment like where should it be fulfilled from.
	FulfillmentInstruction *FulfillmentInstruction `json:"FulfillmentInstruction,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. Returned only 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 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 seller-fulfilled Amazon Prime order.
	IsPrime *bool `json:"IsPrime,omitempty"`

	// When true, this is a replacement order.
	// TODO:https://github.com/amzn/selling-partner-api-docs/issues/278
	IsReplacementOrder *string `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.
	LastUpdateDate string `json:"LastUpdateDate"`

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

	// 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 identifier for the marketplace where the order was placed.
	MarketplaceId *string `json:"MarketplaceId,omitempty"`

	// The number of items shipped.
	NumberOfItemsShipped *int `json:"NumberOfItemsShipped,omitempty"`

	// The number of items unshipped.
	NumberOfItemsUnshipped *int `json:"NumberOfItemsUnshipped,omitempty"`

	// The order channel of the first item in the order.
	OrderChannel *string `json:"OrderChannel,omitempty"`

	// The current order status.
	OrderStatus string `json:"OrderStatus"`

	// The monetary value of the order.
	OrderTotal *Money `json:"OrderTotal,omitempty"`

	// The type of the order.
	OrderType *string `json:"OrderType,omitempty"`

	// A list of payment execution detail items.
	PaymentExecutionDetail *PaymentExecutionDetailItemList `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"`

	// A list of payment method detail items.
	PaymentMethodDetails *PaymentMethodDetailItemList `json:"PaymentMethodDetails,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"`

	// The date when the order was created.
	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 of the first item in the order.
	SalesChannel *string `json:"SalesChannel,omitempty"`

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

	// The shipment service level of the order.
	ShipServiceLevel *string `json:"ShipServiceLevel,omitempty"`

	// The shipment service level category of the order.
	//
	// Possible values: Expedited, FreeEconomy, NextDay, SameDay, SecondDay, Scheduled, Standard.
	ShipmentServiceLevelCategory *string `json:"ShipmentServiceLevelCategory,omitempty"`
}

Order defines model for Order.

type OrderAddress 

type OrderAddress struct {

	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId string `json:"AmazonOrderId"`

	// The shipping address for the order.
	ShippingAddress *Address `json:"ShippingAddress,omitempty"`
}

OrderAddress defines model for OrderAddress.

type OrderBuyerInfo 

type OrderBuyerInfo struct {

	// An Amazon-defined order identifier, in 3-7-7 format.
	AmazonOrderId string `json:"AmazonOrderId"`

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

	// The anonymized email address of the buyer.
	BuyerEmail *string `json:"BuyerEmail,omitempty"`

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

	// Tax information about the buyer.
	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"`
}

OrderBuyerInfo defines model for OrderBuyerInfo.

type OrderItem 

type OrderItem struct {

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

	// The monetary value of the order.
	CODFee *Money `json:"CODFee,omitempty"`

	// The monetary value of the order.
	CODFeeDiscount *Money `json:"CODFeeDiscount,omitempty"`

	// The condition of the item.
	//
	// Possible values: New, Used, Collectible, Refurbished, Preorder, 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, 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.
	DeemedResellerCategory *string `json:"DeemedResellerCategory,omitempty"`

	// The IOSS number of the seller. Sellers selling in the EU will be assigned a unique IOSS number that must be listed on all packages sent to the EU.
	IossNumber *string `json:"IossNumber,omitempty"`

	// When true, the item is a gift.
	// TODO:https://github.com/amzn/selling-partner-api-docs/issues/480
	IsGift *string `json:"IsGift,omitempty"`

	// When true, transparency codes are required.
	IsTransparency *bool `json:"IsTransparency,omitempty"`

	// The monetary value of the order.
	ItemPrice *Money `json:"ItemPrice,omitempty"`

	// The monetary value of the order.
	ItemTax *Money `json:"ItemTax,omitempty"`

	// An Amazon-defined order item identifier.
	OrderItemId string `json:"OrderItemId"`

	// The number of Amazon Points offered with the purchase of an item, and their monetary value.
	PointsGranted *PointsGrantedDetail `json:"PointsGranted,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"`

	// Product information on the number of items.
	ProductInfo *ProductInfoDetail `json:"ProductInfo,omitempty"`

	// The monetary value of the order.
	PromotionDiscount *Money `json:"PromotionDiscount,omitempty"`

	// The monetary value of the order.
	PromotionDiscountTax *Money `json:"PromotionDiscountTax,omitempty"`

	// A list of promotion identifiers provided by the seller when the promotions were created.
	PromotionIds *PromotionIdList `json:"PromotionIds,omitempty"`

	// The number of items in the order.
	QuantityOrdered int `json:"QuantityOrdered"`

	// The number of items shipped.
	QuantityShipped *int `json:"QuantityShipped,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"`

	// 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 seller stock keeping unit (SKU) of the item.
	SellerSKU *string `json:"SellerSKU,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"`

	// The monetary value of the order.
	ShippingDiscount *Money `json:"ShippingDiscount,omitempty"`

	// The monetary value of the order.
	ShippingDiscountTax *Money `json:"ShippingDiscountTax,omitempty"`

	// The monetary value of the order.
	ShippingPrice *Money `json:"ShippingPrice,omitempty"`

	// The monetary value of the order.
	ShippingTax *Money `json:"ShippingTax,omitempty"`

	// Information about withheld taxes.
	TaxCollection *TaxCollection `json:"TaxCollection,omitempty"`

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

OrderItem defines model for OrderItem.

type OrderItemBuyerInfo 

type OrderItemBuyerInfo struct {

	// Buyer information for custom orders from the Amazon Custom program.
	BuyerCustomizedInfo *BuyerCustomizedInfoDetail `json:"BuyerCustomizedInfo,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"`

	// The monetary value of the order.
	GiftWrapPrice *Money `json:"GiftWrapPrice,omitempty"`

	// The monetary value of the order.
	GiftWrapTax *Money `json:"GiftWrapTax,omitempty"`

	// An Amazon-defined order item identifier.
	OrderItemId string `json:"OrderItemId"`
}

OrderItemBuyerInfo defines model for OrderItemBuyerInfo.

type OrderItemBuyerInfoList 

type OrderItemBuyerInfoList []OrderItemBuyerInfo

OrderItemBuyerInfoList defines model for OrderItemBuyerInfoList.

type OrderItemList 

type OrderItemList []OrderItem

OrderItemList defines model for OrderItemList.

type OrderItemsBuyerInfoList 

type OrderItemsBuyerInfoList struct {

	// An Amazon-defined order identifier, in 3-7-7 format.
	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"`

	// A single order item's buyer information list.
	OrderItems OrderItemBuyerInfoList `json:"OrderItems"`
}

OrderItemsBuyerInfoList defines model for OrderItemsBuyerInfoList.

type OrderItemsList 

type OrderItemsList struct {

	// An Amazon-defined order identifier, in 3-7-7 format.
	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"`

	// A list of order items.
	OrderItems OrderItemList `json:"OrderItems"`
}

OrderItemsList defines model for OrderItemsList.

type OrderList 

type OrderList []Order

OrderList defines model for OrderList.

type OrdersList 

type OrdersList struct {

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

	// 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 list of orders.
	Orders OrderList `json:"Orders"`
}

OrdersList defines model for OrdersList.

type PaymentExecutionDetailItem 

type PaymentExecutionDetailItem struct {

	// The monetary value of the order.
	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"`
}

PaymentExecutionDetailItem defines model for PaymentExecutionDetailItem.

type PaymentExecutionDetailItemList 

type PaymentExecutionDetailItemList []PaymentExecutionDetailItem

PaymentExecutionDetailItemList defines model for PaymentExecutionDetailItemList.

type PaymentMethodDetailItemList 

type PaymentMethodDetailItemList []string

PaymentMethodDetailItemList defines model for PaymentMethodDetailItemList.

type PointsGrantedDetail 

type PointsGrantedDetail struct {

	// The monetary value of the order.
	PointsMonetaryValue *Money `json:"PointsMonetaryValue,omitempty"`

	// The number of Amazon Points granted with the purchase of an item.
	PointsNumber *int `json:"PointsNumber,omitempty"`
}

PointsGrantedDetail defines model for PointsGrantedDetail.

type ProductInfoDetail 

type ProductInfoDetail struct {

	// The total number of items that are included in the ASIN.
	// TODO:https://github.com/amzn/selling-partner-api-docs/issues/480
	NumberOfItems *string `json:"NumberOfItems,omitempty"`
}

ProductInfoDetail defines model for ProductInfoDetail.

type PromotionIdList 

type PromotionIdList []string

PromotionIdList defines model for PromotionIdList.

type RequestBeforeFn 

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

RequestBeforeFn is the function signature for the RequestBefore callback function

type ResponseAfterFn 

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

ResponseAfterFn is the function signature for the ResponseAfter callback function

type TaxClassification 

type TaxClassification struct {

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

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

TaxClassification defines model for TaxClassification.

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

TaxCollection defines model for TaxCollection.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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