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 Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.

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: v1
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
VendorShippingApi	GetShipmentDetails	Get /vendor/shipping/v1/shipments
VendorShippingApi	GetShipmentLabels	Get /vendor/shipping/v1/transportLabels
VendorShippingApi	SubmitShipmentConfirmations	Post /vendor/shipping/v1/shipmentConfirmations
VendorShippingApi	SubmitShipments	Post /vendor/shipping/v1/shipments

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for Retail Procurement Shipments * * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors. * * API version: v1 * 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 CarrierDetails
type Carton
type CartonReferenceDetails
type CollectFreightPickupDetails
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ContainerIdentification
type ContainerItem
type ContainerSequenceNumbers
type Containers
type Dimensions
type Duration
type Expiry
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetShipmentDetailsResponse
type GetShipmentLabels
type ImportDetails
type InnerContainersDetails
type Item
type ItemDetails
type ItemQuantity
type LabelData
type Location
type ModelError
type Money
type PackageItemDetails
type PackedItems
type PackedQuantity
type Pagination
type Pallet
type PartyIdentification
type PurchaseOrderItemDetails
type PurchaseOrderItems
type PurchaseOrders
type Route
type Shipment
type ShipmentConfirmation
type ShipmentDetails
type ShipmentInformation
type ShipmentMeasurements
type ShipmentStatusDetails
type Stop
type SubmitShipmentConfirmationsRequest
type SubmitShipmentConfirmationsResponse
type SubmitShipments
type TaxRegistrationDetails
type TransactionReference
type TransportLabel
type TransportShipmentMeasurements
type TransportationDetails
type TransportationLabels
type VendorDetails
type VendorShippingApiGetShipmentDetailsOpts
type VendorShippingApiGetShipmentLabelsOpts
type VendorShippingApiService
- func (a *VendorShippingApiService) GetShipmentDetails(ctx context.Context, ...) (GetShipmentDetailsResponse, *http.Response, error)
- func (a *VendorShippingApiService) GetShipmentLabels(ctx context.Context, localVarOptionals *VendorShippingApiGetShipmentLabelsOpts) (GetShipmentLabels, *http.Response, error)
- func (a *VendorShippingApiService) SubmitShipmentConfirmations(ctx context.Context, body SubmitShipmentConfirmationsRequest) (SubmitShipmentConfirmationsResponse, *http.Response, error)
- func (a *VendorShippingApiService) SubmitShipments(ctx context.Context, body SubmitShipments) (SubmitShipmentConfirmationsResponse, *http.Response, error)
type Volume
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 {
	VendorShippingApi *VendorShippingApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Retail Procurement Shipments API vv1 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 CarrierDetails ¶

type CarrierDetails struct {
	// The field is used to represent the carrier used for performing the shipment.
	Name string `json:"name,omitempty"`
	// Code that identifies the carrier for the shipment. The Standard Carrier Alpha Code (SCAC) is a unique two to four letter code used to identify a carrier. Carrier SCAC codes are assigned and maintained by the NMFTA (National Motor Freight Association).
	Code string `json:"code,omitempty"`
	// The field is used to represent the Carrier contact number.
	Phone string `json:"phone,omitempty"`
	// The field is used to represent the carrier Email id.
	Email string `json:"email,omitempty"`
	// The field is also known as PRO number is a unique number assigned by the carrier. It is used to identify and track the shipment that goes out for delivery. This field is mandatory for US, CA, MX shipment confirmations.
	ShipmentReferenceNumber string `json:"shipmentReferenceNumber,omitempty"`
}

type Carton ¶

type Carton struct {
	// A list of carton identifiers.
	CartonIdentifiers []ContainerIdentification `json:"cartonIdentifiers,omitempty"`
	// Carton sequence number for the carton. The first carton will be 001, the second 002, and so on. This number is used as a reference to refer to this carton from the pallet level.
	CartonSequenceNumber string      `json:"cartonSequenceNumber"`
	Dimensions           *Dimensions `json:"dimensions,omitempty"`
	Weight               *Weight     `json:"weight,omitempty"`
	// This is required to be provided for every carton in the small parcel shipments.
	TrackingNumber string `json:"trackingNumber,omitempty"`
	// A list of container item details.
	Items []ContainerItem `json:"items"`
}

Details of the carton/package being shipped.

type CartonReferenceDetails ¶

type CartonReferenceDetails struct {
	// Pallet level carton count is mandatory for single item pallet and optional for mixed item pallet.
	CartonCount int32 `json:"cartonCount,omitempty"`
	// Array of reference numbers for the carton that are part of this pallet/shipment. Please provide the cartonSequenceNumber from the 'cartons' segment to refer to that carton's details here.
	CartonReferenceNumbers []string `json:"cartonReferenceNumbers"`
}

type CollectFreightPickupDetails ¶

type CollectFreightPickupDetails struct {
	// Date on which the items can be picked up from vendor warehouse by Buyer used for WePay/Collect vendors.
	RequestedPickUp time.Time `json:"requestedPickUp,omitempty"`
	// Date on which the items are scheduled to be picked from vendor warehouse by Buyer used for WePay/Collect vendors.
	ScheduledPickUp time.Time `json:"scheduledPickUp,omitempty"`
	// Date on which the carrier is being scheduled to pickup items from vendor warehouse by Byer used for WePay/Collect vendors.
	CarrierAssignmentDate time.Time `json:"carrierAssignmentDate,omitempty"`
}

Transport Request pickup date from Vendor Warehouse by Buyer

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

type ContainerIdentification struct {
	// The container identification type.
	ContainerIdentificationType string `json:"containerIdentificationType"`
	// Container identification number that adheres to the definition of the container identification type.
	ContainerIdentificationNumber string `json:"containerIdentificationNumber"`
}

type ContainerItem ¶

type ContainerItem struct {
	// The reference number for the item. Please provide the itemSequenceNumber from the 'items' segment to refer to that item's details here.
	ItemReference   string        `json:"itemReference"`
	ShippedQuantity *ItemQuantity `json:"shippedQuantity"`
	ItemDetails     *ItemDetails  `json:"itemDetails,omitempty"`
}

Carton/Pallet level details for the item.

type ContainerSequenceNumbers ¶

type ContainerSequenceNumbers struct {
	// A list of containers shipped
	ContainerSequenceNumber string `json:"containerSequenceNumber,omitempty"`
}

type Containers ¶

type Containers struct {
	// The type of container.
	ContainerType string `json:"containerType"`
	// An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.
	ContainerSequenceNumber string `json:"containerSequenceNumber,omitempty"`
	// A list of carton identifiers.
	ContainerIdentifiers []ContainerIdentification `json:"containerIdentifiers"`
	// The tracking number used for identifying the shipment.
	TrackingNumber string      `json:"trackingNumber,omitempty"`
	Dimensions     *Dimensions `json:"dimensions,omitempty"`
	Weight         *Weight     `json:"weight,omitempty"`
	// Number of layers per pallet.
	Tier int32 `json:"tier,omitempty"`
	// Number of cartons per layer on the pallet.
	Block                  int32                   `json:"block,omitempty"`
	InnerContainersDetails *InnerContainersDetails `json:"innerContainersDetails,omitempty"`
	// A list of packed items.
	PackedItems []PackedItems `json:"packedItems,omitempty"`
}

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

type Duration struct {
	// Unit for duration.
	DurationUnit string `json:"durationUnit"`
	// Value for the duration in terms of the durationUnit.
	DurationValue int32 `json:"durationValue"`
}

type Expiry ¶

type Expiry struct {
	// Production, packaging or assembly date determined by the manufacturer. Its meaning is determined based on the trade item context.
	ManufacturerDate time.Time `json:"manufacturerDate,omitempty"`
	// The date that determines the limit of consumption or use of a product. Its meaning is determined based on the trade item context.
	ExpiryDate          time.Time `json:"expiryDate,omitempty"`
	ExpiryAfterDuration *Duration `json:"expiryAfterDuration,omitempty"`
}

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

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

The response schema for the GetShipmentDetails operation.

type GetShipmentLabels ¶

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

The response schema for the GetShipmentLabels operation.

type ImportDetails ¶

type ImportDetails struct {
	// This is used for import purchase orders only. If the recipient requests, this field will contain the shipment method of payment.
	MethodOfPayment string `json:"methodOfPayment,omitempty"`
	// The container's seal number.
	SealNumber string `json:"sealNumber,omitempty"`
	Route      *Route `json:"route,omitempty"`
	// Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if shipment has multiple containers.
	ImportContainers string  `json:"importContainers,omitempty"`
	BillableWeight   *Weight `json:"billableWeight,omitempty"`
	// Date on which the shipment is expected to be shipped. This value should not be in the past and not more than 60 days out in the future.
	EstimatedShipByDate time.Time `json:"estimatedShipByDate,omitempty"`
	// Identification of the instructions on how specified item/carton/pallet should be handled.
	HandlingInstructions string `json:"handlingInstructions,omitempty"`
}

type InnerContainersDetails ¶

type InnerContainersDetails struct {
	// Total containers as part of the shipment
	ContainerCount int32 `json:"containerCount,omitempty"`
	// Container sequence numbers that are involved in this shipment.
	ContainerSequenceNumbers []ContainerSequenceNumbers `json:"containerSequenceNumbers,omitempty"`
}

Details of the innerContainersDetails.

type Item ¶

type Item struct {
	// Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level.
	ItemSequenceNumber string `json:"itemSequenceNumber"`
	// Buyer Standard Identification Number (ASIN) of an item.
	AmazonProductIdentifier string `json:"amazonProductIdentifier,omitempty"`
	// The vendor selected product identification of the item. Should be the same as was sent in the purchase order.
	VendorProductIdentifier string        `json:"vendorProductIdentifier,omitempty"`
	ShippedQuantity         *ItemQuantity `json:"shippedQuantity"`
	ItemDetails             *ItemDetails  `json:"itemDetails,omitempty"`
}

Details of the item being shipped.

type ItemDetails ¶

type ItemDetails struct {
	// The purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code.
	PurchaseOrderNumber string `json:"purchaseOrderNumber,omitempty"`
	// The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items.
	LotNumber          string  `json:"lotNumber,omitempty"`
	Expiry             *Expiry `json:"expiry,omitempty"`
	MaximumRetailPrice *Money  `json:"maximumRetailPrice,omitempty"`
	// Identification of the instructions on how specified item/carton/pallet should be handled.
	HandlingCode string `json:"handlingCode,omitempty"`
}

Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.

type ItemQuantity ¶

type ItemQuantity struct {
	// Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level.
	Amount int32 `json:"amount"`
	// Unit of measure for the shipped quantity.
	UnitOfMeasure string `json:"unitOfMeasure"`
	// The case size, in the event that we ordered using cases. Otherwise, 1.
	UnitSize int32 `json:"unitSize,omitempty"`
}

Details of item quantity.

type LabelData ¶

type LabelData struct {
	// Label list sequence number
	LabelSequenceNumber int32 `json:"labelSequenceNumber,omitempty"`
	// Type of the label format like PDF
	LabelFormat string `json:"labelFormat,omitempty"`
	// Unique identification for  the carrier like UPS,DHL,USPS..etc
	CarrierCode string `json:"carrierCode,omitempty"`
	// Tracking Id for the transportation.
	TrackingId string `json:"trackingId,omitempty"`
	// Label created as part of the transportation and it is base64 encoded
	Label string `json:"label,omitempty"`
}

Label details as part of the transport label response

type Location ¶

type Location struct {
	// Type of location identification.
	Type_ string `json:"type,omitempty"`
	// Location code.
	LocationCode string `json:"locationCode,omitempty"`
	// The two digit country code. In ISO 3166-1 alpha-2 format.
	CountryCode string `json:"countryCode,omitempty"`
}

Location identifier.

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"`
	Amount       string `json:"amount"`
}

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

