vdfordersv1

package
v1.0.9 Latest Latest
Warning

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

Go to latest
Published: Oct 28, 2024 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package vdfordersv1 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetOrderRequest

func NewGetOrderRequest(server string, purchaseOrderNumber string) (*http.Request, error)

NewGetOrderRequest generates requests for GetOrder

func NewGetOrdersRequest

func NewGetOrdersRequest(server string, params *GetOrdersParams) (*http.Request, error)

NewGetOrdersRequest generates requests for GetOrders

func NewSubmitAcknowledgementRequest

func NewSubmitAcknowledgementRequest(server string, body SubmitAcknowledgementJSONRequestBody) (*http.Request, error)

NewSubmitAcknowledgementRequest calls the generic SubmitAcknowledgement builder with application/json body

func NewSubmitAcknowledgementRequestWithBody

func NewSubmitAcknowledgementRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSubmitAcknowledgementRequestWithBody generates requests for SubmitAcknowledgement with any type of body

Types

type AcknowledgementStatus

type AcknowledgementStatus struct {
	// Code Acknowledgement code is a unique two digit value which indicates the status of the acknowledgement. For a list of acknowledgement codes that Amazon supports, see the Vendor Direct Fulfillment APIs Use Case Guide.
	Code *string `json:"code,omitempty"`

	// Description Reason for the acknowledgement code.
	Description *string `json:"description,omitempty"`
}

AcknowledgementStatus Status of acknowledgement.

type Address

type Address struct {
	// AddressLine1 First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	AddressLine1 string `json:"addressLine1"`

	// AddressLine2 Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	AddressLine2 *string `json:"addressLine2,omitempty"`

	// AddressLine3 Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	AddressLine3 *string `json:"addressLine3,omitempty"`

	// Attention The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	Attention *string `json:"attention,omitempty"`

	// City The city where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	City *string `json:"city,omitempty"`

	// CountryCode The two digit country code. In ISO 3166-1 alpha-2 format.
	CountryCode string `json:"countryCode"`

	// County The county where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	County *string `json:"county,omitempty"`

	// District The district where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	District *string `json:"district,omitempty"`

	// Name The name of the person, business, or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	Name string `json:"name"`

	// Phone The phone number of the person, business, or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
	Phone *string `json:"phone,omitempty"`

	// PostalCode 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"`

	// StateOrRegion The state or region where person, business or institution is located.
	StateOrRegion string `json:"stateOrRegion"`
}

Address Address of the party.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn

	// A callback for modifying response which are generated after receive from the network.
	ResponseEditors []ResponseEditorFn

	// The user agent header identifies your application, its version number, and the platform and programming language you are using.
	// You must include a user agent header in each request submitted to the sales partner API.
	UserAgent string
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetOrder

func (c *Client) GetOrder(ctx context.Context, purchaseOrderNumber string) (*http.Response, error)

func (*Client) GetOrders

func (c *Client) GetOrders(ctx context.Context, params *GetOrdersParams) (*http.Response, error)

func (*Client) SubmitAcknowledgement

func (c *Client) SubmitAcknowledgement(ctx context.Context, body SubmitAcknowledgementJSONRequestBody) (*http.Response, error)

func (*Client) SubmitAcknowledgementWithBody

func (c *Client) SubmitAcknowledgementWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// SubmitAcknowledgementWithBody request with any body
	SubmitAcknowledgementWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	SubmitAcknowledgement(ctx context.Context, body SubmitAcknowledgementJSONRequestBody) (*http.Response, error)

	// GetOrders request
	GetOrders(ctx context.Context, params *GetOrdersParams) (*http.Response, error)

	// GetOrder request
	GetOrder(ctx context.Context, purchaseOrderNumber string) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithResponseEditorFn

func WithResponseEditorFn(fn ResponseEditorFn) ClientOption

WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetOrderWithResponse

func (c *ClientWithResponses) GetOrderWithResponse(ctx context.Context, purchaseOrderNumber string) (*GetOrderResp, error)

GetOrderWithResponse request returning *GetOrderResp

func (*ClientWithResponses) GetOrdersWithResponse

func (c *ClientWithResponses) GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams) (*GetOrdersResp, error)

