warehousingdistributionv20240509

package
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Oct 28, 2024 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetInboundShipmentRequest

func NewGetInboundShipmentRequest(server string, shipmentId string, params *GetInboundShipmentParams) (*http.Request, error)

NewGetInboundShipmentRequest generates requests for GetInboundShipment

func NewListInboundShipmentsRequest

func NewListInboundShipmentsRequest(server string, params *ListInboundShipmentsParams) (*http.Request, error)

NewListInboundShipmentsRequest generates requests for ListInboundShipments

func NewListInventoryRequest

func NewListInventoryRequest(server string, params *ListInventoryParams) (*http.Request, error)

NewListInventoryRequest generates requests for ListInventory

Types

type Address

type Address struct {
	// AddressLine1 First line of the address text.
	AddressLine1 string `json:"addressLine1"`

	// AddressLine2 Optional second line of the address text.
	AddressLine2 *string `json:"addressLine2,omitempty"`

	// AddressLine3 Optional third line of the address text.
	AddressLine3 *string `json:"addressLine3,omitempty"`

	// City Optional city where this address is located.
	City *string `json:"city,omitempty"`

	// CountryCode Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.
	CountryCode string `json:"countryCode"`

	// County Optional county where this address is located.
	County *string `json:"county,omitempty"`

	// District Optional district where this address is located.
	District *string `json:"district,omitempty"`

	// Name Name of the person, business, or institution at this address.
	Name string `json:"name"`

	// PhoneNumber Optional E.164-formatted phone number for an available contact at this address.
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// PostalCode Optional postal code where this address is located.
	PostalCode *string `json:"postalCode,omitempty"`

	// StateOrRegion State or region where this address is located. Note that this is contextual to the specified country code.
	StateOrRegion string `json:"stateOrRegion"`
}

Address Shipping address that represents the origin or destination location.

type CarrierCode

type CarrierCode struct {
	// CarrierCodeType Denotes the type for the carrier.
	CarrierCodeType *CarrierCodeType `json:"carrierCodeType,omitempty"`

	// CarrierCodeValue Value of the carrier code.
	CarrierCodeValue *string `json:"carrierCodeValue,omitempty"`
}

CarrierCode Identifies the carrier that will deliver the shipment.

type CarrierCodeType

type CarrierCodeType string

CarrierCodeType Denotes the type for the carrier.

const (
	SCAC CarrierCodeType = "SCAC"
)

Defines values for CarrierCodeType.

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

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn

	// A callback for modifying response which are generated after receive from the network.
	ResponseEditors []ResponseEditorFn

	// 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) GetInboundShipment

func (c *Client) GetInboundShipment(ctx context.Context, shipmentId string, params *GetInboundShipmentParams) (*http.Response, error)

func (*Client) ListInboundShipments

func (c *Client) ListInboundShipments(ctx context.Context, params *ListInboundShipmentsParams) (*http.Response, error)

func (*Client) ListInventory

func (c *Client) ListInventory(ctx context.Context, params *ListInventoryParams) (*http.Response, error)

type ClientInterface

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

	// GetInboundShipment request
	GetInboundShipment(ctx context.Context, shipmentId string, params *GetInboundShipmentParams) (*http.Response, error)

	// ListInventory request
	ListInventory(ctx context.Context, params *ListInventoryParams) (*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 WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

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

func WithResponseEditorFn

func WithResponseEditorFn(fn ResponseEditorFn) ClientOption

WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

func NewClientWithResponses

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

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

func (*ClientWithResponses) GetInboundShipmentWithResponse

func (c *ClientWithResponses) GetInboundShipmentWithResponse(ctx context.Context, shipmentId string, params *GetInboundShipmentParams) (*GetInboundShipmentResp, error)

GetInboundShipmentWithResponse request returning *GetInboundShipmentResp

func (*ClientWithResponses) ListInboundShipmentsWithResponse

func (c *ClientWithResponses) ListInboundShipmentsWithResponse(ctx context.Context, params *ListInboundShipmentsParams) (*ListInboundShipmentsResp, error)

ListInboundShipmentsWithResponse request returning *ListInboundShipmentsResp

func (*ClientWithResponses) ListInventoryWithResponse

func (c *ClientWithResponses) ListInventoryWithResponse(ctx context.Context, params *ListInventoryParams) (*ListInventoryResp, error)

ListInventoryWithResponse request returning *ListInventoryResp

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ListInboundShipmentsWithResponse request
	ListInboundShipmentsWithResponse(ctx context.Context, params *ListInboundShipmentsParams) (*ListInboundShipmentsResp, error)

	// GetInboundShipmentWithResponse request
	GetInboundShipmentWithResponse(ctx context.Context, shipmentId string, params *GetInboundShipmentParams) (*GetInboundShipmentResp, error)

	// ListInventoryWithResponse request
	ListInventoryWithResponse(ctx context.Context, params *ListInventoryParams) (*ListInventoryResp, error)
}

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