type PackageItemDetails ¶

type PackageItemDetails struct {
	// The purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code.
	PurchaseOrderNumber string `json:"purchaseOrderNumber,omitempty"`
	// The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items.
	LotNumber string  `json:"lotNumber,omitempty"`
	Expiry    *Expiry `json:"expiry,omitempty"`
}

Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.

type PackedItems ¶

type PackedItems struct {
	// Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level.
	ItemSequenceNumber string `json:"itemSequenceNumber,omitempty"`
	// Buyer Standard Identification Number (ASIN) of an item.
	BuyerProductIdentifier string `json:"buyerProductIdentifier,omitempty"`
	// The vendor selected product identification of the item. Should be the same as was sent in the purchase order.
	VendorProductIdentifier string              `json:"vendorProductIdentifier,omitempty"`
	PackedQuantity          *ItemQuantity       `json:"packedQuantity,omitempty"`
	ItemDetails             *PackageItemDetails `json:"itemDetails,omitempty"`
}

Details of the item being shipped.

type PackedQuantity ¶

type PackedQuantity struct {
	// Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level.
	Amount int32 `json:"amount"`
	// Unit of measure for the shipped quantity.
	UnitOfMeasure string `json:"unitOfMeasure"`
	// The case size, in the event that we ordered using cases. Otherwise, 1.
	UnitSize int32 `json:"unitSize,omitempty"`
}

