swagger

package

v0.0.0-...-c324a2f Latest Latest Go to latest Published: May 6, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/skeleton1231/amz-sp-api-gosdk

Links

Open Source Insights

README ¶

Go API client for swagger

The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 2020-07-01
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://sellercentral.amazon.com/gp/mws/contactus.html

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://sellingpartnerapi-na.amazon.com/

Class	Method	HTTP request
FbaOutboundApi	CancelFulfillmentOrder	Put /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel
FbaOutboundApi	CreateFulfillmentOrder	Post /fba/outbound/2020-07-01/fulfillmentOrders
FbaOutboundApi	CreateFulfillmentReturn	Put /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/return
FbaOutboundApi	GetFeatureInventory	Get /fba/outbound/2020-07-01/features/inventory/{featureName}
FbaOutboundApi	GetFeatureSKU	Get /fba/outbound/2020-07-01/features/inventory/{featureName}/{sellerSku}
FbaOutboundApi	GetFeatures	Get /fba/outbound/2020-07-01/features
FbaOutboundApi	GetFulfillmentOrder	Get /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}
FbaOutboundApi	GetFulfillmentPreview	Post /fba/outbound/2020-07-01/fulfillmentOrders/preview
FbaOutboundApi	GetPackageTrackingDetails	Get /fba/outbound/2020-07-01/tracking
FbaOutboundApi	ListAllFulfillmentOrders	Get /fba/outbound/2020-07-01/fulfillmentOrders
FbaOutboundApi	ListReturnReasonCodes	Get /fba/outbound/2020-07-01/returnReasonCodes
FbaOutboundApi	SubmitFulfillmentOrderStatusUpdate	Put /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/status
FbaOutboundApi	UpdateFulfillmentOrder	Put /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner APIs for Fulfillment Outbound * * The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders. * * API version: 2020-07-01 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AdditionalLocationInfo
type Address
type BasicAuth
type CancelFulfillmentOrderResponse
type CodSettings
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type CreateFulfillmentOrderItem
type CreateFulfillmentOrderRequest
type CreateFulfillmentOrderResponse
type CreateFulfillmentReturnRequest
type CreateFulfillmentReturnResponse
type CreateFulfillmentReturnResult
type CreateReturnItem
type CurrentStatus
type DeliveryWindow
type EventCode
type FbaOutboundApiGetFeatureInventoryOpts
type FbaOutboundApiListAllFulfillmentOrdersOpts
type FbaOutboundApiListReturnReasonCodesOpts
type FbaOutboundApiService
- func (a *FbaOutboundApiService) CancelFulfillmentOrder(ctx context.Context, sellerFulfillmentOrderId string) (CancelFulfillmentOrderResponse, *http.Response, error)
- func (a *FbaOutboundApiService) CreateFulfillmentOrder(ctx context.Context, body CreateFulfillmentOrderRequest) (CreateFulfillmentOrderResponse, *http.Response, error)
- func (a *FbaOutboundApiService) CreateFulfillmentReturn(ctx context.Context, body CreateFulfillmentReturnRequest, ...) (CreateFulfillmentReturnResponse, *http.Response, error)
- func (a *FbaOutboundApiService) GetFeatureInventory(ctx context.Context, marketplaceId string, featureName string, ...) (GetFeatureInventoryResponse, *http.Response, error)
- func (a *FbaOutboundApiService) GetFeatureSKU(ctx context.Context, marketplaceId string, featureName string, ...) (GetFeatureSkuResponse, *http.Response, error)
- func (a *FbaOutboundApiService) GetFeatures(ctx context.Context, marketplaceId string) (GetFeaturesResponse, *http.Response, error)
- func (a *FbaOutboundApiService) GetFulfillmentOrder(ctx context.Context, sellerFulfillmentOrderId string) (GetFulfillmentOrderResponse, *http.Response, error)
- func (a *FbaOutboundApiService) GetFulfillmentPreview(ctx context.Context, body GetFulfillmentPreviewRequest) (GetFulfillmentPreviewResponse, *http.Response, error)
- func (a *FbaOutboundApiService) GetPackageTrackingDetails(ctx context.Context, packageNumber int32) (GetPackageTrackingDetailsResponse, *http.Response, error)
- func (a *FbaOutboundApiService) ListAllFulfillmentOrders(ctx context.Context, ...) (ListAllFulfillmentOrdersResponse, *http.Response, error)
- func (a *FbaOutboundApiService) ListReturnReasonCodes(ctx context.Context, sellerSku string, language string, ...) (ListReturnReasonCodesResponse, *http.Response, error)
- func (a *FbaOutboundApiService) SubmitFulfillmentOrderStatusUpdate(ctx context.Context, body SubmitFulfillmentOrderStatusUpdateRequest, ...) (SubmitFulfillmentOrderStatusUpdateResponse, *http.Response, error)
- func (a *FbaOutboundApiService) UpdateFulfillmentOrder(ctx context.Context, body UpdateFulfillmentOrderRequest, ...) (UpdateFulfillmentOrderResponse, *http.Response, error)
type Feature
type FeatureSettings
type FeatureSku
type Fee
type FulfillmentAction
type FulfillmentOrder
type FulfillmentOrderItem
type FulfillmentOrderStatus
type FulfillmentPolicy
type FulfillmentPreview
type FulfillmentPreviewItem
type FulfillmentPreviewShipment
type FulfillmentReturnItemStatus
type FulfillmentShipment
type FulfillmentShipmentItem
type FulfillmentShipmentPackage
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetFeatureInventoryResponse
type GetFeatureInventoryResult
type GetFeatureSkuResponse
type GetFeatureSkuResult
type GetFeaturesResponse
type GetFeaturesResult
type GetFulfillmentOrderResponse
type GetFulfillmentOrderResult
type GetFulfillmentPreviewItem
type GetFulfillmentPreviewRequest
type GetFulfillmentPreviewResponse
type GetFulfillmentPreviewResult
type GetPackageTrackingDetailsResponse
type InvalidItemReason
type InvalidItemReasonCode
type InvalidReturnItem
type ListAllFulfillmentOrdersResponse
type ListAllFulfillmentOrdersResult
type ListReturnReasonCodesResponse
type ListReturnReasonCodesResult
type ModelError
type Money
type PackageTrackingDetails
type ReasonCodeDetails
type ReturnAuthorization
type ReturnItem
type ReturnItemDisposition
type ScheduledDeliveryInfo
type ShippingSpeedCategory
type SubmitFulfillmentOrderStatusUpdateRequest
type SubmitFulfillmentOrderStatusUpdateResponse
type TrackingAddress
type TrackingEvent
type UnfulfillablePreviewItem
type UpdateFulfillmentOrderItem
type UpdateFulfillmentOrderRequest
type UpdateFulfillmentOrderResponse
type Weight

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	FbaOutboundApi *FbaOutboundApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner APIs for Fulfillment Outbound API v2020-07-01 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AdditionalLocationInfo ¶

type AdditionalLocationInfo string

AdditionalLocationInfo : Additional location information.

