fbaInventory

package
v0.0.0-...-3a03c6d Latest Latest
Warning

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

 Go to latest Published: May 29, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package fbaInventory provides primitives to interact the openapi HTTP API.

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

Package fbaInventory 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 NewGetInventorySummariesRequest 

func NewGetInventorySummariesRequest(endpoint string, params *GetInventorySummariesParams) (*http.Request, error)

NewGetInventorySummariesRequest generates requests for GetInventorySummaries

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.
	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) GetInventorySummaries 

func (c *Client) GetInventorySummaries(ctx context.Context, params *GetInventorySummariesParams) (*http.Response, error)

type ClientInterface 

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

func (c *ClientWithResponses) GetInventorySummariesWithResponse(ctx context.Context, params *GetInventorySummariesParams) (*GetInventorySummariesResp, error)

GetInventorySummariesWithResponse request returning *GetInventorySummariesResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetInventorySummaries request
	GetInventorySummariesWithResponse(ctx context.Context, params *GetInventorySummariesParams) (*GetInventorySummariesResp, 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 information 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,omitempty"`
}

Error defines model for Error.

type ErrorList 

type ErrorList []Error

ErrorList defines model for ErrorList.

type GetInventorySummariesParams 

type GetInventorySummariesParams struct {

	// true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
	Details *bool `json:"details,omitempty"`

	// The granularity type for the inventory aggregation level.
	GranularityType string `json:"granularityType"`

	// The granularity ID for the inventory aggregation level.
	GranularityId string `json:"granularityId"`

	// A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
	StartDateTime *time.Time `json:"startDateTime,omitempty"`

	// A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
	SellerSkus *[]string `json:"sellerSkus,omitempty"`

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

	// The marketplace ID for the marketplace for which to return inventory summaries.
	MarketplaceIds []string `json:"marketplaceIds"`
}

GetInventorySummariesParams defines parameters for GetInventorySummaries.

type GetInventorySummariesResp 

type GetInventorySummariesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	Model        *GetInventorySummariesResponse
}

func ParseGetInventorySummariesResp 

func ParseGetInventorySummariesResp(rsp *http.Response) (*GetInventorySummariesResp, error)

ParseGetInventorySummariesResp parses an HTTP response from a GetInventorySummariesWithResponse call

func (GetInventorySummariesResp) Status 

func (r GetInventorySummariesResp) Status() string

Status returns HTTPResponse.Status

func (GetInventorySummariesResp) StatusCode 