Details of item quantity.

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

type Pallet struct {
	// A list of pallet identifiers.
	PalletIdentifiers []ContainerIdentification `json:"palletIdentifiers"`
	// Number of layers per pallet. Only applicable to container type Pallet.
	Tier int32 `json:"tier,omitempty"`
	// Number of cartons per layer on the pallet. Only applicable to container type Pallet.
	Block                  int32                   `json:"block,omitempty"`
	Dimensions             *Dimensions             `json:"dimensions,omitempty"`
	Weight                 *Weight                 `json:"weight,omitempty"`
	CartonReferenceDetails *CartonReferenceDetails `json:"cartonReferenceDetails,omitempty"`
	// A list of container item details.
	Items []ContainerItem `json:"items,omitempty"`
}

Details of the Pallet/Tare being shipped.

type PartyIdentification ¶

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

type PurchaseOrderItemDetails ¶

type PurchaseOrderItemDetails struct {
	MaximumRetailPrice *Money `json:"maximumRetailPrice,omitempty"`
}

Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.

type PurchaseOrderItems ¶

type PurchaseOrderItems struct {
	// Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level.
	ItemSequenceNumber string `json:"itemSequenceNumber"`
	// Amazon Standard Identification Number (ASIN) for a SKU
	BuyerProductIdentifier string `json:"buyerProductIdentifier,omitempty"`
	// The vendor selected product identification of the item. Should be the same as was sent in the purchase order.
	VendorProductIdentifier string        `json:"vendorProductIdentifier,omitempty"`
	ShippedQuantity         *ItemQuantity `json:"shippedQuantity"`
	MaximumRetailPrice      *Money        `json:"maximumRetailPrice,omitempty"`
}

