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

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
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 Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the Marketplace Support Table for the differences in Easy Ship operations by marketplace.

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: 2022-03-23
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
EasyShipApi	CreateScheduledPackage	Post /easyShip/2022-03-23/package
EasyShipApi	CreateScheduledPackageBulk	Post /easyShip/2022-03-23/packages/bulk
EasyShipApi	GetScheduledPackage	Get /easyShip/2022-03-23/package
EasyShipApi	ListHandoverSlots	Post /easyShip/2022-03-23/timeSlot
EasyShipApi	UpdateScheduledPackages	Patch /easyShip/2022-03-23/package

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for Easy Ship * * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace. * * API version: 2022-03-23 * 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 BasicAuth
type Code
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type CreateScheduledPackageRequest
type CreateScheduledPackagesRequest
type CreateScheduledPackagesResponse
type Dimensions
type EasyShipApiListHandoverSlotsOpts
type EasyShipApiService
- func (a *EasyShipApiService) CreateScheduledPackage(ctx context.Context, body CreateScheduledPackageRequest) (ModelPackage, *http.Response, error)
- func (a *EasyShipApiService) CreateScheduledPackageBulk(ctx context.Context, body CreateScheduledPackagesRequest) (CreateScheduledPackagesResponse, *http.Response, error)
- func (a *EasyShipApiService) GetScheduledPackage(ctx context.Context, amazonOrderId string, marketplaceId string) (ModelPackage, *http.Response, error)
- func (a *EasyShipApiService) ListHandoverSlots(ctx context.Context, localVarOptionals *EasyShipApiListHandoverSlotsOpts) (ListHandoverSlotsResponse, *http.Response, error)
- func (a *EasyShipApiService) UpdateScheduledPackages(ctx context.Context, localVarOptionals *EasyShipApiUpdateScheduledPackagesOpts) (Packages, *http.Response, error)
type EasyShipApiUpdateScheduledPackagesOpts
type ErrorList
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type HandoverMethod
type InvoiceData
type Item
type LabelFormat
type ListHandoverSlotsRequest
type ListHandoverSlotsResponse
type ModelError
type ModelPackage
type OrderScheduleDetails
type PackageDetails
type PackageStatus
type Packages
type RejectedOrder
type ScheduledPackageId
type TimeSlot
type TrackingDetails
type UnitOfLength
type UnitOfWeight
type UpdatePackageDetails
type UpdateScheduledPackagesRequest
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 {
	EasyShipApi *EasyShipApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Easy Ship API v2022-03-23 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 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 Code ¶

type Code string

Code : An error code that identifies the type of error that occurred. The error codes listed below are specific to the Easy Ship section.

const (
	INVALID_INPUT_Code                       Code = "InvalidInput"
	INVALID_TIME_SLOT_ID_Code                Code = "InvalidTimeSlotId"
	SCHEDULED_PACKAGE_ALREADY_EXISTS_Code    Code = "ScheduledPackageAlreadyExists"
	SCHEDULE_WINDOW_EXPIRED_Code             Code = "ScheduleWindowExpired"
	RETRYABLE_AFTER_GETTING_NEW_SLOTS_Code   Code = "RetryableAfterGettingNewSlots"
	TIME_SLOT_NOT_AVAILABLE_Code             Code = "TimeSlotNotAvailable"
	RESOURCE_NOT_FOUND_Code                  Code = "ResourceNotFound"
	INVALID_ORDER_STATE_Code                 Code = "InvalidOrderState"
	REGION_NOT_SUPPORTED_Code                Code = "RegionNotSupported"
	ORDER_NOT_ELIGIBLE_FOR_RESCHEDULING_Code Code = "OrderNotEligibleForRescheduling"
	INTERNAL_SERVER_ERROR_Code               Code = "InternalServerError"
)

List of Code

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 CreateScheduledPackageRequest ¶

type CreateScheduledPackageRequest struct {
	AmazonOrderId  string          `json:"amazonOrderId"`
	MarketplaceId  string          `json:"marketplaceId"`
	PackageDetails *PackageDetails `json:"packageDetails"`
}

The request schema for the `createScheduledPackage` operation.

type CreateScheduledPackagesRequest ¶

type CreateScheduledPackagesRequest struct {
	MarketplaceId string `json:"marketplaceId"`
	// An array allowing users to specify orders to be scheduled.
	OrderScheduleDetailsList []OrderScheduleDetails `json:"orderScheduleDetailsList"`
	LabelFormat              *LabelFormat           `json:"labelFormat"`
}

The request body for the POST /easyShip/2022-03-23/packages/bulk API.

type CreateScheduledPackagesResponse ¶

type CreateScheduledPackagesResponse struct {
	// A list of packages. Refer to the `Package` object.
	ScheduledPackages []ModelPackage `json:"scheduledPackages,omitempty"`
	// A list of orders we couldn't scheduled on your behalf. Each element contains the reason and details on the error.
	RejectedOrders        []RejectedOrder `json:"rejectedOrders,omitempty"`
	PrintableDocumentsUrl string          `json:"printableDocumentsUrl,omitempty"`
}

The response schema for the bulk scheduling API. It returns by the bulk scheduling API containing an array of the scheduled packtages, an optional list of orders we couldn't schedule with the reason, and a pre-signed URL for a ZIP file containing the associated shipping labels plus the documents enabled for your marketplace.

type Dimensions ¶

type Dimensions struct {
	Length     float32       `json:"length,omitempty"`
	Width      float32       `json:"width,omitempty"`
	Height     float32       `json:"height,omitempty"`
	Unit       *UnitOfLength `json:"unit,omitempty"`
	Identifier string        `json:"identifier,omitempty"`
}

The dimensions of the scheduled package.

type EasyShipApiListHandoverSlotsOpts ¶

type EasyShipApiListHandoverSlotsOpts struct {
	Body optional.Interface
}

type EasyShipApiService ¶

type EasyShipApiService service

func (*EasyShipApiService) CreateScheduledPackage ¶

func (a *EasyShipApiService) CreateScheduledPackage(ctx context.Context, body CreateScheduledPackageRequest) (ModelPackage, *http.Response, error)

EasyShipApiService Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](doc:easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

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

@return ModelPackage

func (*EasyShipApiService) CreateScheduledPackageBulk ¶

func (a *EasyShipApiService) CreateScheduledPackageBulk(ctx context.Context, body CreateScheduledPackagesRequest) (CreateScheduledPackagesResponse, *http.Response, error)

EasyShipApiService This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the associated shipping labels, along with other compliance documents according to the marketplace (refer to the [marketplace document support table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table)). Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label's file format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated shipping labels and the other documents enabled for your marketplace. If at least an order couldn't be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order we couldn't process. Each entry is composed of an error message describing the reason of the failure, so that sellers can take action. The table below displays the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

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

@return CreateScheduledPackagesResponse

func (*EasyShipApiService) GetScheduledPackage ¶

func (a *EasyShipApiService) GetScheduledPackage(ctx context.Context, amazonOrderId string, marketplaceId string) (ModelPackage, *http.Response, error)

EasyShipApiService Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
@param marketplaceId An identifier for the marketplace in which the seller is selling.

@return ModelPackage

func (*EasyShipApiService) ListHandoverSlots ¶

func (a *EasyShipApiService) ListHandoverSlots(ctx context.Context, localVarOptionals *EasyShipApiListHandoverSlotsOpts) (ListHandoverSlotsResponse, *http.Response, error)

func (*EasyShipApiService) UpdateScheduledPackages ¶

func (a *EasyShipApiService) UpdateScheduledPackages(ctx context.Context, localVarOptionals *EasyShipApiUpdateScheduledPackagesOpts) (Packages, *http.Response, error)

type EasyShipApiUpdateScheduledPackagesOpts ¶

type EasyShipApiUpdateScheduledPackagesOpts struct {
	Body optional.Interface
}

type ErrorList ¶

type ErrorList struct {
	Errors []ModelError `json:"errors"`
}

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

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 HandoverMethod ¶

type HandoverMethod string

HandoverMethod : Identifies the method by which a seller will hand a package over to Amazon Logistics.

const (
	PICKUP_HandoverMethod  HandoverMethod = "Pickup"
	DROPOFF_HandoverMethod HandoverMethod = "Dropoff"
)

List of HandoverMethod

type InvoiceData ¶

type InvoiceData struct {
	InvoiceNumber string     `json:"invoiceNumber"`
	InvoiceDate   *time.Time `json:"invoiceDate,omitempty"`
}

Invoice number and date.

type Item ¶

type Item struct {
	OrderItemId            string    `json:"orderItemId,omitempty"`
	OrderItemSerialNumbers *[]string `json:"orderItemSerialNumbers,omitempty"`
}

Item identifier and serial number information.

type LabelFormat ¶

type LabelFormat string

LabelFormat : The file format in which the shipping label will be created.

const (
	PDF_LabelFormat LabelFormat = "PDF"
	ZPL_LabelFormat LabelFormat = "ZPL"
)

List of LabelFormat

type ListHandoverSlotsRequest ¶

type ListHandoverSlotsRequest struct {
	MarketplaceId     string      `json:"marketplaceId"`
	AmazonOrderId     string      `json:"amazonOrderId"`
	PackageDimensions *Dimensions `json:"packageDimensions"`
	PackageWeight     *Weight     `json:"packageWeight"`
}

The request schema for the `listHandoverSlots` operation.

type ListHandoverSlotsResponse ¶

type ListHandoverSlotsResponse struct {
	AmazonOrderId string      `json:"amazonOrderId"`
	TimeSlots     *[]TimeSlot `json:"timeSlots"`
}

The response schema for the `listHandoverSlots` operation.

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 ModelPackage ¶

type ModelPackage struct {
	ScheduledPackageId *ScheduledPackageId `json:"scheduledPackageId"`
	PackageDimensions  *Dimensions         `json:"packageDimensions"`
	PackageWeight      *Weight             `json:"packageWeight"`
	PackageItems       *[]Item             `json:"packageItems,omitempty"`
	PackageTimeSlot    *TimeSlot           `json:"packageTimeSlot"`
	PackageIdentifier  string              `json:"packageIdentifier,omitempty"`
	Invoice            *InvoiceData        `json:"invoice,omitempty"`
	PackageStatus      *PackageStatus      `json:"packageStatus,omitempty"`
	TrackingDetails    *TrackingDetails    `json:"trackingDetails,omitempty"`
}

A package. This object contains all the details of the scheduled Easy Ship package including the package identifier, physical attributes such as dimensions and weight, selected time slot to handover the package to carrier, status of the package, and tracking/invoice details.

type OrderScheduleDetails ¶

type OrderScheduleDetails struct {
	AmazonOrderId  string          `json:"amazonOrderId"`
	PackageDetails *PackageDetails `json:"packageDetails,omitempty"`
}

This object allows users to specify an order to be scheduled. Only the amazonOrderId is required.

type PackageDetails ¶

type PackageDetails struct {
	PackageItems      *[]Item   `json:"packageItems,omitempty"`
	PackageTimeSlot   *TimeSlot `json:"packageTimeSlot"`
	PackageIdentifier string    `json:"packageIdentifier,omitempty"`
}

Package details. Includes `packageItems`, `packageTimeSlot`, and `packageIdentifier`.

type PackageStatus ¶

type PackageStatus string

PackageStatus : The status of the package.

const (
	READY_FOR_PICKUP_PackageStatus   PackageStatus = "ReadyForPickup"
	PICKED_UP_PackageStatus          PackageStatus = "PickedUp"
	AT_ORIGIN_FC_PackageStatus       PackageStatus = "AtOriginFC"
	AT_DESTINATION_FC_PackageStatus  PackageStatus = "AtDestinationFC"
	DELIVERED_PackageStatus          PackageStatus = "Delivered"
	REJECTED_PackageStatus           PackageStatus = "Rejected"
	UNDELIVERABLE_PackageStatus      PackageStatus = "Undeliverable"
	RETURNED_TO_SELLER_PackageStatus PackageStatus = "ReturnedToSeller"
	LOST_IN_TRANSIT_PackageStatus    PackageStatus = "LostInTransit"
	LABEL_CANCELED_PackageStatus     PackageStatus = "LabelCanceled"
	DAMAGED_IN_TRANSIT_PackageStatus PackageStatus = "DamagedInTransit"
	OUT_FOR_DELIVERY_PackageStatus   PackageStatus = "OutForDelivery"
)

List of PackageStatus

type Packages ¶

type Packages struct {
	Packages []ModelPackage `json:"packages"`
}

A list of packages.

type RejectedOrder ¶

type RejectedOrder struct {
	AmazonOrderId string      `json:"amazonOrderId"`
	Error_        *ModelError `json:"error,omitempty"`
}

A order which we couldn't schedule on your behalf. It contains its id, and information on the error.

type ScheduledPackageId ¶

type ScheduledPackageId struct {
	AmazonOrderId string `json:"amazonOrderId"`
	PackageId     string `json:"packageId,omitempty"`
}

Identifies the scheduled package to be updated.

type TimeSlot ¶

type TimeSlot struct {
	SlotId         string          `json:"slotId"`
	StartTime      *time.Time      `json:"startTime,omitempty"`
	EndTime        *time.Time      `json:"endTime,omitempty"`
	HandoverMethod *HandoverMethod `json:"handoverMethod,omitempty"`
}

A time window to hand over an Easy Ship package to Amazon Logistics.

type TrackingDetails ¶

type TrackingDetails struct {
	TrackingId string `json:"trackingId,omitempty"`
}

Representation of tracking metadata.

type UnitOfLength ¶

type UnitOfLength string

UnitOfLength : The unit of measurement used to measure the length.

const (
	CM_UnitOfLength UnitOfLength = "Cm"
)

List of UnitOfLength

type UnitOfWeight ¶

type UnitOfWeight string

UnitOfWeight : The unit of measurement used to measure the weight.

const (
	GRAMS_UnitOfWeight UnitOfWeight = "Grams"
	G_UnitOfWeight     UnitOfWeight = "G"
)

List of UnitOfWeight

type UpdatePackageDetails ¶

type UpdatePackageDetails struct {
	ScheduledPackageId *ScheduledPackageId `json:"scheduledPackageId"`
	PackageTimeSlot    *TimeSlot           `json:"packageTimeSlot"`
}

Request to update the time slot of a package.

type UpdateScheduledPackagesRequest ¶

type UpdateScheduledPackagesRequest struct {
	MarketplaceId            string                  `json:"marketplaceId"`
	UpdatePackageDetailsList *[]UpdatePackageDetails `json:"updatePackageDetailsList"`
}

The request schema for the `updateScheduledPackages` operation.

type Weight ¶

type Weight struct {
	Value float32       `json:"value,omitempty"`
	Unit  *UnitOfWeight `json:"unit,omitempty"`
}

The weight of the scheduled package

Source Files ¶

View all Source files

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