type DimensionUnitOfMeasurement

type DimensionUnitOfMeasurement string

DimensionUnitOfMeasurement Unit of measurement for package dimensions.

const (
	CENTIMETERS DimensionUnitOfMeasurement = "CENTIMETERS"
	INCHES      DimensionUnitOfMeasurement = "INCHES"
)

Defines values for DimensionUnitOfMeasurement.

type DistributionPackage

type DistributionPackage struct {
	// Contents Represents the contents inside a package, which can be products or a nested package.
	Contents DistributionPackageContents `json:"contents"`

	// Measurements Package weight and dimension.
	Measurements MeasurementData `json:"measurements"`

	// Type Type of distribution packages.
	Type DistributionPackageType `json:"type"`
}

DistributionPackage Represents an AWD distribution package.

type DistributionPackageContents

type DistributionPackageContents struct {
	// Packages This is required only when `DistributionPackageType=PALLET`.
	Packages *[]DistributionPackageQuantity `json:"packages,omitempty"`

	// Products This is required only when `DistributionPackageType=CASE`.
	Products *[]ProductQuantity `json:"products,omitempty"`
}

DistributionPackageContents Represents the contents inside a package, which can be products or a nested package.

type DistributionPackageQuantity

type DistributionPackageQuantity struct {
	// Count Number of cases or pallets with the same package configuration.
	Count int32 `json:"count"`

	// DistributionPackage Represents an AWD distribution package.
	DistributionPackage DistributionPackage `json:"distributionPackage"`
}

DistributionPackageQuantity Represents a distribution package with its respective quantity.

type DistributionPackageType

type DistributionPackageType string

DistributionPackageType Type of distribution packages.

const (
	CASE   DistributionPackageType = "CASE"
	PALLET DistributionPackageType = "PALLET"
)

Defines values for DistributionPackageType.

type Error

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

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

	// Message A message that describes the error condition.
	Message string `json:"message"`
}

Error Error response returned when the request is unsuccessful.

type ErrorList

type ErrorList struct {
	// Errors A list of errors describing the failures.
	Errors []Error `json:"errors"`
}

ErrorList This exception is thrown when client inputs are invalid.

type GetInboundShipmentParams

type GetInboundShipmentParams struct {
	// SkuQuantities If equal to `SHOW`, the response includes the shipment SKU quantity details.
	//
	// Defaults to `HIDE`, in which case the response does not contain SKU quantities
	SkuQuantities *GetInboundShipmentParamsSkuQuantities `form:"skuQuantities,omitempty" json:"skuQuantities,omitempty"`
}

GetInboundShipmentParams defines parameters for GetInboundShipment.

type GetInboundShipmentParamsSkuQuantities

type GetInboundShipmentParamsSkuQuantities string

GetInboundShipmentParamsSkuQuantities defines parameters for GetInboundShipment.

const (
	GetInboundShipmentParamsSkuQuantitiesHIDE GetInboundShipmentParamsSkuQuantities = "HIDE"
	GetInboundShipmentParamsSkuQuantitiesSHOW GetInboundShipmentParamsSkuQuantities = "SHOW"
)

Defines values for GetInboundShipmentParamsSkuQuantities.

type GetInboundShipmentResp

type GetInboundShipmentResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InboundShipment
	JSON400      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON413      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseGetInboundShipmentResp

func ParseGetInboundShipmentResp(rsp *http.Response) (*GetInboundShipmentResp, error)

ParseGetInboundShipmentResp parses an HTTP response from a GetInboundShipmentWithResponse call

func (GetInboundShipmentResp) Status