Details of the item being shipped.

type PurchaseOrders ¶

type PurchaseOrders struct {
	// Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment.
	PurchaseOrderNumber string `json:"purchaseOrderNumber,omitempty"`
	// Purchase order numbers involved in this shipment, list all the PO that are involved as part of this shipment.
	PurchaseOrderDate time.Time `json:"purchaseOrderDate,omitempty"`
	// Date range in which shipment is expected for these purchase orders.
	ShipWindow string `json:"shipWindow,omitempty"`
	// A list of the items that are associated to the PO in this transport and their associated details.
	Items []PurchaseOrderItems `json:"items,omitempty"`
}

Transport Request pickup date

type Route ¶

type Route struct {
	Stops []Stop `json:"stops"`
}

This is used only for direct import shipment confirmations.

type Shipment ¶

type Shipment struct {
	// Unique Transportation ID created by Vendor (Should not be used over the last 365 days).
	VendorShipmentIdentifier string `json:"vendorShipmentIdentifier"`
	// Indicates the type of  transportation request such as (New,Cancel,Confirm and PackageLabelRequest). Each transactiontype has a unique set of operation and there are corresponding details to be populated for each operation.
	TransactionType string `json:"transactionType"`
	// The buyer Reference Number is a unique identifier generated by buyer for all Collect/WePay shipments when you submit a transportation request. This field is mandatory for Collect/WePay shipments.
	BuyerReferenceNumber string `json:"buyerReferenceNumber,omitempty"`
	// Date on which the transportation request was submitted.
	TransactionDate time.Time `json:"transactionDate"`
	// Indicates the current shipment status.
	CurrentShipmentStatus string `json:"currentShipmentStatus,omitempty"`
	// Date and time when the last status was updated.
	CurrentshipmentStatusDate time.Time `json:"currentshipmentStatusDate,omitempty"`
	// Indicates the list of current shipment status details and when the last update was received from carrier this is available on shipment Details response.
	ShipmentStatusDetails []ShipmentStatusDetails `json:"shipmentStatusDetails,omitempty"`
	// The date and time of the shipment request created by vendor.
	ShipmentCreateDate time.Time `json:"shipmentCreateDate,omitempty"`
	// The date and time of the departure of the shipment from the 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 Buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future.
	ShipmentConfirmDate time.Time `json:"shipmentConfirmDate,omitempty"`
	// The date and time of the package label created for the shipment by buyer.
	PackageLabelCreateDate time.Time `json:"packageLabelCreateDate,omitempty"`
	// Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid. This is a mandatory information.
	ShipmentFreightTerm         string                         `json:"shipmentFreightTerm,omitempty"`
	SellingParty                *PartyIdentification           `json:"sellingParty"`
	ShipFromParty               *PartyIdentification           `json:"shipFromParty"`
	ShipToParty                 *PartyIdentification           `json:"shipToParty"`
	ShipmentMeasurements        *TransportShipmentMeasurements `json:"shipmentMeasurements,omitempty"`
	CollectFreightPickupDetails *CollectFreightPickupDetails   `json:"collectFreightPickupDetails,omitempty"`
	// Indicates the purchase orders involved for the transportation request. This group is an array create 1 for each PO and list their corresponding items. This information is used for deciding the route,truck allocation and storage efficiently. This is a mandatory information for Buyer performing transportation from vendor warehouse (WePay/Collect)
	PurchaseOrders []PurchaseOrders `json:"purchaseOrders,omitempty"`
	ImportDetails  *ImportDetails   `json:"importDetails,omitempty"`
	// A list of the items in this transportation and their associated inner container details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level.
	Containers            []Containers           `json:"containers,omitempty"`
	TransportationDetails *TransportationDetails `json:"transportationDetails,omitempty"`
}