GetOrdersWithResponse request returning *GetOrdersResp

func (*ClientWithResponses) SubmitAcknowledgementWithBodyWithResponse

func (c *ClientWithResponses) SubmitAcknowledgementWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*SubmitAcknowledgementResp, error)

SubmitAcknowledgementWithBodyWithResponse request with arbitrary body returning *SubmitAcknowledgementResp

func (*ClientWithResponses) SubmitAcknowledgementWithResponse

func (c *ClientWithResponses) SubmitAcknowledgementWithResponse(ctx context.Context, body SubmitAcknowledgementJSONRequestBody) (*SubmitAcknowledgementResp, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// SubmitAcknowledgementWithBodyWithResponse request with any body
	SubmitAcknowledgementWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*SubmitAcknowledgementResp, error)

	SubmitAcknowledgementWithResponse(ctx context.Context, body SubmitAcknowledgementJSONRequestBody) (*SubmitAcknowledgementResp, error)

	// GetOrdersWithResponse request
	GetOrdersWithResponse(ctx context.Context, params *GetOrdersParams) (*GetOrdersResp, error)

	// GetOrderWithResponse request
	GetOrderWithResponse(ctx context.Context, purchaseOrderNumber string) (*GetOrderResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Decimal

type Decimal = string

Decimal A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.

type Error

type Error struct {
	// Code An error code that identifies the type of error that occurred.
	Code string `json:"code"`

	// Details Additional details that can help the caller understand or fix the issue.
	Details *string `json:"details,omitempty"`

	// Message A message that describes the error condition.
	Message string `json:"message"`
}

Error Error response returned when the request is unsuccessful.

type ErrorList

type ErrorList = []Error

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

type GetOrderResp

type GetOrderResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetOrderResponse
	JSON400      *GetOrderResponse
	JSON401      *GetOrderResponse
	JSON403      *GetOrderResponse
	JSON404      *GetOrderResponse
	JSON415      *GetOrderResponse
	JSON429      *GetOrderResponse
	JSON500      *GetOrderResponse
	JSON503      *GetOrderResponse
}

func ParseGetOrderResp

func ParseGetOrderResp(rsp *http.Response) (*GetOrderResp, error)

ParseGetOrderResp parses an HTTP response from a GetOrderWithResponse call

func (GetOrderResp) Status

func (r GetOrderResp) Status() string

Status returns HTTPResponse.Status

func (GetOrderResp) StatusCode

func (r GetOrderResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrderResponse

type GetOrderResponse struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload Represents a purchase order.
	Payload *Order `json:"payload,omitempty"`
}

GetOrderResponse The response schema for the getOrder operation.

type GetOrdersParams

