fbaInbound

package
v2.0.1 Latest Latest
Warning

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

 Go to latest Published: Mar 27, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package fbaInbound provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.6.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source 
var (
	JSONMarshal    = json.Marshal
	JSONUnmarshal  = json.Unmarshal
	JSONNewDecoder = func(r io.Reader) interface{ Decode(v any) error } { return json.NewDecoder(r) }
	JSONNewEncoder = func(w io.Writer) interface{ Encode(v any) error } { return json.NewEncoder(w) }
)
View Source 
var DefaultRetryOptions = RetryOptions{
	MaxRetries: 3,
	RetryOn: func(resp *http.Response, err error) bool {
		if err != nil {
			return true
		}

		if resp.StatusCode == 429 || resp.StatusCode >= 500 {
			return true
		}
		return false
	},
	Backoff: func(attempt int, resp *http.Response) time.Duration {

		return time.Duration(100*(1<<uint(attempt))) * time.Millisecond
	},
}

DefaultRetryOptions provides a basic DIY example for SP-API retries.

Functions

func NewGetItemEligibilityPreviewRequest 

func NewGetItemEligibilityPreviewRequest(server string, params *GetItemEligibilityPreviewParams) (*http.Request, error)

NewGetItemEligibilityPreviewRequest generates requests for GetItemEligibilityPreview

Types

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.
	Server string

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

	// 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(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetItemEligibilityPreview 

func (c *Client) GetItemEligibilityPreview(ctx context.Context, params *GetItemEligibilityPreviewParams) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetItemEligibilityPreview request
	GetItemEligibilityPreview(ctx context.Context, params *GetItemEligibilityPreviewParams) (*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.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

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

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

func (*ClientWithResponses) GetItemEligibilityPreviewWithResponse 

func (c *ClientWithResponses) GetItemEligibilityPreviewWithResponse(ctx context.Context, params *GetItemEligibilityPreviewParams) (*GetItemEligibilityPreviewResp, error)

GetItemEligibilityPreviewWithResponse request returning *GetItemEligibilityPreviewResp

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetItemEligibilityPreviewWithResponse request
	GetItemEligibilityPreviewWithResponse(ctx context.Context, params *GetItemEligibilityPreviewParams) (*GetItemEligibilityPreviewResp, error)
}

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

type Error 

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

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

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

Error Error response returned when the request is unsuccessful.

type ErrorList 

type ErrorList = []Error

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

type GetItemEligibilityPreviewParams 

type GetItemEligibilityPreviewParams struct {
	// MarketplaceIds The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
	MarketplaceIds *[]string `form:"marketplaceIds,omitempty" json:"marketplaceIds,omitempty"`

	// Asin The ASIN of the item for which you want an eligibility preview.
	Asin string `form:"asin" json:"asin"`

	// Program The program that you want to check eligibility against.
	Program GetItemEligibilityPreviewParamsProgram `form:"program" json:"program"`
}

GetItemEligibilityPreviewParams defines parameters for GetItemEligibilityPreview.

type GetItemEligibilityPreviewParamsProgram 

type GetItemEligibilityPreviewParamsProgram string

GetItemEligibilityPreviewParamsProgram defines parameters for GetItemEligibilityPreview. 

const (
	GetItemEligibilityPreviewParamsProgramCOMMINGLING GetItemEligibilityPreviewParamsProgram = "COMMINGLING"
	GetItemEligibilityPreviewParamsProgramINBOUND     GetItemEligibilityPreviewParamsProgram = "INBOUND"
)

Defines values for GetItemEligibilityPreviewParamsProgram.

type GetItemEligibilityPreviewResp 

type GetItemEligibilityPreviewResp struct {
	Body         []byte // Might be nil if decoded via streaming
	HTTPResponse *http.Response
	JSON200      *GetItemEligibilityPreviewResponse
	JSON400      *GetItemEligibilityPreviewResponse
	JSON401      *GetItemEligibilityPreviewResponse
	JSON403      *GetItemEligibilityPreviewResponse
	JSON404      *GetItemEligibilityPreviewResponse
	JSON429      *GetItemEligibilityPreviewResponse
	JSON500      *GetItemEligibilityPreviewResponse
	JSON503      *GetItemEligibilityPreviewResponse
}

func ParseGetItemEligibilityPreviewResp 

func ParseGetItemEligibilityPreviewResp(rsp *http.Response) (*GetItemEligibilityPreviewResp, error)

ParseGetItemEligibilityPreviewResp parses an HTTP response from a GetItemEligibilityPreviewWithResponse call