type ShipmentConfirmation ¶

type ShipmentConfirmation struct {
	// Unique shipment ID (not used over the last 365 days).
	ShipmentIdentifier string `json:"shipmentIdentifier"`
	// Indicates if this shipment confirmation is the initial confirmation, or intended to replace an already posted shipment confirmation. If replacing an existing shipment confirmation, be sure to provide the identical shipmentIdentifier and sellingParty information as in the previous confirmation.
	ShipmentConfirmationType string `json:"shipmentConfirmationType"`
	// The type of shipment.
	ShipmentType string `json:"shipmentType,omitempty"`
	// Shipment hierarchical structure.
	ShipmentStructure     string                 `json:"shipmentStructure,omitempty"`
	TransportationDetails *TransportationDetails `json:"transportationDetails,omitempty"`
	// The Amazon Reference Number is a unique identifier generated by Amazon for all Collect/WePay shipments when you submit  a routing request. This field is mandatory for Collect/WePay shipments.
	AmazonReferenceNumber string `json:"amazonReferenceNumber,omitempty"`
	// Date on which the shipment confirmation was submitted.
	ShipmentConfirmationDate time.Time `json:"shipmentConfirmationDate"`
	// The date and time of the departure of the shipment from the 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 buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future.
	ShippedDate time.Time `json:"shippedDate,omitempty"`
	// The date and time on which the shipment is estimated to reach buyer's warehouse. It needs to be an estimate based on the average transit time between ship from location and the destination. The exact appointment time will be provided by the buyer and is potentially not known when creating the shipment confirmation.
	EstimatedDeliveryDate time.Time             `json:"estimatedDeliveryDate,omitempty"`
	SellingParty          *PartyIdentification  `json:"sellingParty"`
	ShipFromParty         *PartyIdentification  `json:"shipFromParty"`
	ShipToParty           *PartyIdentification  `json:"shipToParty"`
	ShipmentMeasurements  *ShipmentMeasurements `json:"shipmentMeasurements,omitempty"`
	ImportDetails         *ImportDetails        `json:"importDetails,omitempty"`
	// A list of the items in this shipment and their associated details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level.
	ShippedItems []Item `json:"shippedItems"`
	// A list of the cartons in this shipment.
	Cartons []Carton `json:"cartons,omitempty"`
	// A list of the pallets in this shipment.
	Pallets []Pallet `json:"pallets,omitempty"`
}