type GetOrdersParams struct {
	// ShipFromPartyId The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
	ShipFromPartyId *string `form:"shipFromPartyId,omitempty" json:"shipFromPartyId,omitempty"`

	// Status Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
	Status *GetOrdersParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// Limit The limit to the number of purchase orders returned.
	Limit *int64 `form:"limit,omitempty" json:"limit,omitempty"`

	// CreatedAfter Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
	CreatedAfter time.Time `form:"createdAfter" json:"createdAfter"`

	// CreatedBefore Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
	CreatedBefore time.Time `form:"createdBefore" json:"createdBefore"`

	// SortOrder Sort the list in ascending or descending order by order creation date.
	SortOrder *GetOrdersParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`

	// NextToken Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
	NextToken *string `form:"nextToken,omitempty" json:"nextToken,omitempty"`

	// IncludeDetails When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
	IncludeDetails *string `form:"includeDetails,omitempty" json:"includeDetails,omitempty"`
}

GetOrdersParams defines parameters for GetOrders.

type GetOrdersParamsSortOrder

type GetOrdersParamsSortOrder string

GetOrdersParamsSortOrder defines parameters for GetOrders.

const (
	ASC  GetOrdersParamsSortOrder = "ASC"
	DESC GetOrdersParamsSortOrder = "DESC"
)

Defines values for GetOrdersParamsSortOrder.

type GetOrdersParamsStatus

type GetOrdersParamsStatus string

GetOrdersParamsStatus defines parameters for GetOrders.

const (
	GetOrdersParamsStatusACCEPTED  GetOrdersParamsStatus = "ACCEPTED"
	GetOrdersParamsStatusCANCELLED GetOrdersParamsStatus = "CANCELLED"
	GetOrdersParamsStatusNEW       GetOrdersParamsStatus = "NEW"
	GetOrdersParamsStatusSHIPPED   GetOrdersParamsStatus = "SHIPPED"
)

Defines values for GetOrdersParamsStatus.

type GetOrdersResp

type GetOrdersResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetOrdersResponse
	JSON400      *GetOrdersResponse
	JSON403      *GetOrdersResponse
	JSON404      *GetOrdersResponse
	JSON415      *GetOrdersResponse
	JSON429      *GetOrdersResponse
	JSON500      *GetOrdersResponse
	JSON503      *GetOrdersResponse
}

func ParseGetOrdersResp

func ParseGetOrdersResp(rsp *http.Response) (*GetOrdersResp, error)

ParseGetOrdersResp parses an HTTP response from a GetOrdersWithResponse call

func (GetOrdersResp) Status

func (r GetOrdersResp) Status() string

Status returns HTTPResponse.Status

func (GetOrdersResp) StatusCode

func (r GetOrdersResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrdersResponse

type GetOrdersResponse struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload A purchase orders list returned as a response.
	Payload *OrderList `json:"payload,omitempty"`
}

GetOrdersResponse The response schema for the getOrders operation.

type GiftDetails

type GiftDetails struct {
	// GiftMessage Gift message to be printed in shipment.
	GiftMessage *string `json:"giftMessage,omitempty"`

	// GiftWrapId Gift wrap identifier for the gift wrapping, if any.
	GiftWrapId *string `json:"giftWrapId,omitempty"`
}

GiftDetails Gift details for the item.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ItemQuantity

type ItemQuantity struct {
	// Amount Acknowledged quantity. This value should not be zero.
	Amount *int `json:"amount,omitempty"`

	// UnitOfMeasure Unit of measure for the acknowledged quantity.
	UnitOfMeasure *ItemQuantityUnitOfMeasure `json:"unitOfMeasure,omitempty"`
}

ItemQuantity Details of quantity ordered.

type ItemQuantityUnitOfMeasure

type ItemQuantityUnitOfMeasure string

ItemQuantityUnitOfMeasure Unit of measure for the acknowledged quantity.

const (
	Each ItemQuantityUnitOfMeasure = "Each"
)

Defines values for ItemQuantityUnitOfMeasure.

type Money

type Money struct {
	// Amount A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
	Amount *Decimal `json:"amount,omitempty"`

	// CurrencyCode Three digit currency code in ISO 4217 format. String of length 3.
	CurrencyCode *string `json:"currencyCode,omitempty"`
}

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

type Order

type Order struct {
	// OrderDetails Details of an order.
	OrderDetails *OrderDetails `json:"orderDetails,omitempty"`

	// PurchaseOrderNumber The purchase order number for this order. Formatting Notes: alpha-numeric code.
	PurchaseOrderNumber string `json:"purchaseOrderNumber"`
}

Order Represents a purchase order.

type OrderAcknowledgementItem

type OrderAcknowledgementItem struct {
	// AcknowledgementDate The date and time when the order is acknowledged, in ISO-8601 date/time format. For example: 2018-07-16T23:00:00Z / 2018-07-16T23:00:00-05:00 / 2018-07-16T23:00:00-08:00.
	AcknowledgementDate time.Time `json:"acknowledgementDate"`

	// AcknowledgementStatus Status of acknowledgement.
	AcknowledgementStatus AcknowledgementStatus `json:"acknowledgementStatus"`

	// ItemAcknowledgements Item details including acknowledged quantity.
	ItemAcknowledgements []OrderItemAcknowledgement `json:"itemAcknowledgements"`

	// PurchaseOrderNumber The purchase order number for this order. Formatting Notes: alpha-numeric code.
	PurchaseOrderNumber string `json:"purchaseOrderNumber"`

	// SellingParty Name, address, and tax details of a party.
	SellingParty PartyIdentification `json:"sellingParty"`

	// ShipFromParty Name, address, and tax details of a party.
	ShipFromParty PartyIdentification `json:"shipFromParty"`

	// VendorOrderNumber The vendor's order number for this order.
	VendorOrderNumber string `json:"vendorOrderNumber"`
}

OrderAcknowledgementItem Details of an individual order being acknowledged.

type OrderDetails

type OrderDetails struct {
	// BillToParty Name, address, and tax details of a party.
	BillToParty PartyIdentification `json:"billToParty"`

	// CustomerOrderNumber The customer order number.
	CustomerOrderNumber string `json:"customerOrderNumber"`

	// Items A list of items in this purchase order.
	Items []OrderItem `json:"items"`

	// OrderDate The date the order was placed. This field is expected to be in ISO-8601 date/time format, for example:2018-07-16T23:00:00Z/ 2018-07-16T23:00:00-05:00 /2018-07-16T23:00:00-08:00. If no time zone is specified, UTC should be assumed.
	OrderDate time.Time `json:"orderDate"`

	// OrderStatus Current status of the order.
	OrderStatus *OrderDetailsOrderStatus `json:"orderStatus,omitempty"`

	// SellingParty Name, address, and tax details of a party.
	SellingParty PartyIdentification `json:"sellingParty"`

	// ShipFromParty Name, address, and tax details of a party.
	ShipFromParty PartyIdentification `json:"shipFromParty"`

	// ShipToParty Address of the party.
	ShipToParty Address `json:"shipToParty"`

	// ShipmentDetails Shipment details required for the shipment.
	ShipmentDetails ShipmentDetails `json:"shipmentDetails"`

	// TaxTotal The total tax object within the shipment that relates to the order.
	TaxTotal *struct {
		// TaxLineItem A list of tax line items.
		TaxLineItem *TaxLineItem `json:"taxLineItem,omitempty"`
	} `json:"taxTotal,omitempty"`
}

OrderDetails Details of an order.

type OrderDetailsOrderStatus

type OrderDetailsOrderStatus string

OrderDetailsOrderStatus Current status of the order.

const (
	OrderDetailsOrderStatusACCEPTED  OrderDetailsOrderStatus = "ACCEPTED"
	OrderDetailsOrderStatusCANCELLED OrderDetailsOrderStatus = "CANCELLED"
	OrderDetailsOrderStatusNEW       OrderDetailsOrderStatus = "NEW"
	OrderDetailsOrderStatusSHIPPED   OrderDetailsOrderStatus = "SHIPPED"
)

Defines values for OrderDetailsOrderStatus.

type OrderItem

type OrderItem struct {
	// BuyerProductIdentifier Buyer's standard identification number (ASIN) of an item.
	BuyerProductIdentifier *string `json:"buyerProductIdentifier,omitempty"`

	// GiftDetails Gift details for the item.
	GiftDetails *GiftDetails `json:"giftDetails,omitempty"`

	// ItemSequenceNumber Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
	ItemSequenceNumber string `json:"itemSequenceNumber"`

	// NetPrice An amount of money, including units in the form of currency.
	NetPrice Money `json:"netPrice"`

	// OrderedQuantity Details of quantity ordered.
	OrderedQuantity ItemQuantity `json:"orderedQuantity"`

	// ScheduledDeliveryShipment Dates for the scheduled delivery shipments.
	ScheduledDeliveryShipment *ScheduledDeliveryShipment `json:"scheduledDeliveryShipment,omitempty"`

	// TaxDetails Total tax details for the line item.
	TaxDetails *struct {
		// TaxLineItem A list of tax line items.
		TaxLineItem *TaxLineItem `json:"taxLineItem,omitempty"`
	} `json:"taxDetails,omitempty"`

	// Title Title for the item.
	Title *string `json:"title,omitempty"`

	// TotalPrice An amount of money, including units in the form of currency.
	TotalPrice *Money `json:"totalPrice,omitempty"`

	// VendorProductIdentifier The vendor selected product identification of the item.
	VendorProductIdentifier *string `json:"vendorProductIdentifier,omitempty"`
}

OrderItem An order item.

type OrderItemAcknowledgement

type OrderItemAcknowledgement struct {
	// AcknowledgedQuantity Details of quantity ordered.
	AcknowledgedQuantity ItemQuantity `json:"acknowledgedQuantity"`

	// BuyerProductIdentifier Buyer's standard identification number (ASIN) of an item.
	BuyerProductIdentifier *string `json:"buyerProductIdentifier,omitempty"`

	// ItemSequenceNumber Line item sequence number for the item.
	ItemSequenceNumber string `json:"itemSequenceNumber"`

	// VendorProductIdentifier The vendor selected product identification of the item. Should be the same as was provided in the purchase order.
	VendorProductIdentifier *string `json:"vendorProductIdentifier,omitempty"`
}

OrderItemAcknowledgement Individual item details within the acknowledged order.

type OrderList

type OrderList struct {
	// Orders Represents a purchase order within the `OrderList`.
	Orders *[]Order `json:"orders,omitempty"`

	// Pagination The pagination elements required to retrieve the remaining data.
	Pagination *Pagination `json:"pagination,omitempty"`
}

OrderList A purchase orders list returned as a response.

type Pagination

type Pagination struct {
	// NextToken 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"`
}