const (
	AS_INSTRUCTED_AdditionalLocationInfo   AdditionalLocationInfo = "AS_INSTRUCTED"
	CARPORT_AdditionalLocationInfo         AdditionalLocationInfo = "CARPORT"
	CUSTOMER_PICKUP_AdditionalLocationInfo AdditionalLocationInfo = "CUSTOMER_PICKUP"
	DECK_AdditionalLocationInfo            AdditionalLocationInfo = "DECK"
	DOOR_PERSON_AdditionalLocationInfo     AdditionalLocationInfo = "DOOR_PERSON"
	FRONT_DESK_AdditionalLocationInfo      AdditionalLocationInfo = "FRONT_DESK"
	FRONT_DOOR_AdditionalLocationInfo      AdditionalLocationInfo = "FRONT_DOOR"
	GARAGE_AdditionalLocationInfo          AdditionalLocationInfo = "GARAGE"
	GUARD_AdditionalLocationInfo           AdditionalLocationInfo = "GUARD"
	MAIL_ROOM_AdditionalLocationInfo       AdditionalLocationInfo = "MAIL_ROOM"
	MAIL_SLOT_AdditionalLocationInfo       AdditionalLocationInfo = "MAIL_SLOT"
	MAILBOX_AdditionalLocationInfo         AdditionalLocationInfo = "MAILBOX"
	MC_BOY_AdditionalLocationInfo          AdditionalLocationInfo = "MC_BOY"
	MC_GIRL_AdditionalLocationInfo         AdditionalLocationInfo = "MC_GIRL"
	MC_MAN_AdditionalLocationInfo          AdditionalLocationInfo = "MC_MAN"
	MC_WOMAN_AdditionalLocationInfo        AdditionalLocationInfo = "MC_WOMAN"
	NEIGHBOR_AdditionalLocationInfo        AdditionalLocationInfo = "NEIGHBOR"
	OFFICE_AdditionalLocationInfo          AdditionalLocationInfo = "OFFICE"
	OUTBUILDING_AdditionalLocationInfo     AdditionalLocationInfo = "OUTBUILDING"
	PATIO_AdditionalLocationInfo           AdditionalLocationInfo = "PATIO"
	PORCH_AdditionalLocationInfo           AdditionalLocationInfo = "PORCH"
	REAR_DOOR_AdditionalLocationInfo       AdditionalLocationInfo = "REAR_DOOR"
	RECEPTIONIST_AdditionalLocationInfo    AdditionalLocationInfo = "RECEPTIONIST"
	RECEIVER_AdditionalLocationInfo        AdditionalLocationInfo = "RECEIVER"
	SECURE_LOCATION_AdditionalLocationInfo AdditionalLocationInfo = "SECURE_LOCATION"
	SIDE_DOOR_AdditionalLocationInfo       AdditionalLocationInfo = "SIDE_DOOR"
)

List of AdditionalLocationInfo

type Address ¶

type Address struct {
	// The name of the person, business or institution at the address.
	Name string `json:"name"`
	// The first line of the address.
	AddressLine1 string `json:"addressLine1"`
	// Additional address information, if required.
	AddressLine2 string `json:"addressLine2,omitempty"`
	// Additional address information, if required.
	AddressLine3 string `json:"addressLine3,omitempty"`
	// The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan.
	City string `json:"city,omitempty"`
	// The district or county where the person, business, or institution is located.
	DistrictOrCounty string `json:"districtOrCounty,omitempty"`
	// The state or region where the person, business or institution is located.
	StateOrRegion string `json:"stateOrRegion"`
	// The postal code of the address.
	PostalCode string `json:"postalCode"`
	// The two digit country code. In ISO 3166-1 alpha-2 format.
	CountryCode string `json:"countryCode"`
	// The phone number of the person, business, or institution located at the address.
	Phone string `json:"phone,omitempty"`
}

A physical address.

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CancelFulfillmentOrderResponse ¶

type CancelFulfillmentOrderResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the cancelFulfillmentOrder operation.

type CodSettings ¶

type CodSettings struct {
	// When true, this fulfillment order requires a COD (Cash On Delivery) payment.
	IsCodRequired     bool   `json:"isCodRequired"`
	CodCharge         *Money `json:"codCharge,omitempty"`
	CodChargeTax      *Money `json:"codChargeTax,omitempty"`
	ShippingCharge    *Money `json:"shippingCharge,omitempty"`
	ShippingChargeTax *Money `json:"shippingChargeTax,omitempty"`
}

The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateFulfillmentOrderItem ¶

type CreateFulfillmentOrderItem struct {
	// The seller SKU of the item.
	SellerSku string `json:"sellerSku"`
	// A fulfillment order item identifier that the seller creates to track fulfillment order items. Used to disambiguate multiple fulfillment items that have the same SellerSKU. For example, the seller might assign different SellerFulfillmentOrderItemId values to two items in a fulfillment order that share the same SellerSKU but have different GiftMessage values.
	SellerFulfillmentOrderItemId string `json:"sellerFulfillmentOrderItemId"`
	Quantity                     int32  `json:"quantity"`
	// A message to the gift recipient, if applicable.
	GiftMessage string `json:"giftMessage,omitempty"`
	// Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.
	DisplayableComment string `json:"displayableComment,omitempty"`
	// Amazon's fulfillment network SKU of the item.
	FulfillmentNetworkSku string `json:"fulfillmentNetworkSku,omitempty"`
	PerUnitDeclaredValue  *Money `json:"perUnitDeclaredValue,omitempty"`
	PerUnitPrice          *Money `json:"perUnitPrice,omitempty"`
	PerUnitTax            *Money `json:"perUnitTax,omitempty"`
}

Item information for creating a fulfillment order.

type CreateFulfillmentOrderRequest ¶

type CreateFulfillmentOrderRequest struct {
	// The marketplace the fulfillment order is placed against.
	MarketplaceId string `json:"marketplaceId,omitempty"`
	// A fulfillment order identifier that the seller creates to track their fulfillment order. The SellerFulfillmentOrderId must be unique for each fulfillment order that a seller creates. If the seller's system already creates unique order identifiers, then these might be good values for them to use.
	SellerFulfillmentOrderId string `json:"sellerFulfillmentOrderId"`
	// A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of DisplayableOrderId should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier.  The value must be an alpha-numeric or ISO 8859-1 compliant string from one to 40 characters in length. Cannot contain two spaces in a row. Leading and trailing white space is removed.
	DisplayableOrderId   string     `json:"displayableOrderId"`
	DisplayableOrderDate *time.Time `json:"displayableOrderDate"`
	// Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.
	DisplayableOrderComment string                 `json:"displayableOrderComment"`
	ShippingSpeedCategory   *ShippingSpeedCategory `json:"shippingSpeedCategory"`
	DeliveryWindow          *DeliveryWindow        `json:"deliveryWindow,omitempty"`
	DestinationAddress      *Address               `json:"destinationAddress"`
	FulfillmentAction       *FulfillmentAction     `json:"fulfillmentAction,omitempty"`
	FulfillmentPolicy       *FulfillmentPolicy     `json:"fulfillmentPolicy,omitempty"`
	CodSettings             *CodSettings           `json:"codSettings,omitempty"`
	// The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.
	ShipFromCountryCode string    `json:"shipFromCountryCode,omitempty"`
	NotificationEmails  *[]string `json:"notificationEmails,omitempty"`
	// A list of features and their fulfillment policies to apply to the order.
	FeatureConstraints []FeatureSettings             `json:"featureConstraints,omitempty"`
	Items              *[]CreateFulfillmentOrderItem `json:"items"`
}

The request body schema for the createFulfillmentOrder operation.

type CreateFulfillmentOrderResponse ¶

type CreateFulfillmentOrderResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createFulfillmentOrder operation.

type CreateFulfillmentReturnRequest ¶

type CreateFulfillmentReturnRequest struct {
	Items *[]CreateReturnItem `json:"items"`
}

The createFulfillmentReturn operation creates a fulfillment return for items that were fulfilled using the createFulfillmentOrder operation. For calls to createFulfillmentReturn, you must include ReturnReasonCode values returned by a previous call to the listReturnReasonCodes operation.

type CreateFulfillmentReturnResponse ¶

type CreateFulfillmentReturnResponse struct {
	Payload *CreateFulfillmentReturnResult `json:"payload,omitempty"`
	Errors  *[]ModelError                  `json:"errors,omitempty"`
}

The response schema for the createFulfillmentReturn operation.

type CreateFulfillmentReturnResult ¶

type CreateFulfillmentReturnResult struct {
	ReturnItems          *[]ReturnItem          `json:"returnItems,omitempty"`
	InvalidReturnItems   *[]InvalidReturnItem   `json:"invalidReturnItems,omitempty"`
	ReturnAuthorizations *[]ReturnAuthorization `json:"returnAuthorizations,omitempty"`
}

type CreateReturnItem ¶

type CreateReturnItem struct {
	// An identifier assigned by the seller to the return item.
	SellerReturnItemId string `json:"sellerReturnItemId"`
	// The identifier assigned to the item by the seller when the fulfillment order was created.
	SellerFulfillmentOrderItemId string `json:"sellerFulfillmentOrderItemId"`
	// The identifier for the shipment that is associated with the return item.
	AmazonShipmentId string `json:"amazonShipmentId"`
	// The return reason code assigned to the return item by the seller.
	ReturnReasonCode string `json:"returnReasonCode"`
	// An optional comment about the return item.
	ReturnComment string `json:"returnComment,omitempty"`
}

An item that Amazon accepted for return.

type CurrentStatus ¶

type CurrentStatus string

CurrentStatus : The current delivery status of the package.

const (
	IN_TRANSIT_CurrentStatus              CurrentStatus = "IN_TRANSIT"
	DELIVERED_CurrentStatus               CurrentStatus = "DELIVERED"
	RETURNING_CurrentStatus               CurrentStatus = "RETURNING"
	RETURNED_CurrentStatus                CurrentStatus = "RETURNED"
	UNDELIVERABLE_CurrentStatus           CurrentStatus = "UNDELIVERABLE"
	DELAYED_CurrentStatus                 CurrentStatus = "DELAYED"
	AVAILABLE_FOR_PICKUP_CurrentStatus    CurrentStatus = "AVAILABLE_FOR_PICKUP"
	CUSTOMER_ACTION_CurrentStatus         CurrentStatus = "CUSTOMER_ACTION"
	UNKNOWN_CurrentStatus                 CurrentStatus = "UNKNOWN"
	OUT_FOR_DELIVERY_CurrentStatus        CurrentStatus = "OUT_FOR_DELIVERY"
	DELIVERY_ATTEMPTED_CurrentStatus      CurrentStatus = "DELIVERY_ATTEMPTED"
	PICKUP_SUCCESSFUL_CurrentStatus       CurrentStatus = "PICKUP_SUCCESSFUL"
	PICKUP_CANCELLED_CurrentStatus        CurrentStatus = "PICKUP_CANCELLED"
	PICKUP_ATTEMPTED_CurrentStatus        CurrentStatus = "PICKUP_ATTEMPTED"
	PICKUP_SCHEDULED_CurrentStatus        CurrentStatus = "PICKUP_SCHEDULED"
	RETURN_REQUEST_ACCEPTED_CurrentStatus CurrentStatus = "RETURN_REQUEST_ACCEPTED"
	REFUND_ISSUED_CurrentStatus           CurrentStatus = "REFUND_ISSUED"
	RETURN_RECEIVED_IN_FC_CurrentStatus   CurrentStatus = "RETURN_RECEIVED_IN_FC"
)

List of CurrentStatus

type DeliveryWindow ¶

type DeliveryWindow struct {
	StartDate *time.Time `json:"startDate"`
	EndDate   *time.Time `json:"endDate"`
}

The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace.

type EventCode ¶

type EventCode string

EventCode : The event code for the delivery event.

const (
	EventCode101 EventCode = "EVENT_101"
	EventCode102 EventCode = "EVENT_102"
	EventCode201 EventCode = "EVENT_201"
	EventCode202 EventCode = "EVENT_202"
	EventCode203 EventCode = "EVENT_203"
	EventCode204 EventCode = "EVENT_204"
	EventCode205 EventCode = "EVENT_205"
	EventCode206 EventCode = "EVENT_206"
	EventCode301 EventCode = "EVENT_301"
	EventCode302 EventCode = "EVENT_302"
	EventCode304 EventCode = "EVENT_304"
	EventCode306 EventCode = "EVENT_306"
	EventCode307 EventCode = "EVENT_307"
	EventCode308 EventCode = "EVENT_308"
	EventCode309 EventCode = "EVENT_309"
	EventCode401 EventCode = "EVENT_401"
	EventCode402 EventCode = "EVENT_402"
	EventCode403 EventCode = "EVENT_403"
	EventCode404 EventCode = "EVENT_404"
	EventCode405 EventCode = "EVENT_405"
	EventCode406 EventCode = "EVENT_406"
	EventCode407 EventCode = "EVENT_407"
	EventCode408 EventCode = "EVENT_408"
	EventCode409 EventCode = "EVENT_409"
	EventCode411 EventCode = "EVENT_411"
	EventCode412 EventCode = "EVENT_412"
	EventCode413 EventCode = "EVENT_413"
	EventCode414 EventCode = "EVENT_414"
	EventCode415 EventCode = "EVENT_415"
	EventCode416 EventCode = "EVENT_416"
	EventCode417 EventCode = "EVENT_417"
	EventCode418 EventCode = "EVENT_418"
	EventCode419 EventCode = "EVENT_419"
)

List of EventCode

type FbaOutboundApiGetFeatureInventoryOpts ¶

type FbaOutboundApiGetFeatureInventoryOpts struct {
	NextToken optional.String
}

type FbaOutboundApiListAllFulfillmentOrdersOpts ¶

type FbaOutboundApiListAllFulfillmentOrdersOpts struct {
	QueryStartDate optional.Time
	NextToken      optional.String
}

type FbaOutboundApiListReturnReasonCodesOpts ¶

type FbaOutboundApiListReturnReasonCodesOpts struct {
	MarketplaceId            optional.String
	SellerFulfillmentOrderId optional.String
}

type FbaOutboundApiService ¶

type FbaOutboundApiService service

func (*FbaOutboundApiService) CancelFulfillmentOrder ¶

func (a *FbaOutboundApiService) CancelFulfillmentOrder(ctx context.Context, sellerFulfillmentOrderId string) (CancelFulfillmentOrderResponse, *http.Response, error)

FbaOutboundApiService Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.

@return CancelFulfillmentOrderResponse

func (*FbaOutboundApiService) CreateFulfillmentOrder ¶

func (a *FbaOutboundApiService) CreateFulfillmentOrder(ctx context.Context, body CreateFulfillmentOrderRequest) (CreateFulfillmentOrderResponse, *http.Response, error)

FbaOutboundApiService Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return CreateFulfillmentOrderResponse

