swagger

package
v0.0.0-...-c324a2f Latest Latest
Warning

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

Go to latest
Published: May 6, 2023 License: MIT Imports: 21 Imported by: 0

README

Go API client for swagger

The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders 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.

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 Description
VendorOrdersApi GetPurchaseOrder Get /vendor/orders/v1/purchaseOrders/{purchaseOrderNumber}
VendorOrdersApi GetPurchaseOrders Get /vendor/orders/v1/purchaseOrders
VendorOrdersApi GetPurchaseOrdersStatus Get /vendor/orders/v1/purchaseOrdersStatus
VendorOrdersApi SubmitAcknowledgement Post /vendor/orders/v1/acknowledgements

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Overview

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Selling Partner API for Retail Procurement Orders * * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

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 {
	VendorOrdersApi *VendorOrdersApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Retail Procurement Orders 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 AcknowledgementStatusDetails

type AcknowledgementStatusDetails struct {
	// The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format.
	AcknowledgementDate time.Time     `json:"acknowledgementDate,omitempty"`
	AcceptedQuantity    *ItemQuantity `json:"acceptedQuantity,omitempty"`
	RejectedQuantity    *ItemQuantity `json:"rejectedQuantity,omitempty"`
}

Details of item quantity ordered

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 address information, if required.
	AddressLine2 string `json:"addressLine2,omitempty"`
	// Additional address information, if required.
	AddressLine3 string `json:"addressLine3,omitempty"`
	// The city where the person, business or institution is located.
	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 conatins 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 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 GetPurchaseOrderResponse

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

The response schema for the getPurchaseOrder operation.

type GetPurchaseOrdersResponse

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

The response schema for the getPurchaseOrders operation.

type GetPurchaseOrdersStatusResponse

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

The response schema for the getPurchaseOrdersStatus operation.

type ImportDetails

type ImportDetails struct {
	// If the recipient requests, contains the shipment method of payment. This is for import PO's only.
	MethodOfPayment string `json:"methodOfPayment,omitempty"`
	// Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. This is for import purchase orders only.
	InternationalCommercialTerms string `json:"internationalCommercialTerms,omitempty"`
	// The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB.
	PortOfDelivery string `json:"portOfDelivery,omitempty"`
	// Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40'(40-foot container), 40'HC (40-foot high-capacity container), 45', 45'HC, 30', 30'HC, 20', 20'HC.
	ImportContainers string `json:"importContainers,omitempty"`
	// Special instructions regarding the shipment. This field is for import purchase orders.
	ShippingInstructions string `json:"shippingInstructions,omitempty"`
}

Import details for an import order.

type ItemQuantity

type ItemQuantity struct {
	// Acknowledged quantity. This value should not be zero.
	Amount int32 `json:"amount,omitempty"`
	// Unit of measure for the acknowledged quantity.
	UnitOfMeasure string `json:"unitOfMeasure,omitempty"`
	// The case size, in the event that we ordered using cases.
	UnitSize int32 `json:"unitSize,omitempty"`
}

Details of quantity ordered.

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. String of length 3.
	CurrencyCode string `json:"currencyCode,omitempty"`
	Amount       string `json:"amount,omitempty"`
}

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

type Order

type Order struct {
	// The purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.
	PurchaseOrderNumber string `json:"purchaseOrderNumber"`
	// This field will contain the current state of the purchase order.
	PurchaseOrderState string        `json:"purchaseOrderState"`
	OrderDetails       *OrderDetails `json:"orderDetails,omitempty"`
}

type OrderAcknowledgement

type OrderAcknowledgement struct {
	// The purchase order number. Formatting Notes: 8-character alpha-numeric code.
	PurchaseOrderNumber string               `json:"purchaseOrderNumber"`
	SellingParty        *PartyIdentification `json:"sellingParty"`
	// The date and time when the purchase order is acknowledged, in ISO-8601 date/time format.
	AcknowledgementDate time.Time `json:"acknowledgementDate"`
	// A list of the items being acknowledged with associated details.
	Items []OrderAcknowledgementItem `json:"items"`
}

type OrderAcknowledgementItem

type OrderAcknowledgementItem struct {
	// Line item sequence number for the item.
	ItemSequenceNumber string `json:"itemSequenceNumber,omitempty"`
	// Amazon 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"`
	OrderedQuantity         *ItemQuantity `json:"orderedQuantity"`
	NetCost                 *Money        `json:"netCost,omitempty"`
	ListPrice               *Money        `json:"listPrice,omitempty"`
	// The discount multiplier that should be applied to the price if a vendor sells books with a list price. This is a multiplier factor to arrive at a final discounted price. A multiplier of .90 would be the factor if a 10% discount is given.
	DiscountMultiplier string `json:"discountMultiplier,omitempty"`
	// This is used to indicate acknowledged quantity.
	ItemAcknowledgements []OrderItemAcknowledgement `json:"itemAcknowledgements"`
}