type ShipmentDetails ¶

type ShipmentDetails struct {
	Pagination *Pagination `json:"pagination,omitempty"`
	Shipments  []Shipment  `json:"shipments,omitempty"`
}

type ShipmentInformation ¶

type ShipmentInformation struct {
	VendorDetails *VendorDetails `json:"vendorDetails,omitempty"`
	// Buyer Reference number which is a unique number.
	BuyerReferenceNumber string               `json:"buyerReferenceNumber,omitempty"`
	ShipToParty          *PartyIdentification `json:"shipToParty,omitempty"`
	ShipFromParty        *PartyIdentification `json:"shipFromParty,omitempty"`
	// Vendor Warehouse ID from where the shipment is scheduled to be picked up by buyer / Carrier.
	WarehouseId string `json:"warehouseId,omitempty"`
	// Unique Id with  which  the shipment can be tracked for Small Parcels.
	MasterTrackingId string `json:"masterTrackingId,omitempty"`
	// Number of Labels that are created as part of this shipment.
	TotalLabelCount int32 `json:"totalLabelCount,omitempty"`
	// Type of shipment whether it is Small Parcel
	ShipMode string `json:"shipMode,omitempty"`
}

Shipment Information details for Label request.

type ShipmentMeasurements ¶

type ShipmentMeasurements struct {
	GrossShipmentWeight *Weight `json:"grossShipmentWeight,omitempty"`
	ShipmentVolume      *Volume `json:"shipmentVolume,omitempty"`
	// Number of cartons present in the shipment. Provide the cartonCount only for non-palletized shipments.
	CartonCount int32 `json:"cartonCount,omitempty"`
	// Number of pallets present in the shipment. Provide the palletCount only for palletized shipments.
	PalletCount int32 `json:"palletCount,omitempty"`
}

Shipment measurement details.

type ShipmentStatusDetails ¶

type ShipmentStatusDetails struct {
	// Current status of the shipment on whether it is picked up or scheduled.
	ShipmentStatus string `json:"shipmentStatus,omitempty"`
	// Date and time on last status update received for the shipment
	ShipmentStatusDate time.Time `json:"shipmentStatusDate,omitempty"`
}

Shipment Status details.

type Stop ¶

type Stop struct {
	// Provide the function code.
	FunctionCode           string    `json:"functionCode"`
	LocationIdentification *Location `json:"locationIdentification,omitempty"`
	// Date and time of the arrival of the cargo.
	ArrivalTime time.Time `json:"arrivalTime,omitempty"`
	// Date and time of the departure of the cargo.
	DepartureTime time.Time `json:"departureTime,omitempty"`
}

Contractual or operational port or point relevant to the movement of the cargo.

type SubmitShipmentConfirmationsRequest ¶

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

The request schema for the SubmitShipmentConfirmations operation.

type SubmitShipmentConfirmationsResponse ¶

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

The response schema for the SubmitShipmentConfirmations operation.

type SubmitShipments ¶

type SubmitShipments struct {
	Shipments []Shipment `json:"shipments,omitempty"`
}

The request schema for the SubmitTransportRequestConfirmations operation.

type TaxRegistrationDetails ¶