func (*FbaOutboundApiService) CreateFulfillmentReturn ¶

func (a *FbaOutboundApiService) CreateFulfillmentReturn(ctx context.Context, body CreateFulfillmentReturnRequest, sellerFulfillmentOrderId string) (CreateFulfillmentReturnResponse, *http.Response, error)

FbaOutboundApiService Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param sellerFulfillmentOrderId An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items.

@return CreateFulfillmentReturnResponse

func (*FbaOutboundApiService) GetFeatureInventory ¶

func (a *FbaOutboundApiService) GetFeatureInventory(ctx context.Context, marketplaceId string, featureName string, localVarOptionals *FbaOutboundApiGetFeatureInventoryOpts) (GetFeatureInventoryResponse, *http.Response, error)

func (*FbaOutboundApiService) GetFeatureSKU ¶

func (a *FbaOutboundApiService) GetFeatureSKU(ctx context.Context, marketplaceId string, featureName string, sellerSku string) (GetFeatureSkuResponse, *http.Response, error)

FbaOutboundApiService Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn't eligible, the response will contain an empty skuInfo object. The parameters for this operation may contain special characters that require URL encoding. 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 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param marketplaceId The marketplace for which to return the count.
@param featureName The name of the feature.
@param sellerSku Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.

@return GetFeatureSkuResponse

func (*FbaOutboundApiService) GetFeatures ¶

func (a *FbaOutboundApiService) GetFeatures(ctx context.Context, marketplaceId string) (GetFeaturesResponse, *http.Response, error)

FbaOutboundApiService Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param marketplaceId The marketplace for which to return the list of features.

@return GetFeaturesResponse

func (*FbaOutboundApiService) GetFulfillmentOrder ¶

func (a *FbaOutboundApiService) GetFulfillmentOrder(ctx context.Context, sellerFulfillmentOrderId string) (GetFulfillmentOrderResponse, *http.Response, error)

FbaOutboundApiService Returns the fulfillment order indicated by the specified order identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.

@return GetFulfillmentOrderResponse

func (*FbaOutboundApiService) GetFulfillmentPreview ¶

func (a *FbaOutboundApiService) GetFulfillmentPreview(ctx context.Context, body GetFulfillmentPreviewRequest) (GetFulfillmentPreviewResponse, *http.Response, error)

FbaOutboundApiService Returns a list of fulfillment order previews based on shipping criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return GetFulfillmentPreviewResponse

func (*FbaOutboundApiService) GetPackageTrackingDetails ¶

func (a *FbaOutboundApiService) GetPackageTrackingDetails(ctx context.Context, packageNumber int32) (GetPackageTrackingDetailsResponse, *http.Response, error)

FbaOutboundApiService Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param packageNumber The unencrypted package identifier returned by the getFulfillmentOrder operation.

@return GetPackageTrackingDetailsResponse

func (*FbaOutboundApiService) ListAllFulfillmentOrders ¶

func (a *FbaOutboundApiService) ListAllFulfillmentOrders(ctx context.Context, localVarOptionals *FbaOutboundApiListAllFulfillmentOrdersOpts) (ListAllFulfillmentOrdersResponse, *http.Response, error)

func (*FbaOutboundApiService) ListReturnReasonCodes ¶

func (a *FbaOutboundApiService) ListReturnReasonCodes(ctx context.Context, sellerSku string, language string, localVarOptionals *FbaOutboundApiListReturnReasonCodesOpts) (ListReturnReasonCodesResponse, *http.Response, error)

func (*FbaOutboundApiService) SubmitFulfillmentOrderStatusUpdate ¶

func (a *FbaOutboundApiService) SubmitFulfillmentOrderStatusUpdate(ctx context.Context, body SubmitFulfillmentOrderStatusUpdateRequest, sellerFulfillmentOrderId string) (SubmitFulfillmentOrderStatusUpdateResponse, *http.Response, error)

FbaOutboundApiService Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.

@return SubmitFulfillmentOrderStatusUpdateResponse

func (*FbaOutboundApiService) UpdateFulfillmentOrder ¶

func (a *FbaOutboundApiService) UpdateFulfillmentOrder(ctx context.Context, body UpdateFulfillmentOrderRequest, sellerFulfillmentOrderId string) (UpdateFulfillmentOrderResponse, *http.Response, error)

FbaOutboundApiService Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.

@return UpdateFulfillmentOrderResponse

type Feature ¶

type Feature struct {
	// The feature name.
	FeatureName string `json:"featureName"`
	// The feature description.
	FeatureDescription string `json:"featureDescription"`
	// When true, indicates that the seller is eligible to use the feature.
	SellerEligible bool `json:"sellerEligible,omitempty"`
}

A Multi-Channel Fulfillment feature.

type FeatureSettings ¶

type FeatureSettings struct {
	// The name of the feature.
	FeatureName string `json:"featureName,omitempty"`
	// Specifies the policy to use when fulfilling an order.
	FeatureFulfillmentPolicy string `json:"featureFulfillmentPolicy,omitempty"`
}

FeatureSettings allows users to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, use featureName as BLOCK_AMZL and featureFulfillmentPolicy as Required. Blocking AMZL will incur an additional fee surcharge on your MCF orders and increase the risk of some of your orders being unfulfilled or delivered late if there are no alternative carriers available. Using BLOCK_AMZL in an order request will take precedence over your Seller Central account setting. To ship in non-Amazon branded packaging (blank boxes), use featureName BLANK_BOX.

type FeatureSku ¶

type FeatureSku struct {
	// Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.
	SellerSku string `json:"sellerSku,omitempty"`
	// The unique SKU used by Amazon's fulfillment network.
	FnSku string `json:"fnSku,omitempty"`
	// The Amazon Standard Identification Number (ASIN) of the item.
	Asin string `json:"asin,omitempty"`
	// The number of SKUs available for this service.
	SkuCount float64 `json:"skuCount,omitempty"`
	// Other seller SKUs that are shared across the same inventory.
	OverlappingSkus []string `json:"overlappingSkus,omitempty"`
}

Information about an SKU, including the count available, identifiers, and a list of overlapping SKUs that share the same inventory pool.

type Fee ¶

type Fee struct {
	// The type of fee.
	Name   string `json:"name"`
	Amount *Money `json:"amount"`
}

Fee type and cost.

type FulfillmentAction ¶

type FulfillmentAction string

FulfillmentAction : Specifies whether the fulfillment order should ship now or have an order hold put on it.

const (
	SHIP_FulfillmentAction FulfillmentAction = "Ship"
	HOLD_FulfillmentAction FulfillmentAction = "Hold"
)

List of FulfillmentAction

type FulfillmentOrder ¶