Details of the item being acknowledged.

type OrderDetails

type OrderDetails struct {
	// The date the purchase order was placed. Must be in ISO-8601 date/time format.
	PurchaseOrderDate time.Time `json:"purchaseOrderDate"`
	// The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the  updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format.
	PurchaseOrderChangedDate time.Time `json:"purchaseOrderChangedDate,omitempty"`
	// The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'. Must be in ISO-8601 date/time format.
	PurchaseOrderStateChangedDate time.Time `json:"purchaseOrderStateChangedDate"`
	// Type of purchase order.
	PurchaseOrderType string         `json:"purchaseOrderType,omitempty"`
	ImportDetails     *ImportDetails `json:"importDetails,omitempty"`
	// If requested by the recipient, this field will contain a promotional/deal number. The discount code line is optional. It is used to obtain a price discount on items on the order.
	DealCode string `json:"dealCode,omitempty"`
	// Payment method used.
	PaymentMethod  string               `json:"paymentMethod,omitempty"`
	BuyingParty    *PartyIdentification `json:"buyingParty,omitempty"`
	SellingParty   *PartyIdentification `json:"sellingParty,omitempty"`
	ShipToParty    *PartyIdentification `json:"shipToParty,omitempty"`
	BillToParty    *PartyIdentification `json:"billToParty,omitempty"`
	ShipWindow     string               `json:"shipWindow,omitempty"`
	DeliveryWindow string               `json:"deliveryWindow,omitempty"`
	// A list of items in this purchase order.
	Items []OrderItem `json:"items"`
}

Details of an order.

type OrderItem

type OrderItem struct {
	// Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
	ItemSequenceNumber string `json:"itemSequenceNumber"`
	// Amazon Standard Identification Number (ASIN) of an item.
	AmazonProductIdentifier string `json:"amazonProductIdentifier,omitempty"`
	// The vendor selected product identification of the item.
	VendorProductIdentifier string        `json:"vendorProductIdentifier,omitempty"`
	OrderedQuantity         *ItemQuantity `json:"orderedQuantity"`
	// When true, we will accept backorder confirmations for this item.
	IsBackOrderAllowed bool   `json:"isBackOrderAllowed"`
	NetCost            *Money `json:"netCost,omitempty"`
	ListPrice          *Money `json:"listPrice,omitempty"`
}

type OrderItemAcknowledgement

type OrderItemAcknowledgement struct {
	// This indicates the acknowledgement code.
	AcknowledgementCode  string        `json:"acknowledgementCode"`
	AcknowledgedQuantity *ItemQuantity `json:"acknowledgedQuantity"`
	// Estimated ship date per line item. Must be in ISO-8601 date/time format.
	ScheduledShipDate time.Time `json:"scheduledShipDate,omitempty"`
	// Estimated delivery date per line item. Must be in ISO-8601 date/time format.
	ScheduledDeliveryDate time.Time `json:"scheduledDeliveryDate,omitempty"`
	// Indicates the reason for rejection.
	RejectionReason string `json:"rejectionReason,omitempty"`
}

type OrderItemStatus

type OrderItemStatus struct {
	// Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
	ItemSequenceNumber string `json:"itemSequenceNumber"`
	// Buyer's Standard Identification Number (ASIN) of an item.
	BuyerProductIdentifier string `json:"buyerProductIdentifier,omitempty"`
	// The vendor selected product identification of the item.
	VendorProductIdentifier string                                `json:"vendorProductIdentifier,omitempty"`
	NetCost                 *Money                                `json:"netCost,omitempty"`
	ListPrice               *Money                                `json:"listPrice,omitempty"`
	OrderedQuantity         *OrderItemStatusOrderedQuantity       `json:"orderedQuantity,omitempty"`
	AcknowledgementStatus   *OrderItemStatusAcknowledgementStatus `json:"acknowledgementStatus,omitempty"`
	ReceivingStatus         *OrderItemStatusReceivingStatus       `json:"receivingStatus,omitempty"`
}

type OrderItemStatusAcknowledgementStatus

type OrderItemStatusAcknowledgementStatus struct {
	// Confirmation status of line item.
	ConfirmationStatus string        `json:"confirmationStatus,omitempty"`
	AcceptedQuantity   *ItemQuantity `json:"acceptedQuantity,omitempty"`
	RejectedQuantity   *ItemQuantity `json:"rejectedQuantity,omitempty"`
	// Details of item quantity confirmed.
	AcknowledgementStatusDetails []AcknowledgementStatusDetails `json:"acknowledgementStatusDetails,omitempty"`
}

Acknowledgement status information.

type OrderItemStatusOrderedQuantity

type OrderItemStatusOrderedQuantity struct {
	OrderedQuantity *ItemQuantity `json:"orderedQuantity,omitempty"`
	// Details of item quantity ordered.
	OrderedQuantityDetails []OrderedQuantityDetails `json:"orderedQuantityDetails,omitempty"`
}

