fba_inventory

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Dec 14, 2023 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client for fba inventory API

func (*Client) GetInventorySummaries

func (a *Client) GetInventorySummaries(params *GetInventorySummariesParams, opts ...ClientOption) (*GetInventorySummariesOK, error)
GetInventorySummaries Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters:

- All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`.

**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).

**Usage Plan:**

| Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |

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

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	GetInventorySummaries(params *GetInventorySummariesParams, opts ...ClientOption) (*GetInventorySummariesOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new fba inventory API client.

type GetInventorySummariesBadRequest

type GetInventorySummariesBadRequest struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference ID.
	 */
	XAmznRequestID string

	Payload *fba_inventory_models.GetInventorySummariesResponse
}

GetInventorySummariesBadRequest describes a response with status code 400, with default header values.

Request has missing or invalid parameters and cannot be parsed.

func NewGetInventorySummariesBadRequest

func NewGetInventorySummariesBadRequest() *GetInventorySummariesBadRequest

NewGetInventorySummariesBadRequest creates a GetInventorySummariesBadRequest with default headers values

func (*GetInventorySummariesBadRequest) Error

func (*GetInventorySummariesBadRequest) GetPayload

func (*GetInventorySummariesBadRequest) IsClientError

func (o *GetInventorySummariesBadRequest) IsClientError() bool

IsClientError returns true when this get inventory summaries bad request response has a 4xx status code

func (*GetInventorySummariesBadRequest) IsCode

func (o *GetInventorySummariesBadRequest) IsCode(code int) bool

IsCode returns true when this get inventory summaries bad request response a status code equal to that given

func (*GetInventorySummariesBadRequest) IsRedirect

func (o *GetInventorySummariesBadRequest) IsRedirect() bool

IsRedirect returns true when this get inventory summaries bad request response has a 3xx status code

func (*GetInventorySummariesBadRequest) IsServerError

func (o *GetInventorySummariesBadRequest) IsServerError() bool

IsServerError returns true when this get inventory summaries bad request response has a 5xx status code

func (*GetInventorySummariesBadRequest) IsSuccess

func (o *GetInventorySummariesBadRequest) IsSuccess() bool

IsSuccess returns true when this get inventory summaries bad request response has a 2xx status code

func (*GetInventorySummariesBadRequest) String

type GetInventorySummariesForbidden

type GetInventorySummariesForbidden struct {

	/* Unique request reference ID.
	 */
	XAmznRequestID string

	Payload *fba_inventory_models.GetInventorySummariesResponse
}

GetInventorySummariesForbidden describes a response with status code 403, with default header values.

Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.

func NewGetInventorySummariesForbidden

func NewGetInventorySummariesForbidden() *GetInventorySummariesForbidden

NewGetInventorySummariesForbidden creates a GetInventorySummariesForbidden with default headers values

func (*GetInventorySummariesForbidden) Error

func (*GetInventorySummariesForbidden) GetPayload

func (*GetInventorySummariesForbidden) IsClientError

func (o *GetInventorySummariesForbidden) IsClientError() bool

IsClientError returns true when this get inventory summaries forbidden response has a 4xx status code

func (*GetInventorySummariesForbidden) IsCode

func (o *GetInventorySummariesForbidden) IsCode(code int) bool

IsCode returns true when this get inventory summaries forbidden response a status code equal to that given

func (*GetInventorySummariesForbidden) IsRedirect

func (o *GetInventorySummariesForbidden) IsRedirect() bool

IsRedirect returns true when this get inventory summaries forbidden response has a 3xx status code

func (*GetInventorySummariesForbidden) IsServerError

func (o *GetInventorySummariesForbidden) IsServerError() bool

IsServerError returns true when this get inventory summaries forbidden response has a 5xx status code

func (*GetInventorySummariesForbidden) IsSuccess

func (o *GetInventorySummariesForbidden) IsSuccess() bool

IsSuccess returns true when this get inventory summaries forbidden response has a 2xx status code

func (*GetInventorySummariesForbidden) String

type GetInventorySummariesInternalServerError

type GetInventorySummariesInternalServerError struct {

	/* Your rate limit (requests per second) for this operation.
	_Note:_ For this status code, the rate limit header is deprecated and no longer returned.
	*/
	XAmznRateLimitLimit string

	/* Unique request reference ID.
	 */
	XAmznRequestID string

	Payload *fba_inventory_models.GetInventorySummariesResponse
}

GetInventorySummariesInternalServerError describes a response with status code 500, with default header values.

An unexpected condition occurred that prevented the server from fulfilling the request.

func NewGetInventorySummariesInternalServerError

func NewGetInventorySummariesInternalServerError() *GetInventorySummariesInternalServerError

NewGetInventorySummariesInternalServerError creates a GetInventorySummariesInternalServerError with default headers values

func (*GetInventorySummariesInternalServerError) Error

func (*GetInventorySummariesInternalServerError) GetPayload

func (*GetInventorySummariesInternalServerError) IsClientError

IsClientError returns true when this get inventory summaries internal server error response has a 4xx status code

func (*GetInventorySummariesInternalServerError) IsCode

IsCode returns true when this get inventory summaries internal server error response a status code equal to that given

func (*GetInventorySummariesInternalServerError) IsRedirect

IsRedirect returns true when this get inventory summaries internal server error response has a 3xx status code

func (*GetInventorySummariesInternalServerError) IsServerError

IsServerError returns true when this get inventory summaries internal server error response has a 5xx status code

func (*GetInventorySummariesInternalServerError) IsSuccess

IsSuccess returns true when this get inventory summaries internal server error response has a 2xx status code

func (*GetInventorySummariesInternalServerError) String

type GetInventorySummariesNotFound

type GetInventorySummariesNotFound struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference ID.
	 */
	XAmznRequestID string

	Payload *fba_inventory_models.GetInventorySummariesResponse
}

GetInventorySummariesNotFound describes a response with status code 404, with default header values.

The specified resource does not exist.

func NewGetInventorySummariesNotFound

func NewGetInventorySummariesNotFound() *GetInventorySummariesNotFound

NewGetInventorySummariesNotFound creates a GetInventorySummariesNotFound with default headers values

func (*GetInventorySummariesNotFound) Error

func (*GetInventorySummariesNotFound) GetPayload

func (*GetInventorySummariesNotFound) IsClientError

func (o *GetInventorySummariesNotFound) IsClientError() bool

IsClientError returns true when this get inventory summaries not found response has a 4xx status code

func (*GetInventorySummariesNotFound) IsCode

func (o *GetInventorySummariesNotFound) IsCode(code int) bool

IsCode returns true when this get inventory summaries not found response a status code equal to that given

func (*GetInventorySummariesNotFound) IsRedirect

func (o *GetInventorySummariesNotFound) IsRedirect() bool

IsRedirect returns true when this get inventory summaries not found response has a 3xx status code

func (*GetInventorySummariesNotFound) IsServerError

func (o *GetInventorySummariesNotFound) IsServerError() bool

IsServerError returns true when this get inventory summaries not found response has a 5xx status code

func (*GetInventorySummariesNotFound) IsSuccess

func (o *GetInventorySummariesNotFound) IsSuccess() bool

IsSuccess returns true when this get inventory summaries not found response has a 2xx status code

func (*GetInventorySummariesNotFound) String

type GetInventorySummariesOK

type GetInventorySummariesOK struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference ID.
	 */
	XAmznRequestID string

	Payload *fba_inventory_models.GetInventorySummariesResponse
}

GetInventorySummariesOK describes a response with status code 200, with default header values.

OK

func NewGetInventorySummariesOK

func NewGetInventorySummariesOK() *GetInventorySummariesOK

NewGetInventorySummariesOK creates a GetInventorySummariesOK with default headers values

func (*GetInventorySummariesOK) Error

func (o *GetInventorySummariesOK) Error() string

func (*GetInventorySummariesOK) GetPayload

func (*GetInventorySummariesOK) IsClientError

func (o *GetInventorySummariesOK) IsClientError() bool

IsClientError returns true when this get inventory summaries o k response has a 4xx status code

func (*GetInventorySummariesOK) IsCode

func (o *GetInventorySummariesOK) IsCode(code int) bool

IsCode returns true when this get inventory summaries o k response a status code equal to that given

func (*GetInventorySummariesOK) IsRedirect

func (o *GetInventorySummariesOK) IsRedirect() bool

IsRedirect returns true when this get inventory summaries o k response has a 3xx status code

func (*GetInventorySummariesOK) IsServerError

func (o *GetInventorySummariesOK) IsServerError() bool

IsServerError returns true when this get inventory summaries o k response has a 5xx status code

func (*GetInventorySummariesOK) IsSuccess

func (o *GetInventorySummariesOK) IsSuccess() bool

IsSuccess returns true when this get inventory summaries o k response has a 2xx status code

func (*GetInventorySummariesOK) String

func (o *GetInventorySummariesOK) String() string

type GetInventorySummariesParams

type GetInventorySummariesParams struct {

	/* Details.

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

	/* GranularityID.

	   The granularity ID for the inventory aggregation level.
	*/
	GranularityID string

	/* GranularityType.

	   The granularity type for the inventory aggregation level.
	*/
	GranularityType string

	/* MarketplaceIds.

	   The marketplace ID for the marketplace for which to return inventory summaries.
	*/
	MarketplaceIds []string

	/* NextToken.

	   String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
	*/
	NextToken *string

	/* SellerSku.

	   A single seller SKU used for querying the specified seller SKU inventory summaries.
	*/
	SellerSku *string

	/* SellerSkus.

	   A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
	*/
	SellerSkus []string

	/* StartDateTime.

	   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.

	   Format: date-time
	*/
	StartDateTime *strfmt.DateTime

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetInventorySummariesParams contains all the parameters to send to the API endpoint

for the get inventory summaries operation.

Typically these are written to a http.Request.

func NewGetInventorySummariesParams

func NewGetInventorySummariesParams() *GetInventorySummariesParams

NewGetInventorySummariesParams creates a new GetInventorySummariesParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetInventorySummariesParamsWithContext

func NewGetInventorySummariesParamsWithContext(ctx context.Context) *GetInventorySummariesParams

NewGetInventorySummariesParamsWithContext creates a new GetInventorySummariesParams object with the ability to set a context for a request.

func NewGetInventorySummariesParamsWithHTTPClient

func NewGetInventorySummariesParamsWithHTTPClient(client *http.Client) *GetInventorySummariesParams

NewGetInventorySummariesParamsWithHTTPClient creates a new GetInventorySummariesParams object with the ability to set a custom HTTPClient for a request.

func NewGetInventorySummariesParamsWithTimeout

func NewGetInventorySummariesParamsWithTimeout(timeout time.Duration) *GetInventorySummariesParams

NewGetInventorySummariesParamsWithTimeout creates a new GetInventorySummariesParams object with the ability to set a timeout on a request.

func (*GetInventorySummariesParams) SetContext

func (o *GetInventorySummariesParams) SetContext(ctx context.Context)

SetContext adds the context to the get inventory summaries params

func (*GetInventorySummariesParams) SetDefaults

func (o *GetInventorySummariesParams) SetDefaults()

SetDefaults hydrates default values in the get inventory summaries params (not the query body).

All values with no default are reset to their zero value.

func (*GetInventorySummariesParams) SetDetails

func (o *GetInventorySummariesParams) SetDetails(details *bool)

SetDetails adds the details to the get inventory summaries params

func (*GetInventorySummariesParams) SetGranularityID

func (o *GetInventorySummariesParams) SetGranularityID(granularityID string)

SetGranularityID adds the granularityId to the get inventory summaries params

func (*GetInventorySummariesParams) SetGranularityType

func (o *GetInventorySummariesParams) SetGranularityType(granularityType string)

SetGranularityType adds the granularityType to the get inventory summaries params

func (*GetInventorySummariesParams) SetHTTPClient

func (o *GetInventorySummariesParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get inventory summaries params

func (*GetInventorySummariesParams) SetMarketplaceIds

func (o *GetInventorySummariesParams) SetMarketplaceIds(marketplaceIds []string)

SetMarketplaceIds adds the marketplaceIds to the get inventory summaries params

func (*GetInventorySummariesParams) SetNextToken

func (o *GetInventorySummariesParams) SetNextToken(nextToken *string)

SetNextToken adds the nextToken to the get inventory summaries params

func (*GetInventorySummariesParams) SetSellerSku

func (o *GetInventorySummariesParams) SetSellerSku(sellerSku *string)

SetSellerSku adds the sellerSku to the get inventory summaries params

func (*GetInventorySummariesParams) SetSellerSkus

func (o *GetInventorySummariesParams) SetSellerSkus(sellerSkus []string)

SetSellerSkus adds the sellerSkus to the get inventory summaries params

func (*GetInventorySummariesParams) SetStartDateTime

func (o *GetInventorySummariesParams) SetStartDateTime(startDateTime *strfmt.DateTime)

SetStartDateTime adds the startDateTime to the get inventory summaries params

func (*GetInventorySummariesParams) SetTimeout

func (o *GetInventorySummariesParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get inventory summaries params

func (*GetInventorySummariesParams) WithContext

WithContext adds the context to the get inventory summaries params

func (*GetInventorySummariesParams) WithDefaults

WithDefaults hydrates default values in the get inventory summaries params (not the query body).

All values with no default are reset to their zero value.

func (*GetInventorySummariesParams) WithDetails

WithDetails adds the details to the get inventory summaries params

func (*GetInventorySummariesParams) WithGranularityID

func (o *GetInventorySummariesParams) WithGranularityID(granularityID string) *GetInventorySummariesParams

WithGranularityID adds the granularityID to the get inventory summaries params

func (*GetInventorySummariesParams) WithGranularityType

func (o *GetInventorySummariesParams) WithGranularityType(granularityType string) *GetInventorySummariesParams

WithGranularityType adds the granularityType to the get inventory summaries params

func (*GetInventorySummariesParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get inventory summaries params

func (*GetInventorySummariesParams) WithMarketplaceIds

func (o *GetInventorySummariesParams) WithMarketplaceIds(marketplaceIds []string) *GetInventorySummariesParams

WithMarketplaceIds adds the marketplaceIds to the get inventory summaries params

func (*GetInventorySummariesParams) WithNextToken

func (o *GetInventorySummariesParams) WithNextToken(nextToken *string) *GetInventorySummariesParams

WithNextToken adds the nextToken to the get inventory summaries params

func (*GetInventorySummariesParams) WithSellerSku

func (o *GetInventorySummariesParams) WithSellerSku(sellerSku *string) *GetInventorySummariesParams

WithSellerSku adds the sellerSku to the get inventory summaries params

func (*GetInventorySummariesParams) WithSellerSkus

func (o *GetInventorySummariesParams) WithSellerSkus(sellerSkus []string) *GetInventorySummariesParams

WithSellerSkus adds the sellerSkus to the get inventory summaries params

func (*GetInventorySummariesParams) WithStartDateTime

func (o *GetInventorySummariesParams) WithStartDateTime(startDateTime *strfmt.DateTime) *GetInventorySummariesParams

WithStartDateTime adds the startDateTime to the get inventory summaries params

func (*GetInventorySummariesParams) WithTimeout

WithTimeout adds the timeout to the get inventory summaries params

func (*GetInventorySummariesParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetInventorySummariesReader

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

GetInventorySummariesReader is a Reader for the GetInventorySummaries structure.

func (*GetInventorySummariesReader) ReadResponse

func (o *GetInventorySummariesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetInventorySummariesServiceUnavailable

type GetInventorySummariesServiceUnavailable struct {

	/* Your rate limit (requests per second) for this operation.
	_Note:_ For this status code, the rate limit header is deprecated and no longer returned.
	*/
	XAmznRateLimitLimit string

	/* Unique request reference ID.
	 */
	XAmznRequestID string

	Payload *fba_inventory_models.GetInventorySummariesResponse
}

GetInventorySummariesServiceUnavailable describes a response with status code 503, with default header values.

Temporary overloading or maintenance of the server.

func NewGetInventorySummariesServiceUnavailable

func NewGetInventorySummariesServiceUnavailable() *GetInventorySummariesServiceUnavailable

NewGetInventorySummariesServiceUnavailable creates a GetInventorySummariesServiceUnavailable with default headers values

func (*GetInventorySummariesServiceUnavailable) Error

func (*GetInventorySummariesServiceUnavailable) GetPayload

func (*GetInventorySummariesServiceUnavailable) IsClientError

func (o *GetInventorySummariesServiceUnavailable) IsClientError() bool

IsClientError returns true when this get inventory summaries service unavailable response has a 4xx status code

func (*GetInventorySummariesServiceUnavailable) IsCode

IsCode returns true when this get inventory summaries service unavailable response a status code equal to that given

func (*GetInventorySummariesServiceUnavailable) IsRedirect

IsRedirect returns true when this get inventory summaries service unavailable response has a 3xx status code

func (*GetInventorySummariesServiceUnavailable) IsServerError

func (o *GetInventorySummariesServiceUnavailable) IsServerError() bool

IsServerError returns true when this get inventory summaries service unavailable response has a 5xx status code

func (*GetInventorySummariesServiceUnavailable) IsSuccess

IsSuccess returns true when this get inventory summaries service unavailable response has a 2xx status code

func (*GetInventorySummariesServiceUnavailable) String

type GetInventorySummariesTooManyRequests

type GetInventorySummariesTooManyRequests struct {

	/* Your rate limit (requests per second) for this operation.
	_Note:_ For this status code, the rate limit header is deprecated and no longer returned.
	*/
	XAmznRateLimitLimit string

	/* Unique request reference ID.
	 */
	XAmznRequestID string

	Payload *fba_inventory_models.GetInventorySummariesResponse
}

GetInventorySummariesTooManyRequests describes a response with status code 429, with default header values.

The frequency of requests was greater than allowed.

func NewGetInventorySummariesTooManyRequests

func NewGetInventorySummariesTooManyRequests() *GetInventorySummariesTooManyRequests

NewGetInventorySummariesTooManyRequests creates a GetInventorySummariesTooManyRequests with default headers values

func (*GetInventorySummariesTooManyRequests) Error

func (*GetInventorySummariesTooManyRequests) GetPayload

func (*GetInventorySummariesTooManyRequests) IsClientError

func (o *GetInventorySummariesTooManyRequests) IsClientError() bool

IsClientError returns true when this get inventory summaries too many requests response has a 4xx status code

func (*GetInventorySummariesTooManyRequests) IsCode

IsCode returns true when this get inventory summaries too many requests response a status code equal to that given

func (*GetInventorySummariesTooManyRequests) IsRedirect

IsRedirect returns true when this get inventory summaries too many requests response has a 3xx status code

func (*GetInventorySummariesTooManyRequests) IsServerError

func (o *GetInventorySummariesTooManyRequests) IsServerError() bool

IsServerError returns true when this get inventory summaries too many requests response has a 5xx status code

func (*GetInventorySummariesTooManyRequests) IsSuccess

IsSuccess returns true when this get inventory summaries too many requests response has a 2xx status code

func (*GetInventorySummariesTooManyRequests) String

Jump to

Keyboard shortcuts

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