type FulfillmentOrder struct {
	// The fulfillment order identifier submitted with the createFulfillmentOrder operation.
	SellerFulfillmentOrderId string `json:"sellerFulfillmentOrderId"`
	// The identifier for the marketplace the fulfillment order is placed against.
	MarketplaceId string `json:"marketplaceId"`
	// A fulfillment order identifier submitted with the createFulfillmentOrder operation. Displays as the order identifier in recipient-facing materials such as the packing slip.
	DisplayableOrderId   string     `json:"displayableOrderId"`
	DisplayableOrderDate *time.Time `json:"displayableOrderDate"`
	// A text block submitted with the createFulfillmentOrder operation. Displays in recipient-facing materials such as the packing slip.
	DisplayableOrderComment string                  `json:"displayableOrderComment"`
	ShippingSpeedCategory   *ShippingSpeedCategory  `json:"shippingSpeedCategory"`
	DeliveryWindow          *DeliveryWindow         `json:"deliveryWindow,omitempty"`
	DestinationAddress      *Address                `json:"destinationAddress"`
	FulfillmentAction       *FulfillmentAction      `json:"fulfillmentAction,omitempty"`
	FulfillmentPolicy       *FulfillmentPolicy      `json:"fulfillmentPolicy,omitempty"`
	CodSettings             *CodSettings            `json:"codSettings,omitempty"`
	ReceivedDate            *time.Time              `json:"receivedDate"`
	FulfillmentOrderStatus  *FulfillmentOrderStatus `json:"fulfillmentOrderStatus"`
	StatusUpdatedDate       *time.Time              `json:"statusUpdatedDate"`
	NotificationEmails      *[]string               `json:"notificationEmails,omitempty"`
	// A list of features and their fulfillment policies to apply to the order.
	FeatureConstraints []FeatureSettings `json:"featureConstraints,omitempty"`
}

General information about a fulfillment order, including its status.

type FulfillmentOrderItem ¶

type FulfillmentOrderItem struct {
	// The seller SKU of the item.
	SellerSku string `json:"sellerSku"`
	// A fulfillment order item identifier submitted with a call to the createFulfillmentOrder operation.
	SellerFulfillmentOrderItemId string `json:"sellerFulfillmentOrderItemId"`
	Quantity                     int32  `json:"quantity"`
	// A message to the gift recipient, if applicable.
	GiftMessage string `json:"giftMessage,omitempty"`
	// Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.
	DisplayableComment string `json:"displayableComment,omitempty"`
	// Amazon's fulfillment network SKU of the item.
	FulfillmentNetworkSku string `json:"fulfillmentNetworkSku,omitempty"`
	// Indicates whether the item is sellable or unsellable.
	OrderItemDisposition  string     `json:"orderItemDisposition,omitempty"`
	CancelledQuantity     int32      `json:"cancelledQuantity"`
	UnfulfillableQuantity int32      `json:"unfulfillableQuantity"`
	EstimatedShipDate     *time.Time `json:"estimatedShipDate,omitempty"`
	EstimatedArrivalDate  *time.Time `json:"estimatedArrivalDate,omitempty"`
	PerUnitPrice          *Money     `json:"perUnitPrice,omitempty"`
	PerUnitTax            *Money     `json:"perUnitTax,omitempty"`
	PerUnitDeclaredValue  *Money     `json:"perUnitDeclaredValue,omitempty"`
}

Item information for a fulfillment order.

type FulfillmentOrderStatus ¶

type FulfillmentOrderStatus string

FulfillmentOrderStatus : The current status of the fulfillment order.

const (
	NEW_FulfillmentOrderStatus                 FulfillmentOrderStatus = "New"
	RECEIVED_FulfillmentOrderStatus            FulfillmentOrderStatus = "Received"
	PLANNING_FulfillmentOrderStatus            FulfillmentOrderStatus = "Planning"
	PROCESSING_FulfillmentOrderStatus          FulfillmentOrderStatus = "Processing"
	CANCELLED_FulfillmentOrderStatus           FulfillmentOrderStatus = "Cancelled"
	COMPLETE_FulfillmentOrderStatus            FulfillmentOrderStatus = "Complete"
	COMPLETE_PARTIALLED_FulfillmentOrderStatus FulfillmentOrderStatus = "CompletePartialled"
	UNFULFILLABLE_FulfillmentOrderStatus       FulfillmentOrderStatus = "Unfulfillable"
	INVALID_FulfillmentOrderStatus             FulfillmentOrderStatus = "Invalid"
)

List of FulfillmentOrderStatus

type FulfillmentPolicy ¶

type FulfillmentPolicy string

FulfillmentPolicy : The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.

const (
	FILL_OR_KILL_FulfillmentPolicy       FulfillmentPolicy = "FillOrKill"
	FILL_ALL_FulfillmentPolicy           FulfillmentPolicy = "FillAll"
	FILL_ALL_AVAILABLE_FulfillmentPolicy FulfillmentPolicy = "FillAllAvailable"
)

List of FulfillmentPolicy

type FulfillmentPreview ¶

type FulfillmentPreview struct {
	ShippingSpeedCategory *ShippingSpeedCategory `json:"shippingSpeedCategory"`
	ScheduledDeliveryInfo *ScheduledDeliveryInfo `json:"scheduledDeliveryInfo,omitempty"`
	// When true, this fulfillment order preview is fulfillable.
	IsFulfillable bool `json:"isFulfillable"`
	// When true, this fulfillment order preview is for COD (Cash On Delivery).
	IsCODCapable                bool                          `json:"isCODCapable"`
	EstimatedShippingWeight     *Weight                       `json:"estimatedShippingWeight,omitempty"`
	EstimatedFees               *[]Fee                        `json:"estimatedFees,omitempty"`
	FulfillmentPreviewShipments *[]FulfillmentPreviewShipment `json:"fulfillmentPreviewShipments,omitempty"`
	UnfulfillablePreviewItems   *[]UnfulfillablePreviewItem   `json:"unfulfillablePreviewItems,omitempty"`
	OrderUnfulfillableReasons   *[]string                     `json:"orderUnfulfillableReasons,omitempty"`
	// The marketplace the fulfillment order is placed against.
	MarketplaceId string `json:"marketplaceId"`
	// A list of features and their fulfillment policies to apply to the order.
	FeatureConstraints []FeatureSettings `json:"featureConstraints,omitempty"`
}

Information about a fulfillment order preview, including delivery and fee information based on shipping method.

type FulfillmentPreviewItem ¶

type FulfillmentPreviewItem struct {
	// The seller SKU of the item.
	SellerSku string `json:"sellerSku"`
	Quantity  int32  `json:"quantity"`
	// A fulfillment order item identifier that the seller created with a call to the createFulfillmentOrder operation.
	SellerFulfillmentOrderItemId string  `json:"sellerFulfillmentOrderItemId"`
	EstimatedShippingWeight      *Weight `json:"estimatedShippingWeight,omitempty"`
	// The method used to calculate the estimated shipping weight.
	ShippingWeightCalculationMethod string `json:"shippingWeightCalculationMethod,omitempty"`
}

Item information for a shipment in a fulfillment order preview.

type FulfillmentPreviewShipment ¶

type FulfillmentPreviewShipment struct {
	EarliestShipDate    *time.Time `json:"earliestShipDate,omitempty"`
	LatestShipDate      *time.Time `json:"latestShipDate,omitempty"`
	EarliestArrivalDate *time.Time `json:"earliestArrivalDate,omitempty"`
	LatestArrivalDate   *time.Time `json:"latestArrivalDate,omitempty"`
	// Provides additional insight into the shipment timeline when exact delivery dates are not able to be precomputed.
	ShippingNotes           []string                  `json:"shippingNotes,omitempty"`
	FulfillmentPreviewItems *[]FulfillmentPreviewItem `json:"fulfillmentPreviewItems"`
}

Delivery and item information for a shipment in a fulfillment order preview.

type FulfillmentReturnItemStatus ¶

type FulfillmentReturnItemStatus string

FulfillmentReturnItemStatus : Indicates if the return item has been processed by a fulfillment center.

