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 Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.

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: 2021-12-28
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
CustomerInvoicesApi	GetCustomerInvoice	Get /vendor/directFulfillment/shipping/2021-12-28/customerInvoices/{purchaseOrderNumber}
CustomerInvoicesApi	GetCustomerInvoices	Get /vendor/directFulfillment/shipping/2021-12-28/customerInvoices
VendorShippingApi	GetPackingSlip	Get /vendor/directFulfillment/shipping/2021-12-28/packingSlips/{purchaseOrderNumber}
VendorShippingApi	GetPackingSlips	Get /vendor/directFulfillment/shipping/2021-12-28/packingSlips
VendorShippingApi	SubmitShipmentConfirmations	Post /vendor/directFulfillment/shipping/2021-12-28/shipmentConfirmations
VendorShippingApi	SubmitShipmentStatusUpdates	Post /vendor/directFulfillment/shipping/2021-12-28/shipmentStatusUpdates
VendorShippingLabelsApi	CreateShippingLabels	Post /vendor/directFulfillment/shipping/2021-12-28/shippingLabels/{purchaseOrderNumber}
VendorShippingLabelsApi	GetShippingLabel	Get /vendor/directFulfillment/shipping/2021-12-28/shippingLabels/{purchaseOrderNumber}
VendorShippingLabelsApi	GetShippingLabels	Get /vendor/directFulfillment/shipping/2021-12-28/shippingLabels
VendorShippingLabelsApi	SubmitShippingLabelRequest	Post /vendor/directFulfillment/shipping/2021-12-28/shippingLabels

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for Direct Fulfillment Shipping * * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data. * * API version: 2021-12-28 * 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 Address
type BasicAuth
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type Container
type CreateShippingLabelsRequest
type CustomerInvoice
type CustomerInvoiceList
type CustomerInvoicesApiGetCustomerInvoicesOpts
type CustomerInvoicesApiService
- func (a *CustomerInvoicesApiService) GetCustomerInvoice(ctx context.Context, purchaseOrderNumber string) (CustomerInvoice, *http.Response, error)
- func (a *CustomerInvoicesApiService) GetCustomerInvoices(ctx context.Context, createdAfter time.Time, createdBefore time.Time, ...) (CustomerInvoiceList, *http.Response, error)
type Dimensions
type ErrorList
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type Item
type ItemQuantity
type LabelData
type ModelError
type PackedItem
type PackingSlip
type PackingSlipList
type Pagination
type PartyIdentification
type ShipmentConfirmation
type ShipmentDetails
type ShipmentSchedule
type ShipmentStatusUpdate
type ShippingLabel
type ShippingLabelList
type ShippingLabelRequest
type StatusUpdateDetails
type SubmitShipmentConfirmationsRequest
type SubmitShipmentStatusUpdatesRequest
type SubmitShippingLabelsRequest
type TaxRegistrationDetails
type TransactionReference
type VendorShippingApiGetPackingSlipsOpts
type VendorShippingApiService
- func (a *VendorShippingApiService) GetPackingSlip(ctx context.Context, purchaseOrderNumber string) (PackingSlip, *http.Response, error)
- func (a *VendorShippingApiService) GetPackingSlips(ctx context.Context, createdAfter time.Time, createdBefore time.Time, ...) (PackingSlipList, *http.Response, error)
- func (a *VendorShippingApiService) SubmitShipmentConfirmations(ctx context.Context, body SubmitShipmentConfirmationsRequest) (TransactionReference, *http.Response, error)
- func (a *VendorShippingApiService) SubmitShipmentStatusUpdates(ctx context.Context, body SubmitShipmentStatusUpdatesRequest) (TransactionReference, *http.Response, error)
type VendorShippingLabelsApiGetShippingLabelsOpts
type VendorShippingLabelsApiService
- func (a *VendorShippingLabelsApiService) CreateShippingLabels(ctx context.Context, body CreateShippingLabelsRequest, ...) (ShippingLabel, *http.Response, error)
- func (a *VendorShippingLabelsApiService) GetShippingLabel(ctx context.Context, purchaseOrderNumber string) (ShippingLabel, *http.Response, error)
- func (a *VendorShippingLabelsApiService) GetShippingLabels(ctx context.Context, createdAfter time.Time, createdBefore time.Time, ...) (ShippingLabelList, *http.Response, error)
- func (a *VendorShippingLabelsApiService) SubmitShippingLabelRequest(ctx context.Context, body SubmitShippingLabelsRequest) (TransactionReference, *http.Response, error)
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 {
	CustomerInvoicesApi *CustomerInvoicesApiService

	VendorShippingApi *VendorShippingApiService

	VendorShippingLabelsApi *VendorShippingLabelsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Direct Fulfillment Shipping API v2021-12-28 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 Address ¶

type Address struct {
	// The name of the person, business or institution at that address.
	Name string `json:"name"`
	// First line of the address.
	AddressLine1 string `json:"addressLine1"`
	// Additional street address information, if required.
	AddressLine2 string `json:"addressLine2,omitempty"`
	// Additional street address information, if required.
	AddressLine3 string `json:"addressLine3,omitempty"`
	// The city where the person, business or institution is located.
	City string `json:"city,omitempty"`
	// The county where person, business or institution is located.
	County string `json:"county,omitempty"`
	// The district where person, business or institution is located.
	District string `json:"district,omitempty"`
	// The state or region where person, business or institution is located.
	StateOrRegion string `json:"stateOrRegion,omitempty"`
	// The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
	PostalCode string `json:"postalCode,omitempty"`
	// 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 that address.
	Phone string `json:"phone,omitempty"`
}

Address of the party.

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

type Container struct {
	// The type of container.
	ContainerType string `json:"containerType"`
	// The container identifier.
	ContainerIdentifier string `json:"containerIdentifier"`
	// The tracking number.
	TrackingNumber string `json:"trackingNumber,omitempty"`
	// The manifest identifier.
	ManifestId string `json:"manifestId,omitempty"`
	// The date of the manifest.
	ManifestDate string `json:"manifestDate,omitempty"`
	// The shipment method. This property is required when calling the submitShipmentConfirmations operation, and optional otherwise.
	ShipMethod string `json:"shipMethod,omitempty"`
	// SCAC code required for NA VOC vendors only.
	ScacCode string `json:"scacCode,omitempty"`
	// Carrier required for EU VOC vendors only.
	Carrier string `json:"carrier,omitempty"`
	// An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.
	ContainerSequenceNumber int32       `json:"containerSequenceNumber,omitempty"`
	Dimensions              *Dimensions `json:"dimensions,omitempty"`
	Weight                  *Weight     `json:"weight,omitempty"`
	// A list of packed items.
	PackedItems []PackedItem `json:"packedItems"`
}

type CreateShippingLabelsRequest ¶

type CreateShippingLabelsRequest struct {
	SellingParty  *PartyIdentification `json:"sellingParty"`
	ShipFromParty *PartyIdentification `json:"shipFromParty"`
	// A list of the packages in this shipment.
	Containers []Container `json:"containers,omitempty"`
}

The request body for the createShippingLabels operation.

type CustomerInvoice ¶

type CustomerInvoice struct {
	// The purchase order number for this order.
	PurchaseOrderNumber string `json:"purchaseOrderNumber"`
	// The Base64encoded customer invoice.
	Content string `json:"content"`
}

type CustomerInvoiceList ¶

type CustomerInvoiceList struct {
	Pagination       *Pagination       `json:"pagination,omitempty"`
	CustomerInvoices []CustomerInvoice `json:"customerInvoices,omitempty"`
}

type CustomerInvoicesApiGetCustomerInvoicesOpts ¶

type CustomerInvoicesApiGetCustomerInvoicesOpts struct {
	ShipFromPartyId optional.String
	Limit           optional.Int32
	SortOrder       optional.String
	NextToken       optional.String
}

type CustomerInvoicesApiService ¶

type CustomerInvoicesApiService service

func (*CustomerInvoicesApiService) GetCustomerInvoice ¶

func (a *CustomerInvoicesApiService) GetCustomerInvoice(ctx context.Context, purchaseOrderNumber string) (CustomerInvoice, *http.Response, error)

CustomerInvoicesApiService Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then 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 purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.

@return CustomerInvoice

func (*CustomerInvoicesApiService) GetCustomerInvoices ¶

func (a *CustomerInvoicesApiService) GetCustomerInvoices(ctx context.Context, createdAfter time.Time, createdBefore time.Time, localVarOptionals *CustomerInvoicesApiGetCustomerInvoicesOpts) (CustomerInvoiceList, *http.Response, error)

type Dimensions ¶

type Dimensions struct {
	Length string `json:"length"`
	Width  string `json:"width"`
	Height string `json:"height"`
	// The unit of measure for dimensions.
	UnitOfMeasure string `json:"unitOfMeasure"`
}

Physical dimensional measurements of a container.

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

type Item struct {
	// Item Sequence Number for the item. This must be the same value as sent in order for a given item.
	ItemSequenceNumber int32 `json:"itemSequenceNumber"`
	// Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
	BuyerProductIdentifier string `json:"buyerProductIdentifier,omitempty"`
	// The vendor selected product identification of the item. Should be the same as was sent in the purchase order, like SKU Number.
	VendorProductIdentifier string        `json:"vendorProductIdentifier,omitempty"`
	ShippedQuantity         *ItemQuantity `json:"shippedQuantity"`
}

Details of the item being shipped.

type ItemQuantity ¶

type ItemQuantity struct {
	// Quantity of units shipped for a specific item at a shipment level. If the item is present only in certain packages or pallets within the shipment, please provide this at the appropriate package or pallet level.
	Amount int32 `json:"amount"`
	// Unit of measure for the shipped quantity.
	UnitOfMeasure string `json:"unitOfMeasure"`
}

Details of item quantity.

type LabelData ¶

type LabelData struct {
	// Identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level.
	PackageIdentifier string `json:"packageIdentifier,omitempty"`
	// Package tracking identifier from the shipping carrier.
	TrackingNumber string `json:"trackingNumber,omitempty"`
	// Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation.
	ShipMethod string `json:"shipMethod,omitempty"`
	// Shipping method name for internal reference.
	ShipMethodName string `json:"shipMethodName,omitempty"`
	// This field will contain the Base64encoded string of the shipment label content.
	Content string `json:"content"`
}

Details of the shipment label.

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

type PackedItem struct {
	// Item Sequence Number for the item. This must be the same value as sent in the order for a given item.
	ItemSequenceNumber int32 `json:"itemSequenceNumber"`
	// Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
	BuyerProductIdentifier string `json:"buyerProductIdentifier,omitempty"`
	// The piece number of the item in this container. This is required when the item is split across different containers.
	PieceNumber int32 `json:"pieceNumber,omitempty"`
	// The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number.
	VendorProductIdentifier string        `json:"vendorProductIdentifier,omitempty"`
	PackedQuantity          *ItemQuantity `json:"packedQuantity"`
}

type PackingSlip ¶

type PackingSlip struct {
	// Purchase order number of the shipment that the packing slip is for.
	PurchaseOrderNumber string `json:"purchaseOrderNumber"`
	// A Base64encoded string of the packing slip PDF.
	Content string `json:"content"`
	// The format of the file such as PDF, JPEG etc.
	ContentType string `json:"contentType,omitempty"`
}

Packing slip information.

type PackingSlipList ¶

type PackingSlipList struct {
	Pagination   *Pagination   `json:"pagination,omitempty"`
	PackingSlips []PackingSlip `json:"packingSlips,omitempty"`
}

A list of packing slips.

type Pagination struct {
	// A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return.
	NextToken string `json:"nextToken,omitempty"`
}

type PartyIdentification ¶

type PartyIdentification struct {
	// Assigned Identification for the party.
	PartyId string   `json:"partyId"`
	Address *Address `json:"address,omitempty"`
	// Tax registration details of the entity.
	TaxRegistrationDetails []TaxRegistrationDetails `json:"taxRegistrationDetails,omitempty"`
}

type ShipmentConfirmation ¶

type ShipmentConfirmation struct {
	// Purchase order number corresponding to the shipment.
	PurchaseOrderNumber string               `json:"purchaseOrderNumber"`
	ShipmentDetails     *ShipmentDetails     `json:"shipmentDetails"`
	SellingParty        *PartyIdentification `json:"sellingParty"`
	ShipFromParty       *PartyIdentification `json:"shipFromParty"`
	// Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.
	Items []Item `json:"items"`
	// Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.
	Containers []Container `json:"containers,omitempty"`
}

type ShipmentDetails ¶

type ShipmentDetails struct {
	// This field indicates the date of the departure of the shipment from vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Amazon destination warehouse, whichever is sooner. Shipped date mentioned in the Shipment Confirmation should not be in the future.
	ShippedDate time.Time `json:"shippedDate"`
	// Indicate the shipment status.
	ShipmentStatus string `json:"shipmentStatus"`
	// Provide the priority of the shipment.
	IsPriorityShipment bool `json:"isPriorityShipment,omitempty"`
	// The vendor order number is a unique identifier generated by a vendor for their reference.
	VendorOrderNumber string `json:"vendorOrderNumber,omitempty"`
	// Date on which the shipment is expected to reach the buyer's warehouse. It needs to be an estimate based on the average transit time between the ship-from location and the destination. The exact appointment time will be provided by buyer and is potentially not known when creating the shipment confirmation.
	EstimatedDeliveryDate time.Time `json:"estimatedDeliveryDate,omitempty"`
}

Details about a shipment.

type ShipmentSchedule ¶

type ShipmentSchedule struct {
	// Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
	EstimatedDeliveryDateTime time.Time `json:"estimatedDeliveryDateTime,omitempty"`
	// This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
	ApptWindowStartDateTime time.Time `json:"apptWindowStartDateTime,omitempty"`
	// This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
	ApptWindowEndDateTime time.Time `json:"apptWindowEndDateTime,omitempty"`
}

Details about the estimated delivery window.

type ShipmentStatusUpdate ¶

type ShipmentStatusUpdate struct {
	// Purchase order number of the shipment for which to update the shipment status.
	PurchaseOrderNumber string               `json:"purchaseOrderNumber"`
	SellingParty        *PartyIdentification `json:"sellingParty"`
	ShipFromParty       *PartyIdentification `json:"shipFromParty"`
	StatusUpdateDetails *StatusUpdateDetails `json:"statusUpdateDetails"`
}

type ShippingLabel ¶

type ShippingLabel struct {
	// This field will contain the Purchase Order Number for this order.
	PurchaseOrderNumber string               `json:"purchaseOrderNumber"`
	SellingParty        *PartyIdentification `json:"sellingParty"`
	ShipFromParty       *PartyIdentification `json:"shipFromParty"`
	// Format of the label.
	LabelFormat string `json:"labelFormat"`
	// Provides the details of the packages in this shipment.
	LabelData []LabelData `json:"labelData"`
}

type ShippingLabelList ¶

type ShippingLabelList struct {
	Pagination     *Pagination     `json:"pagination,omitempty"`
	ShippingLabels []ShippingLabel `json:"shippingLabels,omitempty"`
}

type ShippingLabelRequest ¶

type ShippingLabelRequest struct {
	// Purchase order number of the order for which to create a shipping label.
	PurchaseOrderNumber string               `json:"purchaseOrderNumber"`
	SellingParty        *PartyIdentification `json:"sellingParty"`
	ShipFromParty       *PartyIdentification `json:"shipFromParty"`
	// A list of the packages in this shipment.
	Containers []Container `json:"containers,omitempty"`
}

type StatusUpdateDetails ¶

type StatusUpdateDetails struct {
	// This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation.
	TrackingNumber string `json:"trackingNumber"`
	// Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer.
	StatusCode string `json:"statusCode"`
	// Provides a reason code for the status of the package that will provide additional information about the transportation status.
	ReasonCode string `json:"reasonCode"`
	// The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
	StatusDateTime        time.Time         `json:"statusDateTime"`
	StatusLocationAddress *Address          `json:"statusLocationAddress"`
	ShipmentSchedule      *ShipmentSchedule `json:"shipmentSchedule,omitempty"`
}

Details for the shipment status update given by the vendor for the specific package.

type SubmitShipmentConfirmationsRequest ¶

type SubmitShipmentConfirmationsRequest struct {
	ShipmentConfirmations []ShipmentConfirmation `json:"shipmentConfirmations,omitempty"`
}

type SubmitShipmentStatusUpdatesRequest ¶

type SubmitShipmentStatusUpdatesRequest struct {
	ShipmentStatusUpdates []ShipmentStatusUpdate `json:"shipmentStatusUpdates,omitempty"`
}

type SubmitShippingLabelsRequest ¶

type SubmitShippingLabelsRequest struct {
	ShippingLabelRequests []ShippingLabelRequest `json:"shippingLabelRequests,omitempty"`
}

type TaxRegistrationDetails ¶

type TaxRegistrationDetails struct {
	// Tax registration type for the entity.
	TaxRegistrationType string `json:"taxRegistrationType,omitempty"`
	// Tax registration number for the party. For example, VAT ID.
	TaxRegistrationNumber  string   `json:"taxRegistrationNumber"`
	TaxRegistrationAddress *Address `json:"taxRegistrationAddress,omitempty"`
	// Tax registration message that can be used for additional tax related details.
	TaxRegistrationMessages string `json:"taxRegistrationMessages,omitempty"`
}

Tax registration details of the entity.

type TransactionReference ¶

type TransactionReference struct {
	// GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.
	TransactionId string `json:"transactionId,omitempty"`
}

type VendorShippingApiGetPackingSlipsOpts ¶

type VendorShippingApiGetPackingSlipsOpts struct {
	ShipFromPartyId optional.String
	Limit           optional.Int32
	SortOrder       optional.String
	NextToken       optional.String
}

type VendorShippingApiService ¶

type VendorShippingApiService service

func (*VendorShippingApiService) GetPackingSlip ¶

func (a *VendorShippingApiService) GetPackingSlip(ctx context.Context, purchaseOrderNumber string) (PackingSlip, *http.Response, error)

VendorShippingApiService Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then 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 purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.

@return PackingSlip

func (*VendorShippingApiService) GetPackingSlips ¶

func (a *VendorShippingApiService) GetPackingSlips(ctx context.Context, createdAfter time.Time, createdBefore time.Time, localVarOptionals *VendorShippingApiGetPackingSlipsOpts) (PackingSlipList, *http.Response, error)

func (*VendorShippingApiService) SubmitShipmentConfirmations ¶

func (a *VendorShippingApiService) SubmitShipmentConfirmations(ctx context.Context, body SubmitShipmentConfirmationsRequest) (TransactionReference, *http.Response, error)

VendorShippingApiService Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then 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 TransactionReference

func (*VendorShippingApiService) SubmitShipmentStatusUpdates ¶

func (a *VendorShippingApiService) SubmitShipmentStatusUpdates(ctx context.Context, body SubmitShipmentStatusUpdatesRequest) (TransactionReference, *http.Response, error)

VendorShippingApiService This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then 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 TransactionReference

type VendorShippingLabelsApiGetShippingLabelsOpts ¶

type VendorShippingLabelsApiGetShippingLabelsOpts struct {
	ShipFromPartyId optional.String
	Limit           optional.Int32
	SortOrder       optional.String
	NextToken       optional.String
}

type VendorShippingLabelsApiService ¶

type VendorShippingLabelsApiService service

func (*VendorShippingLabelsApiService) CreateShippingLabels ¶

func (a *VendorShippingLabelsApiService) CreateShippingLabels(ctx context.Context, body CreateShippingLabelsRequest, purchaseOrderNumber string) (ShippingLabel, *http.Response, error)

VendorShippingLabelsApiService Creates shipping labels for a purchase order and returns the labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then 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
@param purchaseOrderNumber The purchase order number for which you want to return the shipping labels. It should be the same purchaseOrderNumber as received in the order.

@return ShippingLabel

func (*VendorShippingLabelsApiService) GetShippingLabel ¶

func (a *VendorShippingLabelsApiService) GetShippingLabel(ctx context.Context, purchaseOrderNumber string) (ShippingLabel, *http.Response, error)

VendorShippingLabelsApiService Returns a shipping label for the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then 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 purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.

@return ShippingLabel

func (*VendorShippingLabelsApiService) GetShippingLabels ¶

func (a *VendorShippingLabelsApiService) GetShippingLabels(ctx context.Context, createdAfter time.Time, createdBefore time.Time, localVarOptionals *VendorShippingLabelsApiGetShippingLabelsOpts) (ShippingLabelList, *http.Response, error)

func (*VendorShippingLabelsApiService) SubmitShippingLabelRequest ¶

func (a *VendorShippingLabelsApiService) SubmitShippingLabelRequest(ctx context.Context, body SubmitShippingLabelsRequest) (TransactionReference, *http.Response, error)

VendorShippingLabelsApiService Creates a shipping label for a purchase order and returns a transactionId for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then 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 TransactionReference

type Weight ¶

type Weight struct {
	// The unit of measurement.
	UnitOfMeasure string `json:"unitOfMeasure"`
	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

README ¶

Go API client for swagger

Overview

Installation

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

Author

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func CacheExpires ¶

Types ¶

type APIClient ¶

func NewAPIClient ¶

func (*APIClient) ChangeBasePath ¶

type APIKey ¶

type APIResponse ¶

func NewAPIResponse ¶

func NewAPIResponseWithError ¶

type Address ¶

type BasicAuth ¶

type Configuration ¶

func NewConfiguration ¶

func (*Configuration) AddDefaultHeader ¶

type Container ¶

type CreateShippingLabelsRequest ¶

type CustomerInvoice ¶

type CustomerInvoiceList ¶

type CustomerInvoicesApiGetCustomerInvoicesOpts ¶

type CustomerInvoicesApiService ¶

func (*CustomerInvoicesApiService) GetCustomerInvoice ¶

func (*CustomerInvoicesApiService) GetCustomerInvoices ¶

type Dimensions ¶

type ErrorList ¶

type GenericSwaggerError ¶

func (GenericSwaggerError) Body ¶

func (GenericSwaggerError) Error ¶

func (GenericSwaggerError) Model ¶

type Item ¶

type ItemQuantity ¶

type LabelData ¶

type ModelError ¶

type PackedItem ¶

type PackingSlip ¶

type PackingSlipList ¶

type Pagination ¶

type PartyIdentification ¶

type ShipmentConfirmation ¶

type ShipmentDetails ¶

type ShipmentSchedule ¶

type ShipmentStatusUpdate ¶

type ShippingLabel ¶

type ShippingLabelList ¶

type ShippingLabelRequest ¶

type StatusUpdateDetails ¶

type SubmitShipmentConfirmationsRequest ¶

type SubmitShipmentStatusUpdatesRequest ¶

type SubmitShippingLabelsRequest ¶

type TaxRegistrationDetails ¶

type TransactionReference ¶

type VendorShippingApiGetPackingSlipsOpts ¶

type VendorShippingApiService ¶

func (*VendorShippingApiService) GetPackingSlip ¶

func (*VendorShippingApiService) GetPackingSlips ¶

func (*VendorShippingApiService) SubmitShipmentConfirmations ¶

func (*VendorShippingApiService) SubmitShipmentStatusUpdates ¶

type VendorShippingLabelsApiGetShippingLabelsOpts ¶

type VendorShippingLabelsApiService ¶

func (*VendorShippingLabelsApiService) CreateShippingLabels ¶

func (*VendorShippingLabelsApiService) GetShippingLabel ¶

func (*VendorShippingLabelsApiService) GetShippingLabels ¶

func (*VendorShippingLabelsApiService) SubmitShippingLabelRequest ¶

type Weight ¶

Source Files ¶