func (r GetInboundShipmentResp) Status() string

Status returns HTTPResponse.Status

func (GetInboundShipmentResp) StatusCode

func (r GetInboundShipmentResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InboundShipment

type InboundShipment struct {
	// CarrierCode Identifies the carrier that will deliver the shipment.
	CarrierCode *CarrierCode `json:"carrierCode,omitempty"`

	// CreatedAt Timestamp when the shipment was created. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// DestinationAddress Shipping address that represents the origin or destination location.
	DestinationAddress Address `json:"destinationAddress"`

	// ExternalReferenceId Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record.
	ExternalReferenceId *string `json:"externalReferenceId,omitempty"`

	// OrderId The AWD inbound order ID that this inbound shipment belongs to.
	OrderId string `json:"orderId"`

	// OriginAddress Shipping address that represents the origin or destination location.
	OriginAddress Address `json:"originAddress"`

	// ReceivedQuantity Quantity received (at the receiving end) as part of this shipment.
	ReceivedQuantity *[]InventoryQuantity `json:"receivedQuantity,omitempty"`

	// ShipBy Timestamp when the shipment will be shipped.
	ShipBy *time.Time `json:"shipBy,omitempty"`

	// ShipmentContainerQuantities Packages that are part of this shipment.
	ShipmentContainerQuantities []DistributionPackageQuantity `json:"shipmentContainerQuantities"`

	// ShipmentId Unique shipment ID.
	ShipmentId string `json:"shipmentId"`

	// ShipmentSkuQuantities Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.
	ShipmentSkuQuantities *[]SkuQuantity `json:"shipmentSkuQuantities,omitempty"`

	// ShipmentStatus Possible shipment statuses used by shipments.
	ShipmentStatus InboundShipmentStatus `json:"shipmentStatus"`

	// TrackingId Carrier-unique tracking ID for this shipment.
	TrackingId *string `json:"trackingId,omitempty"`

	// UpdatedAt Timestamp when the shipment was updated. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`

	// WarehouseReferenceId An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking.
	WarehouseReferenceId *string `json:"warehouseReferenceId,omitempty"`
}

InboundShipment Represents an AWD inbound shipment.

type InboundShipmentStatus

type InboundShipmentStatus string

InboundShipmentStatus Possible shipment statuses used by shipments.

const (
	InboundShipmentStatusCANCELLED InboundShipmentStatus = "CANCELLED"
	InboundShipmentStatusCLOSED    InboundShipmentStatus = "CLOSED"
	InboundShipmentStatusCREATED   InboundShipmentStatus = "CREATED"
	InboundShipmentStatusDELIVERED InboundShipmentStatus = "DELIVERED"
	InboundShipmentStatusINTRANSIT InboundShipmentStatus = "IN_TRANSIT"
	InboundShipmentStatusRECEIVING InboundShipmentStatus = "RECEIVING"
	InboundShipmentStatusSHIPPED   InboundShipmentStatus = "SHIPPED"
)

Defines values for InboundShipmentStatus.

type InboundShipmentSummary

type InboundShipmentSummary struct {
	// CreatedAt Timestamp when the shipment was created.
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// ExternalReferenceId Optional client-provided reference ID that can be used to correlate this shipment with client resources. For example, to map this shipment to an internal bookkeeping order record.
	ExternalReferenceId *string `json:"externalReferenceId,omitempty"`

	// OrderId The AWD inbound order ID that this inbound shipment belongs to.
	OrderId string `json:"orderId"`

	// ShipmentId A unique shipment ID.
	ShipmentId string `json:"shipmentId"`

	// ShipmentStatus Possible shipment statuses used by shipments.
	ShipmentStatus InboundShipmentStatus `json:"shipmentStatus"`

	// UpdatedAt Timestamp when the shipment was updated.
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

InboundShipmentSummary Summary for an AWD inbound shipment containing the shipment ID, which can be used to retrieve the actual shipment.

type InventoryDetails

type InventoryDetails struct {
	// AvailableDistributableQuantity Quantity that is available for downstream channel replenishment.
	AvailableDistributableQuantity *int64 `json:"availableDistributableQuantity,omitempty"`

	// ReservedDistributableQuantity Quantity that is reserved for a downstream channel replenishment order that is being prepared for shipment.
	ReservedDistributableQuantity *int64 `json:"reservedDistributableQuantity,omitempty"`
}

InventoryDetails Additional inventory details. This object is only displayed if the details parameter in the request is set to `SHOW`.

type InventoryListing

type InventoryListing struct {
	// Inventory List of inventory summaries.
	Inventory []InventorySummary `json:"inventory"`

	// NextToken Token to retrieve the next set of paginated results.
	NextToken *string `json:"nextToken,omitempty"`
}

InventoryListing AWD inventory payload.

type InventoryQuantity

type InventoryQuantity struct {
	// Quantity Quantity of the respective inventory.
	Quantity float32 `json:"quantity"`

	// UnitOfMeasurement Unit of measurement for the inventory.
	UnitOfMeasurement InventoryUnitOfMeasurement `json:"unitOfMeasurement"`
}

InventoryQuantity Quantity of inventory with an associated measurement unit context.

type InventorySummary

type InventorySummary struct {
	// InventoryDetails Additional inventory details. This object is only displayed if the details parameter in the request is set to `SHOW`.
	InventoryDetails *InventoryDetails `json:"inventoryDetails,omitempty"`

	// Sku The seller or merchant SKU.
	Sku string `json:"sku"`

	// TotalInboundQuantity Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center
	TotalInboundQuantity *int64 `json:"totalInboundQuantity,omitempty"`

	// TotalOnhandQuantity Total quantity that is present in AWD distribution centers.
	TotalOnhandQuantity *int64 `json:"totalOnhandQuantity,omitempty"`
}

InventorySummary Summary of inventory per SKU.

type InventoryUnitOfMeasurement

type InventoryUnitOfMeasurement string

InventoryUnitOfMeasurement Unit of measurement for the inventory.

const (
	CASES        InventoryUnitOfMeasurement = "CASES"
	PALLETS      InventoryUnitOfMeasurement = "PALLETS"
	PRODUCTUNITS InventoryUnitOfMeasurement = "PRODUCT_UNITS"
)

Defines values for InventoryUnitOfMeasurement.

type ListInboundShipmentsParams

type ListInboundShipmentsParams struct {
	// SortBy Field to sort results by. By default, the response will be sorted by UPDATED_AT.
	SortBy *ListInboundShipmentsParamsSortBy `form:"sortBy,omitempty" json:"sortBy,omitempty"`

	// SortOrder Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.
	SortOrder *ListInboundShipmentsParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`

	// ShipmentStatus Filter by inbound shipment status.
	ShipmentStatus *ListInboundShipmentsParamsShipmentStatus `form:"shipmentStatus,omitempty" json:"shipmentStatus,omitempty"`

	// UpdatedAfter List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
	UpdatedAfter *time.Time `form:"updatedAfter,omitempty" json:"updatedAfter,omitempty"`

	// UpdatedBefore List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
	UpdatedBefore *time.Time `form:"updatedBefore,omitempty" json:"updatedBefore,omitempty"`

	// MaxResults Maximum number of results to return.
	MaxResults *int32 `form:"maxResults,omitempty" json:"maxResults,omitempty"`

	// NextToken Token to retrieve the next set of paginated results.
	NextToken *string `form:"nextToken,omitempty" json:"nextToken,omitempty"`
}

ListInboundShipmentsParams defines parameters for ListInboundShipments.

type ListInboundShipmentsParamsShipmentStatus

type ListInboundShipmentsParamsShipmentStatus string

ListInboundShipmentsParamsShipmentStatus defines parameters for ListInboundShipments.

const (
	ListInboundShipmentsParamsShipmentStatusCANCELLED ListInboundShipmentsParamsShipmentStatus = "CANCELLED"
	ListInboundShipmentsParamsShipmentStatusCLOSED    ListInboundShipmentsParamsShipmentStatus = "CLOSED"
	ListInboundShipmentsParamsShipmentStatusCREATED   ListInboundShipmentsParamsShipmentStatus = "CREATED"
	ListInboundShipmentsParamsShipmentStatusDELIVERED ListInboundShipmentsParamsShipmentStatus = "DELIVERED"
	ListInboundShipmentsParamsShipmentStatusINTRANSIT ListInboundShipmentsParamsShipmentStatus = "IN_TRANSIT"
	ListInboundShipmentsParamsShipmentStatusRECEIVING ListInboundShipmentsParamsShipmentStatus = "RECEIVING"
	ListInboundShipmentsParamsShipmentStatusSHIPPED   ListInboundShipmentsParamsShipmentStatus = "SHIPPED"
)

Defines values for ListInboundShipmentsParamsShipmentStatus.

type ListInboundShipmentsParamsSortBy

type ListInboundShipmentsParamsSortBy string

ListInboundShipmentsParamsSortBy defines parameters for ListInboundShipments.

const (
	CREATEDAT ListInboundShipmentsParamsSortBy = "CREATED_AT"
	UPDATEDAT ListInboundShipmentsParamsSortBy = "UPDATED_AT"
)

Defines values for ListInboundShipmentsParamsSortBy.

type ListInboundShipmentsParamsSortOrder

type ListInboundShipmentsParamsSortOrder string

ListInboundShipmentsParamsSortOrder defines parameters for ListInboundShipments.

const (
	ListInboundShipmentsParamsSortOrderASCENDING  ListInboundShipmentsParamsSortOrder = "ASCENDING"
	ListInboundShipmentsParamsSortOrderDESCENDING ListInboundShipmentsParamsSortOrder = "DESCENDING"
)

Defines values for ListInboundShipmentsParamsSortOrder.

type ListInboundShipmentsResp

type ListInboundShipmentsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ShipmentListing
	JSON400      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON413      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseListInboundShipmentsResp

func ParseListInboundShipmentsResp(rsp *http.Response) (*ListInboundShipmentsResp, error)

ParseListInboundShipmentsResp parses an HTTP response from a ListInboundShipmentsWithResponse call

func (ListInboundShipmentsResp) Status

func (r ListInboundShipmentsResp) Status() string

Status returns HTTPResponse.Status

func (ListInboundShipmentsResp) StatusCode

func (r ListInboundShipmentsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListInventoryParams

type ListInventoryParams struct {
	// Sku Filter by seller or merchant SKU for the item.
	Sku *string `form:"sku,omitempty" json:"sku,omitempty"`

	// SortOrder Sort the response in `ASCENDING` or `DESCENDING` order.
	SortOrder *ListInventoryParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`

	// Details Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
	Details *ListInventoryParamsDetails `form:"details,omitempty" json:"details,omitempty"`

	// NextToken Token to retrieve the next set of paginated results.
	NextToken *string `form:"nextToken,omitempty" json:"nextToken,omitempty"`

	// MaxResults Maximum number of results to return.
	MaxResults *int32 `form:"maxResults,omitempty" json:"maxResults,omitempty"`
}

ListInventoryParams defines parameters for ListInventory.

type ListInventoryParamsDetails

type ListInventoryParamsDetails string

ListInventoryParamsDetails defines parameters for ListInventory.

const (
	ListInventoryParamsDetailsHIDE ListInventoryParamsDetails = "HIDE"
	ListInventoryParamsDetailsSHOW ListInventoryParamsDetails = "SHOW"
)

Defines values for ListInventoryParamsDetails.

type ListInventoryParamsSortOrder

type ListInventoryParamsSortOrder string

ListInventoryParamsSortOrder defines parameters for ListInventory.

const (
	ListInventoryParamsSortOrderASCENDING  ListInventoryParamsSortOrder = "ASCENDING"
	ListInventoryParamsSortOrderDESCENDING ListInventoryParamsSortOrder = "DESCENDING"
)

Defines values for ListInventoryParamsSortOrder.

type ListInventoryResp

type ListInventoryResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InventoryListing
	JSON400      *ErrorList
	JSON403      *ErrorList
	JSON404      *ErrorList
	JSON413      *ErrorList
	JSON415      *ErrorList
	JSON429      *ErrorList
	JSON500      *ErrorList
	JSON503      *ErrorList
}

func ParseListInventoryResp

func ParseListInventoryResp(rsp *http.Response) (*ListInventoryResp, error)

ParseListInventoryResp parses an HTTP response from a ListInventoryWithResponse call

func (ListInventoryResp) Status

func (r ListInventoryResp) Status() string

Status returns HTTPResponse.Status

func (ListInventoryResp) StatusCode

func (r ListInventoryResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MeasurementData

type MeasurementData struct {
	// Dimensions Dimensions of the package.
	Dimensions *PackageDimensions `json:"dimensions,omitempty"`

	// Volume Represents the volume of the package with a unit of measurement.
	Volume *PackageVolume `json:"volume,omitempty"`

	// Weight Represents the weight of the package with a unit of measurement.
	Weight PackageWeight `json:"weight"`
}

MeasurementData Package weight and dimension.

type PackageDimensions

type PackageDimensions struct {
	// Height Height of the package.
	Height float64 `json:"height"`

	// Length Length of the package.
	Length float64 `json:"length"`

	// UnitOfMeasurement Unit of measurement for package dimensions.
	UnitOfMeasurement DimensionUnitOfMeasurement `json:"unitOfMeasurement"`

	// Width Width of the package.
	Width float64 `json:"width"`
}

PackageDimensions Dimensions of the package.

type PackageVolume

type PackageVolume struct {
	// UnitOfMeasurement Unit of measurement for the package volume.
	UnitOfMeasurement VolumeUnitOfMeasurement `json:"unitOfMeasurement"`

	// Volume The package volume value.
	Volume float64 `json:"volume"`
}

PackageVolume Represents the volume of the package with a unit of measurement.

type PackageWeight

type PackageWeight struct {
	// UnitOfMeasurement Unit of measurement for the package weight.
	UnitOfMeasurement WeightUnitOfMeasurement `json:"unitOfMeasurement"`

	// Weight The package weight value.
	Weight float64 `json:"weight"`
}

PackageWeight Represents the weight of the package with a unit of measurement.

type ProductAttribute

type ProductAttribute struct {
	// Name Product attribute name.
	Name *string `json:"name,omitempty"`

	// Value Product attribute value.
	Value *string `json:"value,omitempty"`
}

ProductAttribute Product instance attribute that is not described at the SKU level in the catalog.

type ProductQuantity

type ProductQuantity struct {
	// Attributes Attributes for this instance of the product. For example, already-prepped, or other attributes that distinguish the product beyond the SKU.
	Attributes *[]ProductAttribute `json:"attributes,omitempty"`

	// Quantity Product quantity.
	Quantity int32 `json:"quantity"`

	// Sku The seller or merchant SKU.
	Sku string `json:"sku"`
}

ProductQuantity Represents a product with the SKU details and the corresponding quantity.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseEditorFn

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

ResponseEditorFn is the function signature for the ResponseEditor callback function

type ShipmentListing

type ShipmentListing struct {
	// NextToken Token to retrieve the next set of paginated results.
	NextToken *string `json:"nextToken,omitempty"`

	// Shipments List of inbound shipment summaries.
	Shipments *[]InboundShipmentSummary `json:"shipments,omitempty"`
}

ShipmentListing A list of inbound shipment summaries filtered by the attributes specified in the request.

type SkuQuantity

type SkuQuantity struct {
	// ExpectedQuantity Quantity of inventory with an associated measurement unit context.
	ExpectedQuantity InventoryQuantity `json:"expectedQuantity"`

	// ReceivedQuantity Quantity of inventory with an associated measurement unit context.
	ReceivedQuantity *InventoryQuantity `json:"receivedQuantity,omitempty"`

	// Sku The merchant stock keeping unit
	Sku string `json:"sku"`
}

SkuQuantity Quantity details for a SKU as part of a shipment

type VolumeUnitOfMeasurement

type VolumeUnitOfMeasurement string

VolumeUnitOfMeasurement Unit of measurement for the package volume.

const (
	CBM  VolumeUnitOfMeasurement = "CBM"
	CC   VolumeUnitOfMeasurement = "CC"
	CUIN VolumeUnitOfMeasurement = "CU_IN"
)

Defines values for VolumeUnitOfMeasurement.

type WeightUnitOfMeasurement

type WeightUnitOfMeasurement string

WeightUnitOfMeasurement Unit of measurement for the package weight.

const (
	KILOGRAMS WeightUnitOfMeasurement = "KILOGRAMS"
	POUNDS    WeightUnitOfMeasurement = "POUNDS"
)

Defines values for WeightUnitOfMeasurement.

Jump to

Keyboard shortcuts

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