const (
	NEW_FulfillmentReturnItemStatus       FulfillmentReturnItemStatus = "New"
	PROCESSED_FulfillmentReturnItemStatus FulfillmentReturnItemStatus = "Processed"
)

List of FulfillmentReturnItemStatus

type FulfillmentShipment ¶

type FulfillmentShipment struct {
	// A shipment identifier assigned by Amazon.
	AmazonShipmentId string `json:"amazonShipmentId"`
	// An identifier for the fulfillment center that the shipment will be sent from.
	FulfillmentCenterId string `json:"fulfillmentCenterId"`
	// The current status of the shipment.
	FulfillmentShipmentStatus string     `json:"fulfillmentShipmentStatus"`
	ShippingDate              *time.Time `json:"shippingDate,omitempty"`
	EstimatedArrivalDate      *time.Time `json:"estimatedArrivalDate,omitempty"`
	// Provides additional insight into shipment timeline. Primairly used to communicate that actual delivery dates aren't available.
	ShippingNotes              []string                      `json:"shippingNotes,omitempty"`
	FulfillmentShipmentItem    *[]FulfillmentShipmentItem    `json:"fulfillmentShipmentItem"`
	FulfillmentShipmentPackage *[]FulfillmentShipmentPackage `json:"fulfillmentShipmentPackage,omitempty"`
}

Delivery and item information for a shipment in a fulfillment order.

type FulfillmentShipmentItem ¶

type FulfillmentShipmentItem struct {
	// The seller SKU of the item.
	SellerSku string `json:"sellerSku"`
	// The fulfillment order item identifier that the seller created and submitted with a call to the createFulfillmentOrder operation.
	SellerFulfillmentOrderItemId string `json:"sellerFulfillmentOrderItemId"`
	Quantity                     int32  `json:"quantity"`
	// An identifier for the package that contains the item quantity.
	PackageNumber int32 `json:"packageNumber,omitempty"`
	// The serial number of the shipped item.
	SerialNumber string `json:"serialNumber,omitempty"`
}

Item information for a shipment in a fulfillment order.

type FulfillmentShipmentPackage ¶

type FulfillmentShipmentPackage struct {
	// Identifies a package in a shipment.
	PackageNumber int32 `json:"packageNumber"`
	// Identifies the carrier who will deliver the shipment to the recipient.
	CarrierCode string `json:"carrierCode"`
	// The tracking number, if provided, can be used to obtain tracking and delivery information.
	TrackingNumber       string     `json:"trackingNumber,omitempty"`
	EstimatedArrivalDate *time.Time `json:"estimatedArrivalDate,omitempty"`
}

Package information for a shipment in a fulfillment order.

type GenericSwaggerError ¶

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetFeatureInventoryResponse ¶

type GetFeatureInventoryResponse struct {
	Payload *GetFeatureInventoryResult `json:"payload,omitempty"`
	Errors  *[]ModelError              `json:"errors,omitempty"`
}

The breakdown of eligibility inventory by feature.

type GetFeatureInventoryResult ¶

type GetFeatureInventoryResult struct {
	// The requested marketplace.
	MarketplaceId string `json:"marketplaceId"`
	// The name of the feature.
	FeatureName string `json:"featureName"`
	// When present and not empty, pass this string token in the next request to return the next response page.
	NextToken string `json:"nextToken,omitempty"`
	// An array of SKUs eligible for this feature and the quantity available.
	FeatureSkus []FeatureSku `json:"featureSkus,omitempty"`
}

The payload for the getEligibileInventory operation.

type GetFeatureSkuResponse ¶

type GetFeatureSkuResponse struct {
	Payload *GetFeatureSkuResult `json:"payload,omitempty"`
	Errors  *[]ModelError        `json:"errors,omitempty"`
}

The response schema for the getFeatureSKU operation.

type GetFeatureSkuResult ¶

type GetFeatureSkuResult struct {
	// The requested marketplace.
	MarketplaceId string `json:"marketplaceId"`
	// The name of the feature.
	FeatureName string `json:"featureName"`
	// When true, the seller SKU is eligible for the requested feature.
	IsEligible bool `json:"isEligible"`
	// A list of one or more reasons that the seller SKU is ineligibile for the feature.  Possible values: * MERCHANT_NOT_ENROLLED - The merchant isn't enrolled for the feature. * SKU_NOT_ELIGIBLE - The SKU doesn't reside in a warehouse that supports the feature. * INVALID_SKU - There is an issue with the SKU provided.
	IneligibleReasons []string    `json:"ineligibleReasons,omitempty"`
	SkuInfo           *FeatureSku `json:"skuInfo,omitempty"`
}

The payload for the getFeatureSKU operation.

type GetFeaturesResponse ¶

type GetFeaturesResponse struct {
	Payload *GetFeaturesResult `json:"payload,omitempty"`
	Errors  *[]ModelError      `json:"errors,omitempty"`
}

The response schema for the getFeatures operation.

type GetFeaturesResult ¶

type GetFeaturesResult struct {
	Features *[]Feature `json:"features"`
}

The payload for the getFeatures operation.

type GetFulfillmentOrderResponse ¶

type GetFulfillmentOrderResponse struct {
	Payload *GetFulfillmentOrderResult `json:"payload,omitempty"`
	Errors  *[]ModelError              `json:"errors,omitempty"`
}

The response schema for the getFulfillmentOrder operation.

type GetFulfillmentOrderResult ¶

type GetFulfillmentOrderResult struct {
	FulfillmentOrder      *FulfillmentOrder       `json:"fulfillmentOrder"`
	FulfillmentOrderItems *[]FulfillmentOrderItem `json:"fulfillmentOrderItems"`
	FulfillmentShipments  *[]FulfillmentShipment  `json:"fulfillmentShipments,omitempty"`
	ReturnItems           *[]ReturnItem           `json:"returnItems"`
	ReturnAuthorizations  *[]ReturnAuthorization  `json:"returnAuthorizations"`
}

type GetFulfillmentPreviewItem ¶

type GetFulfillmentPreviewItem struct {
	// The seller SKU of the item.
	SellerSku            string `json:"sellerSku"`
	Quantity             int32  `json:"quantity"`
	PerUnitDeclaredValue *Money `json:"perUnitDeclaredValue,omitempty"`
	// A fulfillment order item identifier that the seller creates to track items in the fulfillment preview.
	SellerFulfillmentOrderItemId string `json:"sellerFulfillmentOrderItemId"`
}

Item information for a fulfillment order preview.

type GetFulfillmentPreviewRequest ¶

type GetFulfillmentPreviewRequest struct {
	// The marketplace the fulfillment order is placed against.
	MarketplaceId           string                       `json:"marketplaceId,omitempty"`
	Address                 *Address                     `json:"address"`
	Items                   *[]GetFulfillmentPreviewItem `json:"items"`
	ShippingSpeedCategories *[]ShippingSpeedCategory     `json:"shippingSpeedCategories,omitempty"`
	// When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD.
	IncludeCODFulfillmentPreview bool `json:"includeCODFulfillmentPreview,omitempty"`
	// When true, returns the ScheduledDeliveryInfo response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery.
	IncludeDeliveryWindows bool `json:"includeDeliveryWindows,omitempty"`
	// A list of features and their fulfillment policies to apply to the order.
	FeatureConstraints []FeatureSettings `json:"featureConstraints,omitempty"`
}