Pagination The pagination elements required to retrieve the remaining data.

type PartyIdentification

type PartyIdentification struct {
	// Address Address of the party.
	Address *Address `json:"address,omitempty"`

	// PartyId Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
	PartyId string `json:"partyId"`

	// TaxInfo Tax registration details of the entity.
	TaxInfo *TaxRegistrationDetails `json:"taxInfo,omitempty"`
}

PartyIdentification Name, address, and tax details of a party.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseEditorFn

type ResponseEditorFn func(ctx context.Context, rsp *http.Response) error

ResponseEditorFn is the function signature for the ResponseEditor callback function

type ScheduledDeliveryShipment

type ScheduledDeliveryShipment struct {
	// EarliestNominatedDeliveryDate Earliest nominated delivery date for the scheduled delivery.
	EarliestNominatedDeliveryDate *time.Time `json:"earliestNominatedDeliveryDate,omitempty"`

	// LatestNominatedDeliveryDate Latest nominated delivery date for the scheduled delivery.
	LatestNominatedDeliveryDate *time.Time `json:"latestNominatedDeliveryDate,omitempty"`

	// ScheduledDeliveryServiceType Scheduled delivery service type.
	ScheduledDeliveryServiceType *string `json:"scheduledDeliveryServiceType,omitempty"`
}