func (r GetInventorySummariesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInventorySummariesResponse 

type GetInventorySummariesResponse struct {

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

	// The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management.
	Pagination *Pagination `json:"pagination,omitempty"`

	// The payload schema for the getInventorySummaries operation.
	Payload *GetInventorySummariesResult `json:"payload,omitempty"`
}

GetInventorySummariesResponse defines model for GetInventorySummariesResponse.

type GetInventorySummariesResult 

type GetInventorySummariesResult struct {

	// Describes a granularity at which inventory data can be aggregated. For example, if you use Marketplace granularity, the fulfillable quantity will reflect inventory that could be fulfilled in the given marketplace.
	Granularity Granularity `json:"granularity"`

	// A list of inventory summaries.
	InventorySummaries InventorySummaries `json:"inventorySummaries"`
}

GetInventorySummariesResult defines model for GetInventorySummariesResult.

type Granularity 

type Granularity struct {

	// The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId.
	GranularityId *string `json:"granularityId,omitempty"`

	// The granularity type for the inventory aggregation level.
	GranularityType *string `json:"granularityType,omitempty"`
}

Granularity defines model for Granularity.

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InventoryDetails 

type InventoryDetails struct {

	// The item quantity that can be picked, packed, and shipped.
	FulfillableQuantity *int `json:"fulfillableQuantity,omitempty"`

	// The number of units that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed.
	InboundReceivingQuantity *int `json:"inboundReceivingQuantity,omitempty"`

	// The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number.
	InboundShippedQuantity *int `json:"inboundShippedQuantity,omitempty"`

	// The number of units in an inbound shipment for which you have notified Amazon.
	InboundWorkingQuantity *int `json:"inboundWorkingQuantity,omitempty"`

	// The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers.
	ResearchingQuantity *ResearchingQuantity `json:"researchingQuantity,omitempty"`

	// The quantity of reserved inventory.
	ReservedQuantity *ReservedQuantity `json:"reservedQuantity,omitempty"`

	// The quantity of unfulfillable inventory.
	UnfulfillableQuantity *UnfulfillableQuantity `json:"unfulfillableQuantity,omitempty"`
}

InventoryDetails defines model for InventoryDetails.

type InventorySummaries 

type InventorySummaries []InventorySummary

InventorySummaries defines model for InventorySummaries.

type InventorySummary 

type InventorySummary struct {

	// The Amazon Standard Identification Number (ASIN) of an item.
	Asin *string `json:"asin,omitempty"`

	// The condition of the item as described by the seller (for example, New Item).
	Condition *string `json:"condition,omitempty"`

	// Amazon's fulfillment network SKU identifier.
	FnSku *string `json:"fnSku,omitempty"`

	// Summarized inventory details. This object will not appear if the details parameter in the request is false.
	InventoryDetails *InventoryDetails `json:"inventoryDetails,omitempty"`

	// The date and time that any quantity was last updated.
	LastUpdatedTime *time.Time `json:"lastUpdatedTime,omitempty"`

	// The localized language product title of the item within the specific marketplace.
	ProductName *string `json:"productName,omitempty"`

	// The seller SKU of the item.
	SellerSku *string `json:"sellerSku,omitempty"`

	// The total number of units in an inbound shipment or in Amazon fulfillment centers.
	TotalQuantity *int `json:"totalQuantity,omitempty"`
}

InventorySummary defines model for InventorySummary.

type Pagination 

type Pagination struct {

	// A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.
	NextToken *string `json:"nextToken,omitempty"`
}

Pagination defines model for Pagination.

type RequestBeforeFn 

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

RequestBeforeFn is the function signature for the RequestBefore callback function

type ResearchingQuantity 

type ResearchingQuantity struct {

	// A list of quantity details for items currently being researched.
	ResearchingQuantityBreakdown *[]ResearchingQuantityEntry `json:"researchingQuantityBreakdown,omitempty"`

	// The total number of units currently being researched in Amazon's fulfillment network.
	TotalResearchingQuantity *int `json:"totalResearchingQuantity,omitempty"`
}

ResearchingQuantity defines model for ResearchingQuantity.

type ResearchingQuantityEntry 

type ResearchingQuantityEntry struct {

	// The duration of the research.
	Name string `json:"name"`

	// The number of units.
	Quantity int `json:"quantity"`
}

ResearchingQuantityEntry defines model for ResearchingQuantityEntry.

type ReservedQuantity 

type ReservedQuantity struct {

	// The number of units that have been sidelined at the fulfillment center for additional processing.
	FcProcessingQuantity *int `json:"fcProcessingQuantity,omitempty"`

	// The number of units reserved for customer orders.
	PendingCustomerOrderQuantity *int `json:"pendingCustomerOrderQuantity,omitempty"`

	// The number of units being transferred from one fulfillment center to another.
	PendingTransshipmentQuantity *int `json:"pendingTransshipmentQuantity,omitempty"`

	// The total number of units in Amazon's fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes.
	TotalReservedQuantity *int `json:"totalReservedQuantity,omitempty"`
}

ReservedQuantity defines model for ReservedQuantity.

type ResponseAfterFn 

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

ResponseAfterFn is the function signature for the ResponseAfter callback function

type UnfulfillableQuantity 

type UnfulfillableQuantity struct {

	// The number of units in carrier damaged disposition.
	CarrierDamagedQuantity *int `json:"carrierDamagedQuantity,omitempty"`

	// The number of units in customer damaged disposition.
	CustomerDamagedQuantity *int `json:"customerDamagedQuantity,omitempty"`

	// The number of units in defective disposition.
	DefectiveQuantity *int `json:"defectiveQuantity,omitempty"`

	// The number of units in distributor damaged disposition.
	DistributorDamagedQuantity *int `json:"distributorDamagedQuantity,omitempty"`

	// The number of units in expired disposition.
	ExpiredQuantity *int `json:"expiredQuantity,omitempty"`

	// The total number of units in Amazon's fulfillment network in unsellable condition.
	TotalUnfulfillableQuantity *int `json:"totalUnfulfillableQuantity,omitempty"`

	// The number of units in warehouse damaged disposition.
	WarehouseDamagedQuantity *int `json:"warehouseDamagedQuantity,omitempty"`
}

UnfulfillableQuantity defines model for UnfulfillableQuantity.

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.