The request body schema for the getFulfillmentPreview operation.

type GetFulfillmentPreviewResponse ¶

type GetFulfillmentPreviewResponse struct {
	Payload *GetFulfillmentPreviewResult `json:"payload,omitempty"`
	Errors  *[]ModelError                `json:"errors,omitempty"`
}

The response schema for the getFulfillmentPreview operation.

type GetFulfillmentPreviewResult ¶

type GetFulfillmentPreviewResult struct {
	FulfillmentPreviews *[]FulfillmentPreview `json:"fulfillmentPreviews,omitempty"`
}

A list of fulfillment order previews, including estimated shipping weights, estimated shipping fees, and estimated ship dates and arrival dates.

type GetPackageTrackingDetailsResponse ¶

type GetPackageTrackingDetailsResponse struct {
	Payload *PackageTrackingDetails `json:"payload,omitempty"`
	Errors  *[]ModelError           `json:"errors,omitempty"`
}

The response schema for the getPackageTrackingDetails operation.

type InvalidItemReason ¶

type InvalidItemReason struct {
	InvalidItemReasonCode *InvalidItemReasonCode `json:"invalidItemReasonCode"`
	// A human readable description of the invalid item reason code.
	Description string `json:"description"`
}

The reason that the item is invalid for return.

type InvalidItemReasonCode ¶

type InvalidItemReasonCode string

InvalidItemReasonCode : A code for why the item is invalid for return.

const (
	INVALID_VALUES_InvalidItemReasonCode          InvalidItemReasonCode = "InvalidValues"
	DUPLICATE_REQUEST_InvalidItemReasonCode       InvalidItemReasonCode = "DuplicateRequest"
	NO_COMPLETED_SHIP_ITEMS_InvalidItemReasonCode InvalidItemReasonCode = "NoCompletedShipItems"
	NO_RETURNABLE_QUANTITY_InvalidItemReasonCode  InvalidItemReasonCode = "NoReturnableQuantity"
)

List of InvalidItemReasonCode

type InvalidReturnItem ¶

type InvalidReturnItem struct {
	// An identifier assigned by the seller to the return item.
	SellerReturnItemId string `json:"sellerReturnItemId"`
	// The identifier assigned to the item by the seller when the fulfillment order was created.
	SellerFulfillmentOrderItemId string             `json:"sellerFulfillmentOrderItemId"`
	InvalidItemReason            *InvalidItemReason `json:"invalidItemReason"`
}

An item that is invalid for return.

type ListAllFulfillmentOrdersResponse ¶

type ListAllFulfillmentOrdersResponse struct {
	Payload *ListAllFulfillmentOrdersResult `json:"payload,omitempty"`
	Errors  *[]ModelError                   `json:"errors,omitempty"`
}

The response schema for the listAllFulfillmentOrders operation.

type ListAllFulfillmentOrdersResult ¶

type ListAllFulfillmentOrdersResult struct {
	// When present and not empty, pass this string token in the next request to return the next response page.
	NextToken string `json:"nextToken,omitempty"`
	// An array of fulfillment order information.
	FulfillmentOrders []FulfillmentOrder `json:"fulfillmentOrders,omitempty"`
}

type ListReturnReasonCodesResponse ¶

type ListReturnReasonCodesResponse struct {
	Payload *ListReturnReasonCodesResult `json:"payload,omitempty"`
	Errors  *[]ModelError                `json:"errors,omitempty"`
}

The response schema for the listReturnReasonCodes operation.

type ListReturnReasonCodesResult ¶

type ListReturnReasonCodesResult struct {
	ReasonCodeDetails *[]ReasonCodeDetails `json:"reasonCodeDetails,omitempty"`
}

type ModelError ¶