ScheduledDeliveryShipment Dates for the scheduled delivery shipments.

type ShipmentDates

type ShipmentDates struct {
	// PromisedDeliveryDate Delivery date promised to the Amazon customer.
	PromisedDeliveryDate *time.Time `json:"promisedDeliveryDate,omitempty"`

	// RequiredShipDate Time by which the vendor is required to ship the order.
	RequiredShipDate time.Time `json:"requiredShipDate"`
}

ShipmentDates Shipment dates.

type ShipmentDetails

type ShipmentDetails struct {
	// IsGift When true, the order contain a gift. Include the gift message and gift wrap information.
	IsGift *bool `json:"isGift,omitempty"`

	// IsPriorityShipment When true, this is a priority shipment.
	IsPriorityShipment bool `json:"isPriorityShipment"`

	// IsPslipRequired When true, a packing slip is required to be sent to the customer.
	IsPslipRequired bool `json:"isPslipRequired"`

	// IsScheduledDeliveryShipment When true, this order is part of a scheduled delivery program.
	IsScheduledDeliveryShipment *bool `json:"isScheduledDeliveryShipment,omitempty"`

	// MessageToCustomer Message to customer for order status.
	MessageToCustomer string `json:"messageToCustomer"`

	// ShipMethod Ship method to be used for shipping the order. Amazon defines ship method codes indicating the shipping carrier and shipment service level. To see the full list of ship methods in use, including both the code and the friendly name, search the 'Help' section on Vendor Central for 'ship methods'.
	ShipMethod string `json:"shipMethod"`

	// ShipmentDates Shipment dates.
	ShipmentDates ShipmentDates `json:"shipmentDates"`
}

ShipmentDetails Shipment details required for the shipment.

type SubmitAcknowledgementJSONRequestBody

type SubmitAcknowledgementJSONRequestBody = SubmitAcknowledgementRequest