func (GetItemEligibilityPreviewResp) Status 

func (r GetItemEligibilityPreviewResp) Status() string

Status returns HTTPResponse.Status

func (GetItemEligibilityPreviewResp) StatusCode 

func (r GetItemEligibilityPreviewResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetItemEligibilityPreviewResponse 

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

	// Payload The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes.
	Payload *ItemEligibilityPreview `json:"payload,omitempty"`
}

GetItemEligibilityPreviewResponse The response schema for the getItemEligibilityPreview operation.

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ItemEligibilityPreview 

type ItemEligibilityPreview struct {
	// Asin The ASIN for which eligibility was determined.
	Asin string `json:"asin"`

	// IneligibilityReasonList Potential Ineligibility Reason Codes.
	IneligibilityReasonList *[]ItemEligibilityPreviewIneligibilityReasonList `json:"ineligibilityReasonList,omitempty"`

	// IsEligibleForProgram Indicates if the item is eligible for the program.
	IsEligibleForProgram bool `json:"isEligibleForProgram"`

	// MarketplaceId The marketplace for which eligibility was determined.
	MarketplaceId *string `json:"marketplaceId,omitempty"`

	// Program The program for which eligibility was determined.
	Program ItemEligibilityPreviewProgram `json:"program"`
}

ItemEligibilityPreview The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes.

type ItemEligibilityPreviewIneligibilityReasonList 

type ItemEligibilityPreviewIneligibilityReasonList string

ItemEligibilityPreviewIneligibilityReasonList Potential Ineligibility Reason Codes. 

const (
	FBAINB0004          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0004"
	FBAINB0006          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0006"
	FBAINB0007          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0007"
	FBAINB0008          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0008"
	FBAINB0009          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0009"
	FBAINB0010          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0010"
	FBAINB0011          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0011"
	FBAINB0012          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0012"
	FBAINB0013          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0013"
	FBAINB0014          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0014"
	FBAINB0015          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0015"
	FBAINB0016          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0016"
	FBAINB0017          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0017"
	FBAINB0018          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0018"
	FBAINB0019          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0019"
	FBAINB0034          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0034"
	FBAINB0035          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0035"
	FBAINB0036          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0036"
	FBAINB0037          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0037"
	FBAINB0038          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0038"
	FBAINB0050          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0050"
	FBAINB0051          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0051"
	FBAINB0053          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0053"
	FBAINB0055          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0055"
	FBAINB0056          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0056"
	FBAINB0059          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0059"
	FBAINB0065          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0065"
	FBAINB0066          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0066"
	FBAINB0067          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0067"
	FBAINB0068          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0068"
	FBAINB0095          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0095"
	FBAINB0097          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0097"
	FBAINB0098          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0098"
	FBAINB0099          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0099"
	FBAINB0100          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0100"
	FBAINB0103          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0103"
	FBAINB0104          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0104"
	FBAINB0197          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0197"
	FBAINB0342          ItemEligibilityPreviewIneligibilityReasonList = "FBA_INB_0342"
	UNKNOWNINBERRORCODE ItemEligibilityPreviewIneligibilityReasonList = "UNKNOWN_INB_ERROR_CODE"
)

Defines values for ItemEligibilityPreviewIneligibilityReasonList.

type ItemEligibilityPreviewProgram 

type ItemEligibilityPreviewProgram string

ItemEligibilityPreviewProgram The program for which eligibility was determined. 

const (
	ItemEligibilityPreviewProgramCOMMINGLING ItemEligibilityPreviewProgram = "COMMINGLING"
	ItemEligibilityPreviewProgramINBOUND     ItemEligibilityPreviewProgram = "INBOUND"
)

Defines values for ItemEligibilityPreviewProgram.

type RetryOptions 

type RetryOptions struct {
	MaxRetries int
	// RetryOn returns true if the request should be retried.
	RetryOn func(resp *http.Response, err error) bool
	// Backoff returns the duration to wait before the next retry.
	// It can use the attempt count or inspect response headers (e.g., x-amzn-RateLimit-Limit).
	Backoff func(attempt int, resp *http.Response) time.Duration
}

RetryOptions defines the configuration for RetryTransport. It allows users to DIY their retry strategy, such as exponential backoff or header-based rate-limit backoff.

type RetryTransport 

type RetryTransport struct {
	Next    http.RoundTripper
	Options RetryOptions
}

RetryTransport is an http.RoundTripper that retries requests based on RetryOptions.

func (*RetryTransport) RoundTrip 

func (t *RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements http.RoundTripper

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.