type ModelError struct {
	// An error code that identifies the type of error that occurred.
	Code string `json:"code"`
	// A message that describes the error condition.
	Message string `json:"message"`
	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`
}

Error response returned when the request is unsuccessful.

type Money ¶

type Money struct {
	// Three digit currency code in ISO 4217 format.
	CurrencyCode string `json:"currencyCode"`
	Value        string `json:"value"`
}

An amount of money, including units in the form of currency.

type PackageTrackingDetails ¶

type PackageTrackingDetails struct {
	// The package identifier.
	PackageNumber int32 `json:"packageNumber"`
	// The tracking number for the package.
	TrackingNumber string `json:"trackingNumber,omitempty"`
	// Link on swiship.com that allows customers to track the package.
	CustomerTrackingLink string `json:"customerTrackingLink,omitempty"`
	// The name of the carrier.
	CarrierCode string `json:"carrierCode,omitempty"`
	// The phone number of the carrier.
	CarrierPhoneNumber string `json:"carrierPhoneNumber,omitempty"`
	// The URL of the carrier's website.
	CarrierURL           string           `json:"carrierURL,omitempty"`
	ShipDate             *time.Time       `json:"shipDate,omitempty"`
	EstimatedArrivalDate *time.Time       `json:"estimatedArrivalDate,omitempty"`
	ShipToAddress        *TrackingAddress `json:"shipToAddress,omitempty"`
	CurrentStatus        *CurrentStatus   `json:"currentStatus,omitempty"`
	// Description corresponding to the CurrentStatus value.
	CurrentStatusDescription string `json:"currentStatusDescription,omitempty"`
	// The name of the person who signed for the package.
	SignedForBy            string                  `json:"signedForBy,omitempty"`
	AdditionalLocationInfo *AdditionalLocationInfo `json:"additionalLocationInfo,omitempty"`
	TrackingEvents         *[]TrackingEvent        `json:"trackingEvents,omitempty"`
}

type ReasonCodeDetails ¶

type ReasonCodeDetails struct {
	// A code that indicates a valid return reason.
	ReturnReasonCode string `json:"returnReasonCode"`
	// A human readable description of the return reason code.
	Description string `json:"description"`
	// A translation of the description. The translation is in the language specified in the Language request parameter.
	TranslatedDescription string `json:"translatedDescription,omitempty"`
}

A return reason code, a description, and an optional description translation.

type ReturnAuthorization ¶

type ReturnAuthorization struct {
	// An identifier for the return authorization. This identifier associates return items with the return authorization used to return them.
	ReturnAuthorizationId string `json:"returnAuthorizationId"`
	// An identifier for the Amazon fulfillment center that the return items should be sent to.
	FulfillmentCenterId string   `json:"fulfillmentCenterId"`
	ReturnToAddress     *Address `json:"returnToAddress"`
	// The return merchandise authorization (RMA) that Amazon needs to process the return.
	AmazonRmaId string `json:"amazonRmaId"`
	// A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping.
	RmaPageURL string `json:"rmaPageURL"`
}

Return authorization information for items accepted for return.

type ReturnItem ¶

type ReturnItem struct {
	// An identifier assigned by the seller to the return item.
	SellerReturnItemId string `json:"sellerReturnItemId"`
	// The identifier assigned to the item by the seller when the fulfillment order was created.
	SellerFulfillmentOrderItemId string `json:"sellerFulfillmentOrderItemId"`
	// The identifier for the shipment that is associated with the return item.
	AmazonShipmentId string `json:"amazonShipmentId"`
	// The return reason code assigned to the return item by the seller.
	SellerReturnReasonCode string `json:"sellerReturnReasonCode"`
	// An optional comment about the return item.
	ReturnComment string `json:"returnComment,omitempty"`
	// The return reason code that the Amazon fulfillment center assigned to the return item.
	AmazonReturnReasonCode string                       `json:"amazonReturnReasonCode,omitempty"`
	Status                 *FulfillmentReturnItemStatus `json:"status"`
	StatusChangedDate      *time.Time                   `json:"statusChangedDate"`
	// Identifies the return authorization used to return this item. See ReturnAuthorization.
	ReturnAuthorizationId   string                 `json:"returnAuthorizationId,omitempty"`
	ReturnReceivedCondition *ReturnItemDisposition `json:"returnReceivedCondition,omitempty"`
	// The identifier for the Amazon fulfillment center that processed the return item.
	FulfillmentCenterId string `json:"fulfillmentCenterId,omitempty"`
}

An item that Amazon accepted for return.

type ReturnItemDisposition ¶

type ReturnItemDisposition string

ReturnItemDisposition : The condition of the return item when received by an Amazon fulfillment center.

const (
	SELLABLE_ReturnItemDisposition          ReturnItemDisposition = "Sellable"
	DEFECTIVE_ReturnItemDisposition         ReturnItemDisposition = "Defective"
	CUSTOMER_DAMAGED_ReturnItemDisposition  ReturnItemDisposition = "CustomerDamaged"
	CARRIER_DAMAGED_ReturnItemDisposition   ReturnItemDisposition = "CarrierDamaged"
	FULFILLER_DAMAGED_ReturnItemDisposition ReturnItemDisposition = "FulfillerDamaged"
)

List of ReturnItemDisposition

type ScheduledDeliveryInfo ¶

type ScheduledDeliveryInfo struct {
	// The time zone of the destination address for the fulfillment order preview. Must be an IANA time zone name. Example: Asia/Tokyo.
	DeliveryTimeZone string            `json:"deliveryTimeZone"`
	DeliveryWindows  *[]DeliveryWindow `json:"deliveryWindows"`
}

Delivery information for a scheduled delivery. This is only available in the JP marketplace.

type ShippingSpeedCategory ¶

type ShippingSpeedCategory string

ShippingSpeedCategory : The shipping method used for the fulfillment order. When this value is ScheduledDelivery, choose Ship for the fulfillmentAction. Hold is not a valid fulfillmentAction value when the shippingSpeedCategory value is ScheduledDelivery.

const (
	STANDARD_ShippingSpeedCategory           ShippingSpeedCategory = "Standard"
	EXPEDITED_ShippingSpeedCategory          ShippingSpeedCategory = "Expedited"
	PRIORITY_ShippingSpeedCategory           ShippingSpeedCategory = "Priority"
	SCHEDULED_DELIVERY_ShippingSpeedCategory ShippingSpeedCategory = "ScheduledDelivery"
)

List of ShippingSpeedCategory

type SubmitFulfillmentOrderStatusUpdateRequest ¶

type SubmitFulfillmentOrderStatusUpdateRequest struct {
	FulfillmentOrderStatus *FulfillmentOrderStatus `json:"fulfillmentOrderStatus,omitempty"`
}

The request body schema for the submitFulfillmentOrderStatusUpdate operation.

type SubmitFulfillmentOrderStatusUpdateResponse ¶

type SubmitFulfillmentOrderStatusUpdateResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the SubmitFulfillmentOrderStatusUpdate operation.

type TrackingAddress ¶

type TrackingAddress struct {
	// The city.
	City string `json:"city"`
	// The state.
	State string `json:"state"`
	// The country.
	Country string `json:"country"`
}

Address information for tracking the package.

type TrackingEvent ¶

type TrackingEvent struct {
	EventDate    *time.Time       `json:"eventDate"`
	EventAddress *TrackingAddress `json:"eventAddress"`
	EventCode    *EventCode       `json:"eventCode"`
	// A description for the corresponding event code.
	EventDescription string `json:"eventDescription"`
}

Information for tracking package deliveries.

type UnfulfillablePreviewItem ¶

type UnfulfillablePreviewItem struct {
	// The seller SKU of the item.
	SellerSku string `json:"sellerSku"`
	Quantity  int32  `json:"quantity"`
	// A fulfillment order item identifier created with a call to the getFulfillmentPreview operation.
	SellerFulfillmentOrderItemId string    `json:"sellerFulfillmentOrderItemId"`
	ItemUnfulfillableReasons     *[]string `json:"itemUnfulfillableReasons,omitempty"`
}

Information about unfulfillable items in a fulfillment order preview.

type UpdateFulfillmentOrderItem ¶

type UpdateFulfillmentOrderItem struct {
	// The seller SKU of the item.
	SellerSku string `json:"sellerSku,omitempty"`
	// Identifies the fulfillment order item to update. Created with a previous call to the createFulfillmentOrder operation.
	SellerFulfillmentOrderItemId string `json:"sellerFulfillmentOrderItemId"`
	Quantity                     int32  `json:"quantity"`
	// A message to the gift recipient, if applicable.
	GiftMessage string `json:"giftMessage,omitempty"`
	// Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.
	DisplayableComment string `json:"displayableComment,omitempty"`
	// Amazon's fulfillment network SKU of the item.
	FulfillmentNetworkSku string `json:"fulfillmentNetworkSku,omitempty"`
	// Indicates whether the item is sellable or unsellable.
	OrderItemDisposition string `json:"orderItemDisposition,omitempty"`
	PerUnitDeclaredValue *Money `json:"perUnitDeclaredValue,omitempty"`
	PerUnitPrice         *Money `json:"perUnitPrice,omitempty"`
	PerUnitTax           *Money `json:"perUnitTax,omitempty"`
}

Item information for updating a fulfillment order.

type UpdateFulfillmentOrderRequest ¶

type UpdateFulfillmentOrderRequest struct {
	// The marketplace the fulfillment order is placed against.
	MarketplaceId string `json:"marketplaceId,omitempty"`
	// A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of DisplayableOrderId should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier.
	DisplayableOrderId   string     `json:"displayableOrderId,omitempty"`
	DisplayableOrderDate *time.Time `json:"displayableOrderDate,omitempty"`
	// Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.
	DisplayableOrderComment string                 `json:"displayableOrderComment,omitempty"`
	ShippingSpeedCategory   *ShippingSpeedCategory `json:"shippingSpeedCategory,omitempty"`
	DestinationAddress      *Address               `json:"destinationAddress,omitempty"`
	FulfillmentAction       *FulfillmentAction     `json:"fulfillmentAction,omitempty"`
	FulfillmentPolicy       *FulfillmentPolicy     `json:"fulfillmentPolicy,omitempty"`
	// The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.
	ShipFromCountryCode string    `json:"shipFromCountryCode,omitempty"`
	NotificationEmails  *[]string `json:"notificationEmails,omitempty"`
	// A list of features and their fulfillment policies to apply to the order.
	FeatureConstraints []FeatureSettings             `json:"featureConstraints,omitempty"`
	Items              *[]UpdateFulfillmentOrderItem `json:"items,omitempty"`
}

The request body schema for the updateFulfillmentOrder operation.

type UpdateFulfillmentOrderResponse ¶

type UpdateFulfillmentOrderResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the updateFulfillmentOrder operation.

type Weight ¶

type Weight struct {
	// The unit of weight.
	Unit string `json:"unit"`
	// The weight value.
	Value string `json:"value"`
}

The weight.

Source Files ¶

View all Source files

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