SubmitAcknowledgementJSONRequestBody defines body for SubmitAcknowledgement for application/json ContentType.

type SubmitAcknowledgementRequest

type SubmitAcknowledgementRequest struct {
	// OrderAcknowledgements A list of one or more purchase orders.
	OrderAcknowledgements *[]OrderAcknowledgementItem `json:"orderAcknowledgements,omitempty"`
}

SubmitAcknowledgementRequest The request schema for the submitAcknowledgement operation.

type SubmitAcknowledgementResp

func ParseSubmitAcknowledgementResp

func ParseSubmitAcknowledgementResp(rsp *http.Response) (*SubmitAcknowledgementResp, error)

ParseSubmitAcknowledgementResp parses an HTTP response from a SubmitAcknowledgementWithResponse call

func (SubmitAcknowledgementResp) Status

func (r SubmitAcknowledgementResp) Status() string

Status returns HTTPResponse.Status

func (SubmitAcknowledgementResp) StatusCode

func (r SubmitAcknowledgementResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitAcknowledgementResponse

type SubmitAcknowledgementResponse struct {
	// Errors A list of error responses returned when a request is unsuccessful.
	Errors *ErrorList `json:"errors,omitempty"`

	// Payload Response that contains the transaction ID.
	Payload *TransactionId `json:"payload,omitempty"`
}

SubmitAcknowledgementResponse The response schema for the submitAcknowledgement operation.

type TaxDetails

type TaxDetails struct {
	// TaxAmount An amount of money, including units in the form of currency.
	TaxAmount Money `json:"taxAmount"`

	// TaxRate A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
	TaxRate *Decimal `json:"taxRate,omitempty"`

	// TaxableAmount An amount of money, including units in the form of currency.
	TaxableAmount *Money `json:"taxableAmount,omitempty"`

	// Type Tax type.
	Type *TaxDetailsType `json:"type,omitempty"`
}

TaxDetails The order's tax details.

type TaxDetailsType

type TaxDetailsType string

TaxDetailsType Tax type.

const (
	TaxDetailsTypeCONSUMPTION TaxDetailsType = "CONSUMPTION"
	TaxDetailsTypeGST         TaxDetailsType = "GST"
	TaxDetailsTypeMwSt        TaxDetailsType = "MwSt."
	TaxDetailsTypePST         TaxDetailsType = "PST"
	TaxDetailsTypeTOTAL       TaxDetailsType = "TOTAL"
	TaxDetailsTypeTVA         TaxDetailsType = "TVA"
	TaxDetailsTypeVAT         TaxDetailsType = "VAT"
)

Defines values for TaxDetailsType.

type TaxLineItem

type TaxLineItem = []TaxDetails

TaxLineItem A list of tax line items.

type TaxRegistrationDetails

type TaxRegistrationDetails struct {
	// TaxRegistrationAddress Address of the party.
	TaxRegistrationAddress *Address `json:"taxRegistrationAddress,omitempty"`

	// TaxRegistrationMessages Tax registration message that can be used for additional tax related details.
	TaxRegistrationMessages *string `json:"taxRegistrationMessages,omitempty"`

	// TaxRegistrationNumber Tax registration number for the party. For example, VAT ID.
	TaxRegistrationNumber string `json:"taxRegistrationNumber"`

	// TaxRegistrationType Tax registration type for the entity.
	TaxRegistrationType *TaxRegistrationDetailsTaxRegistrationType `json:"taxRegistrationType,omitempty"`
}

TaxRegistrationDetails Tax registration details of the entity.

type TaxRegistrationDetailsTaxRegistrationType

type TaxRegistrationDetailsTaxRegistrationType string

TaxRegistrationDetailsTaxRegistrationType Tax registration type for the entity.

const (
	TaxRegistrationDetailsTaxRegistrationTypeGST TaxRegistrationDetailsTaxRegistrationType = "GST"
	TaxRegistrationDetailsTaxRegistrationTypeVAT TaxRegistrationDetailsTaxRegistrationType = "VAT"
)

Defines values for TaxRegistrationDetailsTaxRegistrationType.

type TransactionId

type TransactionId struct {
	// TransactionId 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"`
}

TransactionId Response that contains the transaction ID.

Jump to

Keyboard shortcuts

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