Ordered quantity information.

type OrderItemStatusReceivingStatus

type OrderItemStatusReceivingStatus struct {
	// Receive status of the line item.
	ReceiveStatus    string        `json:"receiveStatus,omitempty"`
	ReceivedQuantity *ItemQuantity `json:"receivedQuantity,omitempty"`
	// The date when the most recent item was received at the buyer's warehouse. Must be in ISO-8601 date/time format.
	LastReceiveDate time.Time `json:"lastReceiveDate,omitempty"`
}

Item receive status at the buyer's warehouse.

type OrderList

type OrderList struct {
	Pagination *Pagination `json:"pagination,omitempty"`
	Orders     []Order     `json:"orders,omitempty"`
}

type OrderListStatus

type OrderListStatus struct {
	Pagination   *Pagination   `json:"pagination,omitempty"`
	OrdersStatus []OrderStatus `json:"ordersStatus,omitempty"`
}

type OrderStatus

type OrderStatus struct {
	// The buyer's purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.
	PurchaseOrderNumber string `json:"purchaseOrderNumber"`
	// The status of the buyer's purchase order for this order.
	PurchaseOrderStatus string `json:"purchaseOrderStatus"`
	// The date the purchase order was placed. Must be in ISO-8601 date/time format.
	PurchaseOrderDate time.Time `json:"purchaseOrderDate"`
	// The date when the purchase order was last updated. Must be in ISO-8601 date/time format.
	LastUpdatedDate time.Time            `json:"lastUpdatedDate,omitempty"`
	SellingParty    *PartyIdentification `json:"sellingParty"`
	ShipToParty     *PartyIdentification `json:"shipToParty"`
	ItemStatus      *[]OrderItemStatus   `json:"itemStatus"`
}

Current status of a purchase order.

type OrderedQuantityDetails

type OrderedQuantityDetails struct {
	// The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format.
	UpdatedDate       time.Time     `json:"updatedDate,omitempty"`
	OrderedQuantity   *ItemQuantity `json:"orderedQuantity,omitempty"`
	CancelledQuantity *ItemQuantity `json:"cancelledQuantity,omitempty"`
}

Details of item quantity ordered

type Pagination

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 purchase order items to return.
	NextToken string `json:"nextToken,omitempty"`
}

type PartyIdentification

type PartyIdentification struct {
	// Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
	PartyId string                  `json:"partyId"`
	Address *Address                `json:"address,omitempty"`
	TaxInfo *TaxRegistrationDetails `json:"taxInfo,omitempty"`
}

type SubmitAcknowledgementRequest

type SubmitAcknowledgementRequest struct {
	Acknowledgements []OrderAcknowledgement `json:"acknowledgements,omitempty"`
}

The request schema for the submitAcknowledgment operation.

type SubmitAcknowledgementResponse

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

The response schema for the submitAcknowledgement 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 TransactionId

type TransactionId struct {
	// GUID assigned by Amazon 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 VendorOrdersApiGetPurchaseOrdersOpts

type VendorOrdersApiGetPurchaseOrdersOpts struct {
	Limit              optional.Int64
	CreatedAfter       optional.Time
	CreatedBefore      optional.Time
	SortOrder          optional.String
	NextToken          optional.String
	IncludeDetails     optional.String
	ChangedAfter       optional.Time
	ChangedBefore      optional.Time
	PoItemState        optional.String
	IsPOChanged        optional.String
	PurchaseOrderState optional.String
	OrderingVendorCode optional.String
}

type VendorOrdersApiGetPurchaseOrdersStatusOpts

type VendorOrdersApiGetPurchaseOrdersStatusOpts struct {
	Limit                  optional.Int64
	SortOrder              optional.String
	NextToken              optional.String
	CreatedAfter           optional.Time
	CreatedBefore          optional.Time
	UpdatedAfter           optional.Time
	UpdatedBefore          optional.Time
	PurchaseOrderNumber    optional.String
	PurchaseOrderStatus    optional.String
	ItemConfirmationStatus optional.String
	ItemReceiveStatus      optional.String
	OrderingVendorCode     optional.String
	ShipToPartyId          optional.String
}

type VendorOrdersApiService

type VendorOrdersApiService service

func (*VendorOrdersApiService) GetPurchaseOrder

func (a *VendorOrdersApiService) GetPurchaseOrder(ctx context.Context, purchaseOrderNumber string) (GetPurchaseOrderResponse, *http.Response, error)

VendorOrdersApiService Returns a purchase order based on the purchaseOrderNumber value 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 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 purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.

@return GetPurchaseOrderResponse

func (*VendorOrdersApiService) GetPurchaseOrders

func (*VendorOrdersApiService) GetPurchaseOrdersStatus

func (*VendorOrdersApiService) SubmitAcknowledgement

VendorOrdersApiService Submits acknowledgements for one or more purchase 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 SubmitAcknowledgementResponse

Jump to

Keyboard shortcuts

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