type TaxRegistrationDetails struct {
	// Tax registration type for the entity.
	TaxRegistrationType string `json:"taxRegistrationType"`
	// Tax registration number for the entity. For example, VAT ID.
	TaxRegistrationNumber string `json:"taxRegistrationNumber"`
}

Tax registration details of the entity.

type TransactionReference ¶

type TransactionReference struct {
	// GUID assigned by Buyer 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 TransportLabel ¶

type TransportLabel struct {
	// Date on which label is created.
	LabelCreateDateTime string               `json:"labelCreateDateTime,omitempty"`
	ShipmentInformation *ShipmentInformation `json:"shipmentInformation,omitempty"`
	// Indicates the label data,format and type associated .
	LabelData []LabelData `json:"labelData,omitempty"`
}

type TransportShipmentMeasurements ¶

type TransportShipmentMeasurements struct {
	// Total number of cartons present in the shipment. Provide the cartonCount only for non-palletized shipments.
	TotalCartonCount int32 `json:"totalCartonCount,omitempty"`
	// Total number of Stackable Pallets present in the shipment.
	TotalPalletStackable int32 `json:"totalPalletStackable,omitempty"`
	// Total number of Non Stackable Pallets present in the shipment.
	TotalPalletNonStackable int32   `json:"totalPalletNonStackable,omitempty"`
	ShipmentWeight          *Weight `json:"shipmentWeight,omitempty"`
	ShipmentVolume          *Volume `json:"shipmentVolume,omitempty"`
}

Shipment measurement details.

type TransportationDetails ¶

type TransportationDetails struct {
	// The type of shipment.
	ShipMode string `json:"shipMode,omitempty"`
	// The mode of transportation for this shipment.
	TransportationMode string `json:"transportationMode,omitempty"`
	// Date when shipment is performed by the Vendor to Buyer
	ShippedDate time.Time `json:"shippedDate,omitempty"`
	// Estimated Date on which shipment will be delivered from Vendor to Buyer
	EstimatedDeliveryDate time.Time `json:"estimatedDeliveryDate,omitempty"`
	// Date on which shipment will be delivered from Vendor to Buyer
	ShipmentDeliveryDate time.Time       `json:"shipmentDeliveryDate,omitempty"`
	CarrierDetails       *CarrierDetails `json:"carrierDetails,omitempty"`
	// Bill Of Lading (BOL) number is the unique number assigned by the vendor. The BOL present in the Shipment Confirmation message ideally matches the paper BOL provided with the shipment, but that is no must. Instead of BOL, an alternative reference number (like Delivery Note Number) for the shipment can also be sent in this field.
	BillOfLadingNumber string `json:"billOfLadingNumber,omitempty"`
}

type TransportationLabels ¶

type TransportationLabels struct {
	Pagination      *Pagination      `json:"pagination,omitempty"`
	TransportLabels []TransportLabel `json:"transportLabels,omitempty"`
}

type VendorDetails ¶

type VendorDetails struct {
	SellingParty *PartyIdentification `json:"sellingParty,omitempty"`
	// Unique vendor shipment id which is not used in last 365 days
	VendorShipmentId time.Time `json:"vendorShipmentId,omitempty"`
}

Vendor Details as part of Label response.

type VendorShippingApiGetShipmentDetailsOpts ¶

type VendorShippingApiGetShipmentDetailsOpts struct {
	Limit                     optional.Int64
	SortOrder                 optional.String
	NextToken                 optional.String
	CreatedAfter              optional.Time
	CreatedBefore             optional.Time
	ShipmentConfirmedBefore   optional.Time
	ShipmentConfirmedAfter    optional.Time
	PackageLabelCreatedBefore optional.Time
	PackageLabelCreatedAfter  optional.Time
	ShippedBefore             optional.Time
	ShippedAfter              optional.Time
	EstimatedDeliveryBefore   optional.Time
	EstimatedDeliveryAfter    optional.Time
	ShipmentDeliveryBefore    optional.Time
	ShipmentDeliveryAfter     optional.Time
	RequestedPickUpBefore     optional.Time
	RequestedPickUpAfter      optional.Time
	ScheduledPickUpBefore     optional.Time
	ScheduledPickUpAfter      optional.Time
	CurrentShipmentStatus     optional.String
	VendorShipmentIdentifier  optional.String
	BuyerReferenceNumber      optional.String
	BuyerWarehouseCode        optional.String
	SellerWarehouseCode       optional.String
}

type VendorShippingApiGetShipmentLabelsOpts ¶

type VendorShippingApiGetShipmentLabelsOpts struct {
	Limit                    optional.Int64
	SortOrder                optional.String
	NextToken                optional.String
	LabelCreatedAfter        optional.Time
	LabelcreatedBefore       optional.Time
	BuyerReferenceNumber     optional.String
	VendorShipmentIdentifier optional.String
	SellerWarehouseCode      optional.String
}

type VendorShippingApiService ¶

type VendorShippingApiService service

func (*VendorShippingApiService) GetShipmentDetails ¶

func (a *VendorShippingApiService) GetShipmentDetails(ctx context.Context, localVarOptionals *VendorShippingApiGetShipmentDetailsOpts) (GetShipmentDetailsResponse, *http.Response, error)

func (*VendorShippingApiService) GetShipmentLabels ¶

func (a *VendorShippingApiService) GetShipmentLabels(ctx context.Context, localVarOptionals *VendorShippingApiGetShipmentLabelsOpts) (GetShipmentLabels, *http.Response, error)

func (*VendorShippingApiService) SubmitShipmentConfirmations ¶

func (a *VendorShippingApiService) SubmitShipmentConfirmations(ctx context.Context, body SubmitShipmentConfirmationsRequest) (SubmitShipmentConfirmationsResponse, *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 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 SubmitShipmentConfirmationsResponse

func (*VendorShippingApiService) SubmitShipments ¶

func (a *VendorShippingApiService) SubmitShipments(ctx context.Context, body SubmitShipments) (SubmitShipmentConfirmationsResponse, *http.Response, error)

VendorShippingApiService Submits one or more shipment request 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 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 SubmitShipmentConfirmationsResponse

type Volume ¶

type Volume struct {
	// The unit of measurement.
	UnitOfMeasure string `json:"unitOfMeasure"`
	Value         string `json:"value"`
}

The volume of the shipment.

type Weight ¶

type Weight struct {
	// The unit of measurement.
	UnitOfMeasure string `json:"unitOfMeasure"`
	Value         string `json:"value"`
}

The weight of the shipment.

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

type Carton ¶

type CartonReferenceDetails ¶

type CollectFreightPickupDetails ¶

type Configuration ¶

func NewConfiguration ¶

func (*Configuration) AddDefaultHeader ¶

type ContainerIdentification ¶

type ContainerItem ¶

type ContainerSequenceNumbers ¶

type Containers ¶

type Dimensions ¶

type Duration ¶

type Expiry ¶

type GenericSwaggerError ¶

func (GenericSwaggerError) Body ¶

func (GenericSwaggerError) Error ¶

func (GenericSwaggerError) Model ¶

type GetShipmentDetailsResponse ¶

type GetShipmentLabels ¶

type ImportDetails ¶

type InnerContainersDetails ¶

type Item ¶

type ItemDetails ¶

type ItemQuantity ¶

type LabelData ¶

type Location ¶

type ModelError ¶

type Money ¶

type PackageItemDetails ¶

type PackedItems ¶

type PackedQuantity ¶

type Pagination ¶

type Pallet ¶

type PartyIdentification ¶

type PurchaseOrderItemDetails ¶

type PurchaseOrderItems ¶

type PurchaseOrders ¶

type Route ¶

type Shipment ¶

type ShipmentConfirmation ¶

type ShipmentDetails ¶

type ShipmentInformation ¶

type ShipmentMeasurements ¶

type ShipmentStatusDetails ¶

type Stop ¶

type SubmitShipmentConfirmationsRequest ¶

type SubmitShipmentConfirmationsResponse ¶

type SubmitShipments ¶

type TaxRegistrationDetails ¶

type TransactionReference ¶

type TransportLabel ¶

type TransportShipmentMeasurements ¶

type TransportationDetails ¶

type TransportationLabels ¶