vdfshippingv1

package
v1.1.0 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 vdfshippingv1 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 NewGetCustomerInvoiceRequest 

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

NewGetCustomerInvoiceRequest generates requests for GetCustomerInvoice

func NewGetCustomerInvoicesRequest 

func NewGetCustomerInvoicesRequest(server string, params *GetCustomerInvoicesParams) (*http.Request, error)

NewGetCustomerInvoicesRequest generates requests for GetCustomerInvoices

func NewGetPackingSlipRequest 

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

NewGetPackingSlipRequest generates requests for GetPackingSlip

func NewGetPackingSlipsRequest 

func NewGetPackingSlipsRequest(server string, params *GetPackingSlipsParams) (*http.Request, error)

NewGetPackingSlipsRequest generates requests for GetPackingSlips

func NewGetShippingLabelRequest 

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

NewGetShippingLabelRequest generates requests for GetShippingLabel

func NewGetShippingLabelsRequest 

func NewGetShippingLabelsRequest(server string, params *GetShippingLabelsParams) (*http.Request, error)

NewGetShippingLabelsRequest generates requests for GetShippingLabels

func NewSubmitShipmentConfirmationsRequest 

func NewSubmitShipmentConfirmationsRequest(server string, body SubmitShipmentConfirmationsJSONRequestBody) (*http.Request, error)

NewSubmitShipmentConfirmationsRequest calls the generic SubmitShipmentConfirmations builder with application/json body

func NewSubmitShipmentConfirmationsRequestWithBody 

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

NewSubmitShipmentConfirmationsRequestWithBody generates requests for SubmitShipmentConfirmations with any type of body

func NewSubmitShipmentStatusUpdatesRequest 

func NewSubmitShipmentStatusUpdatesRequest(server string, body SubmitShipmentStatusUpdatesJSONRequestBody) (*http.Request, error)

NewSubmitShipmentStatusUpdatesRequest calls the generic SubmitShipmentStatusUpdates builder with application/json body

func NewSubmitShipmentStatusUpdatesRequestWithBody 

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

NewSubmitShipmentStatusUpdatesRequestWithBody generates requests for SubmitShipmentStatusUpdates with any type of body

func NewSubmitShippingLabelRequestRequest 

func NewSubmitShippingLabelRequestRequest(server string, body SubmitShippingLabelRequestJSONRequestBody) (*http.Request, error)

NewSubmitShippingLabelRequestRequest calls the generic SubmitShippingLabelRequest builder with application/json body

func NewSubmitShippingLabelRequestRequestWithBody 

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

NewSubmitShippingLabelRequestRequestWithBody generates requests for SubmitShippingLabelRequest with any type of body

Types

type Address 

type Address struct {
	// AddressLine1 First line of the address.
	AddressLine1 string `json:"addressLine1"`

	// AddressLine2 Additional street address information, if required.
	AddressLine2 *string `json:"addressLine2,omitempty"`

	// AddressLine3 Additional street address information, if required.
	AddressLine3 *string `json:"addressLine3,omitempty"`

	// City The city where the person, business or institution is located.
	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 person, business or institution is located.
	County *string `json:"county,omitempty"`

	// District The district where person, business or institution is located.
	District *string `json:"district,omitempty"`

	// Name The name of the person, business or institution at that address.
	Name string `json:"name"`

	// Phone The phone number of the person, business or institution located at that address.
	Phone *string `json:"phone,omitempty"`

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

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

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) GetCustomerInvoice 

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

func (*Client) GetCustomerInvoices 

func (c *Client) GetCustomerInvoices(ctx context.Context, params *GetCustomerInvoicesParams) (*http.Response, error)

func (*Client) GetPackingSlip 

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

func (*Client) GetPackingSlips 

func (c *Client) GetPackingSlips(ctx context.Context, params *GetPackingSlipsParams) (*http.Response, error)

func (*Client) GetShippingLabel 

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

func (*Client) GetShippingLabels 

func (c *Client) GetShippingLabels(ctx context.Context, params *GetShippingLabelsParams) (*http.Response, error)

func (*Client) SubmitShipmentConfirmations 

func (c *Client) SubmitShipmentConfirmations(ctx context.Context, body SubmitShipmentConfirmationsJSONRequestBody) (*http.Response, error)

func (*Client) SubmitShipmentConfirmationsWithBody 

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

func (*Client) SubmitShipmentStatusUpdates 

func (c *Client) SubmitShipmentStatusUpdates(ctx context.Context, body SubmitShipmentStatusUpdatesJSONRequestBody) (*http.Response, error)

func (*Client) SubmitShipmentStatusUpdatesWithBody 

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

func (*Client) SubmitShippingLabelRequest 

func (c *Client) SubmitShippingLabelRequest(ctx context.Context, body SubmitShippingLabelRequestJSONRequestBody) (*http.Response, error)

func (*Client) SubmitShippingLabelRequestWithBody 

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

type ClientInterface 

type ClientInterface interface {
	// GetCustomerInvoices request
	GetCustomerInvoices(ctx context.Context, params *GetCustomerInvoicesParams) (*http.Response, error)

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

	// GetPackingSlips request
	GetPackingSlips(ctx context.Context, params *GetPackingSlipsParams) (*http.Response, error)

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

	// SubmitShipmentConfirmationsWithBody request with any body
	SubmitShipmentConfirmationsWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	SubmitShipmentConfirmations(ctx context.Context, body SubmitShipmentConfirmationsJSONRequestBody) (*http.Response, error)

	// SubmitShipmentStatusUpdatesWithBody request with any body
	SubmitShipmentStatusUpdatesWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	SubmitShipmentStatusUpdates(ctx context.Context, body SubmitShipmentStatusUpdatesJSONRequestBody) (*http.Response, error)

	// GetShippingLabels request
	GetShippingLabels(ctx context.Context, params *GetShippingLabelsParams) (*http.Response, error)

	// SubmitShippingLabelRequestWithBody request with any body
	SubmitShippingLabelRequestWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	SubmitShippingLabelRequest(ctx context.Context, body SubmitShippingLabelRequestJSONRequestBody) (*http.Response, error)

	// GetShippingLabel request
	GetShippingLabel(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) GetCustomerInvoiceWithResponse 

func (c *ClientWithResponses) GetCustomerInvoiceWithResponse(ctx context.Context, purchaseOrderNumber string) (*GetCustomerInvoiceResp, error)

GetCustomerInvoiceWithResponse request returning *GetCustomerInvoiceResp

func (*ClientWithResponses) GetCustomerInvoicesWithResponse 

func (c *ClientWithResponses) GetCustomerInvoicesWithResponse(ctx context.Context, params *GetCustomerInvoicesParams) (*GetCustomerInvoicesResp, error)

GetCustomerInvoicesWithResponse request returning *GetCustomerInvoicesResp

func (*ClientWithResponses) GetPackingSlipWithResponse 

func (c *ClientWithResponses) GetPackingSlipWithResponse(ctx context.Context, purchaseOrderNumber string) (*GetPackingSlipResp, error)

GetPackingSlipWithResponse request returning *GetPackingSlipResp

func (*ClientWithResponses) GetPackingSlipsWithResponse 

func (c *ClientWithResponses) GetPackingSlipsWithResponse(ctx context.Context, params *GetPackingSlipsParams) (*GetPackingSlipsResp, error)

GetPackingSlipsWithResponse request returning *GetPackingSlipsResp

func (*ClientWithResponses) GetShippingLabelWithResponse 

func (c *ClientWithResponses) GetShippingLabelWithResponse(ctx context.Context, purchaseOrderNumber string) (*GetShippingLabelResp, error)

GetShippingLabelWithResponse request returning *GetShippingLabelResp

func (*ClientWithResponses) GetShippingLabelsWithResponse 

func (c *ClientWithResponses) GetShippingLabelsWithResponse(ctx context.Context, params *GetShippingLabelsParams) (*GetShippingLabelsResp, error)

GetShippingLabelsWithResponse request returning *GetShippingLabelsResp

func (*ClientWithResponses) SubmitShipmentConfirmationsWithBodyWithResponse 

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

SubmitShipmentConfirmationsWithBodyWithResponse request with arbitrary body returning *SubmitShipmentConfirmationsResp

func (*ClientWithResponses) SubmitShipmentConfirmationsWithResponse 

func (c *ClientWithResponses) SubmitShipmentConfirmationsWithResponse(ctx context.Context, body SubmitShipmentConfirmationsJSONRequestBody) (*SubmitShipmentConfirmationsResp, error)

func (*ClientWithResponses) SubmitShipmentStatusUpdatesWithBodyWithResponse 

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

SubmitShipmentStatusUpdatesWithBodyWithResponse request with arbitrary body returning *SubmitShipmentStatusUpdatesResp

func (*ClientWithResponses) SubmitShipmentStatusUpdatesWithResponse 

func (c *ClientWithResponses) SubmitShipmentStatusUpdatesWithResponse(ctx context.Context, body SubmitShipmentStatusUpdatesJSONRequestBody) (*SubmitShipmentStatusUpdatesResp, error)

func (*ClientWithResponses) SubmitShippingLabelRequestWithBodyWithResponse 

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

SubmitShippingLabelRequestWithBodyWithResponse request with arbitrary body returning *SubmitShippingLabelRequestResp

func (*ClientWithResponses) SubmitShippingLabelRequestWithResponse 

func (c *ClientWithResponses) SubmitShippingLabelRequestWithResponse(ctx context.Context, body SubmitShippingLabelRequestJSONRequestBody) (*SubmitShippingLabelRequestResp, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetCustomerInvoicesWithResponse request
	GetCustomerInvoicesWithResponse(ctx context.Context, params *GetCustomerInvoicesParams) (*GetCustomerInvoicesResp, error)

	// GetCustomerInvoiceWithResponse request
	GetCustomerInvoiceWithResponse(ctx context.Context, purchaseOrderNumber string) (*GetCustomerInvoiceResp, error)

	// GetPackingSlipsWithResponse request
	GetPackingSlipsWithResponse(ctx context.Context, params *GetPackingSlipsParams) (*GetPackingSlipsResp, error)

	// GetPackingSlipWithResponse request
	GetPackingSlipWithResponse(ctx context.Context, purchaseOrderNumber string) (*GetPackingSlipResp, error)

	// SubmitShipmentConfirmationsWithBodyWithResponse request with any body
	SubmitShipmentConfirmationsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*SubmitShipmentConfirmationsResp, error)

	SubmitShipmentConfirmationsWithResponse(ctx context.Context, body SubmitShipmentConfirmationsJSONRequestBody) (*SubmitShipmentConfirmationsResp, error)

	// SubmitShipmentStatusUpdatesWithBodyWithResponse request with any body
	SubmitShipmentStatusUpdatesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*SubmitShipmentStatusUpdatesResp, error)

	SubmitShipmentStatusUpdatesWithResponse(ctx context.Context, body SubmitShipmentStatusUpdatesJSONRequestBody) (*SubmitShipmentStatusUpdatesResp, error)

	// GetShippingLabelsWithResponse request
	GetShippingLabelsWithResponse(ctx context.Context, params *GetShippingLabelsParams) (*GetShippingLabelsResp, error)

	// SubmitShippingLabelRequestWithBodyWithResponse request with any body
	SubmitShippingLabelRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*SubmitShippingLabelRequestResp, error)

	SubmitShippingLabelRequestWithResponse(ctx context.Context, body SubmitShippingLabelRequestJSONRequestBody) (*SubmitShippingLabelRequestResp, error)

	// GetShippingLabelWithResponse request
	GetShippingLabelWithResponse(ctx context.Context, purchaseOrderNumber string) (*GetShippingLabelResp, error)
}

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

type Container 

type Container struct {
	// Carrier Carrier required for EU VOC vendors only.
	Carrier *string `json:"carrier,omitempty"`

	// ContainerIdentifier The container identifier.
	ContainerIdentifier string `json:"containerIdentifier"`

	// ContainerSequenceNumber An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.
	ContainerSequenceNumber *int `json:"containerSequenceNumber,omitempty"`

	// ContainerType The type of container.
	ContainerType ContainerContainerType `json:"containerType"`

	// Dimensions Physical dimensional measurements of a container.
	Dimensions *Dimensions `json:"dimensions,omitempty"`

	// ManifestDate The date of the manifest.
	ManifestDate *string `json:"manifestDate,omitempty"`

	// ManifestId The manifest identifier.
	ManifestId *string `json:"manifestId,omitempty"`

	// PackedItems A list of packed items.
	PackedItems []PackedItem `json:"packedItems"`

	// ScacCode SCAC code required for NA VOC vendors only.
	ScacCode *string `json:"scacCode,omitempty"`

	// ShipMethod The shipment method.
	ShipMethod *string `json:"shipMethod,omitempty"`

	// TrackingNumber The tracking number.
	TrackingNumber *string `json:"trackingNumber,omitempty"`

	// Weight The weight.
	Weight Weight `json:"weight"`
}

Container A container used for shipping and packing items.

type ContainerContainerType 

type ContainerContainerType string

ContainerContainerType The type of container. 

const (
	Carton ContainerContainerType = "carton"
	Pallet ContainerContainerType = "pallet"
)

Defines values for ContainerContainerType.

type CustomerInvoice 

type CustomerInvoice struct {
	// Content The `Base64encoded` customer invoice.
	Content string `json:"content"`

	// PurchaseOrderNumber The purchase order number for this order.
	PurchaseOrderNumber string `json:"purchaseOrderNumber"`
}

CustomerInvoice Represents a customer invoice associated with a purchase order.

type CustomerInvoiceList 

type CustomerInvoiceList struct {
	// CustomerInvoices Represents a customer invoice within the `CustomerInvoiceList`.
	CustomerInvoices *[]CustomerInvoice `json:"customerInvoices,omitempty"`

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

CustomerInvoiceList Represents a list of customer invoices, potentially paginated.

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. <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.

type Dimensions 

type Dimensions struct {
	// Height A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.  <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
	Height Decimal `json:"height"`

	// Length A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.  <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
	Length Decimal `json:"length"`

	// UnitOfMeasure The unit of measure for dimensions.
	UnitOfMeasure DimensionsUnitOfMeasure `json:"unitOfMeasure"`

	// Width A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.  <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
	Width Decimal `json:"width"`
}

Dimensions Physical dimensional measurements of a container.

type DimensionsUnitOfMeasure 

type DimensionsUnitOfMeasure string

DimensionsUnitOfMeasure The unit of measure for dimensions. 

const (
	CM DimensionsUnitOfMeasure = "CM"
	IN DimensionsUnitOfMeasure = "IN"
)

Defines values for DimensionsUnitOfMeasure.

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 GetCustomerInvoiceResp 

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

func ParseGetCustomerInvoiceResp 

func ParseGetCustomerInvoiceResp(rsp *http.Response) (*GetCustomerInvoiceResp, error)

ParseGetCustomerInvoiceResp parses an HTTP response from a GetCustomerInvoiceWithResponse call

func (GetCustomerInvoiceResp) Status 

func (r GetCustomerInvoiceResp) Status() string

Status returns HTTPResponse.Status

func (GetCustomerInvoiceResp) StatusCode 

func (r GetCustomerInvoiceResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCustomerInvoiceResponse 

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

	// Payload Represents a customer invoice associated with a purchase order.
	Payload *CustomerInvoice `json:"payload,omitempty"`
}

GetCustomerInvoiceResponse The response schema for the `getCustomerInvoice` operation.

type GetCustomerInvoicesParams 

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

	// Limit The limit to the number of records returned
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// CreatedAfter Orders that became available after this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.
	CreatedAfter time.Time `form:"createdAfter" json:"createdAfter"`

	// CreatedBefore Orders that became available before this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.
	CreatedBefore time.Time `form:"createdBefore" json:"createdBefore"`

	// SortOrder Sort ASC or DESC by order creation date.
	SortOrder *GetCustomerInvoicesParamsSortOrder `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"`
}

GetCustomerInvoicesParams defines parameters for GetCustomerInvoices.

type GetCustomerInvoicesParamsSortOrder 

type GetCustomerInvoicesParamsSortOrder string

GetCustomerInvoicesParamsSortOrder defines parameters for GetCustomerInvoices. 

const (
	GetCustomerInvoicesParamsSortOrderASC  GetCustomerInvoicesParamsSortOrder = "ASC"
	GetCustomerInvoicesParamsSortOrderDESC GetCustomerInvoicesParamsSortOrder = "DESC"
)

Defines values for GetCustomerInvoicesParamsSortOrder.

type GetCustomerInvoicesResp 

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

func ParseGetCustomerInvoicesResp 

func ParseGetCustomerInvoicesResp(rsp *http.Response) (*GetCustomerInvoicesResp, error)

ParseGetCustomerInvoicesResp parses an HTTP response from a GetCustomerInvoicesWithResponse call

func (GetCustomerInvoicesResp) Status 

func (r GetCustomerInvoicesResp) Status() string

Status returns HTTPResponse.Status

func (GetCustomerInvoicesResp) StatusCode 

func (r GetCustomerInvoicesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCustomerInvoicesResponse 

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

	// Payload Represents a list of customer invoices, potentially paginated.
	Payload *CustomerInvoiceList `json:"payload,omitempty"`
}

GetCustomerInvoicesResponse The response schema for the `getCustomerInvoices` operation.

type GetPackingSlipListResponse 

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

	// Payload A list of packing slips.
	Payload *PackingSlipList `json:"payload,omitempty"`
}

GetPackingSlipListResponse Response payload with the list of packing slips.

type GetPackingSlipResp 

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

func ParseGetPackingSlipResp 

func ParseGetPackingSlipResp(rsp *http.Response) (*GetPackingSlipResp, error)

ParseGetPackingSlipResp parses an HTTP response from a GetPackingSlipWithResponse call

func (GetPackingSlipResp) Status 

func (r GetPackingSlipResp) Status() string

Status returns HTTPResponse.Status

func (GetPackingSlipResp) StatusCode 

func (r GetPackingSlipResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPackingSlipResponse 

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

	// Payload Packing slip information.
	Payload *PackingSlip `json:"payload,omitempty"`
}

GetPackingSlipResponse Response payload with packing slip.

type GetPackingSlipsParams 

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

	// Limit The limit to the number of records returned
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// CreatedAfter Packing slips that became available after this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.
	CreatedAfter time.Time `form:"createdAfter" json:"createdAfter"`

	// CreatedBefore Packing slips that became available before this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.
	CreatedBefore time.Time `form:"createdBefore" json:"createdBefore"`

	// SortOrder Sort ASC or DESC by packing slip creation date.
	SortOrder *GetPackingSlipsParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`

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

GetPackingSlipsParams defines parameters for GetPackingSlips.

type GetPackingSlipsParamsSortOrder 

type GetPackingSlipsParamsSortOrder string

GetPackingSlipsParamsSortOrder defines parameters for GetPackingSlips. 

const (
	GetPackingSlipsParamsSortOrderASC  GetPackingSlipsParamsSortOrder = "ASC"
	GetPackingSlipsParamsSortOrderDESC GetPackingSlipsParamsSortOrder = "DESC"
)

Defines values for GetPackingSlipsParamsSortOrder.

type GetPackingSlipsResp 

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

func ParseGetPackingSlipsResp 

func ParseGetPackingSlipsResp(rsp *http.Response) (*GetPackingSlipsResp, error)

ParseGetPackingSlipsResp parses an HTTP response from a GetPackingSlipsWithResponse call

func (GetPackingSlipsResp) Status 

func (r GetPackingSlipsResp) Status() string

Status returns HTTPResponse.Status

func (GetPackingSlipsResp) StatusCode 

func (r GetPackingSlipsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetShippingLabelListResponse 

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

	// Payload Response payload with the list of shipping labels
	Payload *ShippingLabelList `json:"payload,omitempty"`
}

GetShippingLabelListResponse The response schema for the `getShippingLabels` operation.

type GetShippingLabelResp 

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

func ParseGetShippingLabelResp 

func ParseGetShippingLabelResp(rsp *http.Response) (*GetShippingLabelResp, error)

ParseGetShippingLabelResp parses an HTTP response from a GetShippingLabelWithResponse call

func (GetShippingLabelResp) Status 

func (r GetShippingLabelResp) Status() string

Status returns HTTPResponse.Status

func (GetShippingLabelResp) StatusCode 

func (r GetShippingLabelResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetShippingLabelResponse 

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

	// Payload Shipping label information for an order, including the purchase order number, selling party, ship from party, label format, and package details.
	Payload *ShippingLabel `json:"payload,omitempty"`
}

GetShippingLabelResponse The response schema for the `getShippingLabel` operation.

type GetShippingLabelsParams 

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

	// Limit The limit to the number of records returned.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// CreatedAfter Shipping labels that became available after this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.
	CreatedAfter time.Time `form:"createdAfter" json:"createdAfter"`

	// CreatedBefore Shipping labels that became available before this date and time will be included in the result. Must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format.
	CreatedBefore time.Time `form:"createdBefore" json:"createdBefore"`

	// SortOrder Sort ASC or DESC by order creation date.
	SortOrder *GetShippingLabelsParamsSortOrder `form:"sortOrder,omitempty" json:"sortOrder,omitempty"`

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

GetShippingLabelsParams defines parameters for GetShippingLabels.

type GetShippingLabelsParamsSortOrder 

type GetShippingLabelsParamsSortOrder string

GetShippingLabelsParamsSortOrder defines parameters for GetShippingLabels. 

const (
	ASC  GetShippingLabelsParamsSortOrder = "ASC"
	DESC GetShippingLabelsParamsSortOrder = "DESC"
)

Defines values for GetShippingLabelsParamsSortOrder.

type GetShippingLabelsResp 

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

func ParseGetShippingLabelsResp 

func ParseGetShippingLabelsResp(rsp *http.Response) (*GetShippingLabelsResp, error)

ParseGetShippingLabelsResp parses an HTTP response from a GetShippingLabelsWithResponse call

func (GetShippingLabelsResp) Status 

func (r GetShippingLabelsResp) Status() string

Status returns HTTPResponse.Status

func (GetShippingLabelsResp) StatusCode 

func (r GetShippingLabelsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Item 

type Item struct {
	// BuyerProductIdentifier Buyer's Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required.
	BuyerProductIdentifier *string `json:"buyerProductIdentifier,omitempty"`

	// ItemSequenceNumber Item Sequence Number for the item. This must be the same value as sent in order for a given item.
	ItemSequenceNumber int `json:"itemSequenceNumber"`

	// ShippedQuantity Details of item quantity.
	ShippedQuantity ItemQuantity `json:"shippedQuantity"`

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

Item Details of the item being shipped.

type ItemQuantity 

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

	// UnitOfMeasure Unit of measure for the shipped quantity.
	UnitOfMeasure string `json:"unitOfMeasure"`
}

ItemQuantity Details of item quantity.

type LabelData 

type LabelData struct {
	// Content This field will contain the Base64encoded string of the shipment label content.
	Content string `json:"content"`

	// PackageIdentifier Identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level.
	PackageIdentifier *string `json:"packageIdentifier,omitempty"`

	// ShipMethod Ship method to be used for shipping the order. Amazon defines ship method codes indicating shipping carrier and shipment service level. Ship method codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the ship method codes are vendor specific and will be provided to each vendor during the implementation.
	ShipMethod *string `json:"shipMethod,omitempty"`

	// ShipMethodName Shipping method name for internal reference.
	ShipMethodName *string `json:"shipMethodName,omitempty"`

	// TrackingNumber Package tracking identifier from the shipping carrier.
	TrackingNumber *string `json:"trackingNumber,omitempty"`
}

LabelData Details of the shipment label.

type PackedItem 

type PackedItem struct {
	// BuyerProductIdentifier Buyer's Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required.
	BuyerProductIdentifier *string `json:"buyerProductIdentifier,omitempty"`

	// ItemSequenceNumber Item Sequence Number for the item. This must be the same value as sent in the order for a given item.
	ItemSequenceNumber int `json:"itemSequenceNumber"`

	// PackedQuantity Details of item quantity.
	PackedQuantity ItemQuantity `json:"packedQuantity"`

	// VendorProductIdentifier The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number.
	VendorProductIdentifier *string `json:"vendorProductIdentifier,omitempty"`
}

PackedItem Represents an item that has been packed into a container for shipping.

type PackingSlip 

type PackingSlip struct {
	// Content A Base64encoded string of the packing slip PDF.
	Content string `json:"content"`

	// ContentType The format of the file such as PDF, JPEG etc.
	ContentType *PackingSlipContentType `json:"contentType,omitempty"`

	// PurchaseOrderNumber Purchase order number of the shipment that corresponds to the packing slip.
	PurchaseOrderNumber string `json:"purchaseOrderNumber"`
}

PackingSlip Packing slip information.

type PackingSlipContentType 

type PackingSlipContentType string

PackingSlipContentType The format of the file such as PDF, JPEG etc. 

const (
	Applicationpdf PackingSlipContentType = "application/pdf"
)

Defines values for PackingSlipContentType.

type PackingSlipList 

type PackingSlipList struct {
	// PackingSlips An array of packing slip objects.
	PackingSlips *[]PackingSlip `json:"packingSlips,omitempty"`

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

PackingSlipList A list of packing slips.

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.
	PartyId string `json:"partyId"`

	// TaxRegistrationDetails Tax registration details of the entity.
	TaxRegistrationDetails *[]TaxRegistrationDetails `json:"taxRegistrationDetails,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 ShipmentConfirmation 

type ShipmentConfirmation struct {
	// Containers Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.
	Containers *[]Container `json:"containers,omitempty"`

	// Items Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.
	Items []Item `json:"items"`

	// PurchaseOrderNumber Purchase order number corresponding to the shipment.
	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"`

	// ShipmentDetails Details about a shipment.
	ShipmentDetails ShipmentDetails `json:"shipmentDetails"`
}

ShipmentConfirmation Represents the confirmation details of a shipment, including the purchase order number and other shipment details.

type ShipmentDetails 

type ShipmentDetails struct {
	// EstimatedDeliveryDate Date on which the shipment is expected to reach the buyer's warehouse. It needs to be an estimate based on the average transit time between the ship-from location and the destination. The exact appointment time will be provided by buyer and is potentially not known when creating the shipment confirmation.
	EstimatedDeliveryDate *time.Time `json:"estimatedDeliveryDate,omitempty"`

	// IsPriorityShipment Provide the priority of the shipment.
	IsPriorityShipment *bool `json:"isPriorityShipment,omitempty"`

	// ShipmentStatus Indicate the shipment status.
	ShipmentStatus ShipmentDetailsShipmentStatus `json:"shipmentStatus"`

	// ShippedDate This field indicates the date of the departure of the shipment from vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Amazon destination warehouse, whichever is sooner. Shipped date mentioned in the Shipment Confirmation should not be in the future.
	ShippedDate time.Time `json:"shippedDate"`

	// VendorOrderNumber The vendor order number is a unique identifier generated by a vendor for their reference.
	VendorOrderNumber *string `json:"vendorOrderNumber,omitempty"`
}

ShipmentDetails Details about a shipment.

type ShipmentDetailsShipmentStatus 

type ShipmentDetailsShipmentStatus string

ShipmentDetailsShipmentStatus Indicate the shipment status. 

const (
	FLOORDENIAL ShipmentDetailsShipmentStatus = "FLOOR_DENIAL"
	SHIPPED     ShipmentDetailsShipmentStatus = "SHIPPED"
)

Defines values for ShipmentDetailsShipmentStatus.

type ShipmentStatusUpdate 

type ShipmentStatusUpdate struct {
	// PurchaseOrderNumber Purchase order number of the shipment for which to update the shipment status.
	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"`

	// StatusUpdateDetails Details for the shipment status update given by the vendor for the specific package.
	StatusUpdateDetails StatusUpdateDetails `json:"statusUpdateDetails"`
}

ShipmentStatusUpdate Represents an update to the status of a shipment.

type ShippingLabel 

type ShippingLabel struct {
	// LabelData Provides the details of the packages in this shipment.
	LabelData []LabelData `json:"labelData"`

	// LabelFormat Format of the label.
	LabelFormat ShippingLabelLabelFormat `json:"labelFormat"`

	// PurchaseOrderNumber This field will contain the Purchase Order Number for this order.
	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"`
}

ShippingLabel Shipping label information for an order, including the purchase order number, selling party, ship from party, label format, and package details.

type ShippingLabelLabelFormat 

type ShippingLabelLabelFormat string

ShippingLabelLabelFormat Format of the label. 

const (
	PNG ShippingLabelLabelFormat = "PNG"
	ZPL ShippingLabelLabelFormat = "ZPL"
)

Defines values for ShippingLabelLabelFormat.

type ShippingLabelList 

type ShippingLabelList struct {
	// Pagination The pagination elements required to retrieve the remaining data.
	Pagination *Pagination `json:"pagination,omitempty"`

	// ShippingLabels An array containing the details of the generated shipping labels.
	ShippingLabels *[]ShippingLabel `json:"shippingLabels,omitempty"`
}

ShippingLabelList Response payload with the list of shipping labels

type ShippingLabelRequest 

type ShippingLabelRequest struct {
	// Containers A list of the packages in this shipment.
	Containers *[]Container `json:"containers,omitempty"`

	// PurchaseOrderNumber Purchase order number of the order for which to create a shipping label.
	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"`
}

ShippingLabelRequest Represents the request payload for creating a shipping label, containing the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment.

type StatusUpdateDetails 

type StatusUpdateDetails struct {
	// ReasonCode Provides a reason code for the status for the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
	ReasonCode string `json:"reasonCode"`

	// ShipmentSchedule Details for the scheduled delivery timeline for a shipment, including the estimated delivery date and time, as well as the start and end times of the appointment window for delivery.
	ShipmentSchedule *struct {
		// ApptWindowEndDateTime This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`.
		ApptWindowEndDateTime *time.Time `json:"apptWindowEndDateTime,omitempty"`

		// ApptWindowStartDateTime This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`.
		ApptWindowStartDateTime *time.Time `json:"apptWindowStartDateTime,omitempty"`

		// EstimatedDeliveryDateTime Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`.
		EstimatedDeliveryDateTime *time.Time `json:"estimatedDeliveryDateTime,omitempty"`
	} `json:"shipmentSchedule,omitempty"`

	// StatusCode Indicates the shipment status code for the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
	StatusCode string `json:"statusCode"`

	// StatusDateTime The date and time when the shipment status was updated. This field is expected to be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`.
	StatusDateTime time.Time `json:"statusDateTime"`

	// StatusLocationAddress Address of the party.
	StatusLocationAddress Address `json:"statusLocationAddress"`

	// TrackingNumber This is required to be provided for every package and should match with the `trackingNumber` sent for the shipment confirmation.
	TrackingNumber string `json:"trackingNumber"`
}

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

type SubmitShipmentConfirmationsJSONRequestBody 

type SubmitShipmentConfirmationsJSONRequestBody = SubmitShipmentConfirmationsRequest

SubmitShipmentConfirmationsJSONRequestBody defines body for SubmitShipmentConfirmations for application/json ContentType.

type SubmitShipmentConfirmationsRequest 

type SubmitShipmentConfirmationsRequest struct {
	// ShipmentConfirmations Array of `ShipmentConfirmation` objects, each representing confirmation details for a specific shipment.
	ShipmentConfirmations *[]ShipmentConfirmation `json:"shipmentConfirmations,omitempty"`
}

SubmitShipmentConfirmationsRequest The request schema for the `submitShipmentConfirmations` operation.

type SubmitShipmentConfirmationsResp 

type SubmitShipmentConfirmationsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SubmitShipmentConfirmationsResponse
	JSON400      *SubmitShipmentConfirmationsResponse
	JSON403      *SubmitShipmentConfirmationsResponse
	JSON404      *SubmitShipmentConfirmationsResponse
	JSON413      *SubmitShipmentConfirmationsResponse
	JSON415      *SubmitShipmentConfirmationsResponse
	JSON429      *SubmitShipmentConfirmationsResponse
	JSON500      *SubmitShipmentConfirmationsResponse
	JSON503      *SubmitShipmentConfirmationsResponse
}

func ParseSubmitShipmentConfirmationsResp 

func ParseSubmitShipmentConfirmationsResp(rsp *http.Response) (*SubmitShipmentConfirmationsResp, error)

ParseSubmitShipmentConfirmationsResp parses an HTTP response from a SubmitShipmentConfirmationsWithResponse call

func (SubmitShipmentConfirmationsResp) Status 

func (r SubmitShipmentConfirmationsResp) Status() string

Status returns HTTPResponse.Status

func (SubmitShipmentConfirmationsResp) StatusCode 

func (r SubmitShipmentConfirmationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitShipmentConfirmationsResponse 

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

	// Payload Response containing the transaction ID.
	Payload *TransactionReference `json:"payload,omitempty"`
}

SubmitShipmentConfirmationsResponse The response schema for the `submitShipmentConfirmations` operation.

type SubmitShipmentStatusUpdatesJSONRequestBody 

type SubmitShipmentStatusUpdatesJSONRequestBody = SubmitShipmentStatusUpdatesRequest

SubmitShipmentStatusUpdatesJSONRequestBody defines body for SubmitShipmentStatusUpdates for application/json ContentType.

type SubmitShipmentStatusUpdatesRequest 

type SubmitShipmentStatusUpdatesRequest struct {
	// ShipmentStatusUpdates Contains a list of one or more `ShipmentStatusUpdate` objects, each representing an update to the status of a specific shipment.
	ShipmentStatusUpdates *[]ShipmentStatusUpdate `json:"shipmentStatusUpdates,omitempty"`
}

SubmitShipmentStatusUpdatesRequest Represents the request payload for submitting updates to the status of shipments, containing an array of one or more `ShipmentStatusUpdate` objects.

type SubmitShipmentStatusUpdatesResp 

type SubmitShipmentStatusUpdatesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SubmitShipmentStatusUpdatesResponse
	JSON400      *SubmitShipmentStatusUpdatesResponse
	JSON403      *SubmitShipmentStatusUpdatesResponse
	JSON404      *SubmitShipmentStatusUpdatesResponse
	JSON413      *SubmitShipmentStatusUpdatesResponse
	JSON415      *SubmitShipmentStatusUpdatesResponse
	JSON429      *SubmitShipmentStatusUpdatesResponse
	JSON500      *SubmitShipmentStatusUpdatesResponse
	JSON503      *SubmitShipmentStatusUpdatesResponse
}

func ParseSubmitShipmentStatusUpdatesResp 

func ParseSubmitShipmentStatusUpdatesResp(rsp *http.Response) (*SubmitShipmentStatusUpdatesResp, error)

ParseSubmitShipmentStatusUpdatesResp parses an HTTP response from a SubmitShipmentStatusUpdatesWithResponse call

func (SubmitShipmentStatusUpdatesResp) Status 

func (r SubmitShipmentStatusUpdatesResp) Status() string

Status returns HTTPResponse.Status

func (SubmitShipmentStatusUpdatesResp) StatusCode 

func (r SubmitShipmentStatusUpdatesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitShipmentStatusUpdatesResponse 

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

	// Payload Response containing the transaction ID.
	Payload *TransactionReference `json:"payload,omitempty"`
}

SubmitShipmentStatusUpdatesResponse The response schema for the `submitShipmentStatusUpdates` operation.

type SubmitShippingLabelRequestJSONRequestBody 

type SubmitShippingLabelRequestJSONRequestBody = SubmitShippingLabelsRequest

SubmitShippingLabelRequestJSONRequestBody defines body for SubmitShippingLabelRequest for application/json ContentType.

type SubmitShippingLabelRequestResp 

type SubmitShippingLabelRequestResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *SubmitShippingLabelsResponse
	JSON400      *SubmitShippingLabelsResponse
	JSON403      *SubmitShippingLabelsResponse
	JSON404      *SubmitShippingLabelsResponse
	JSON413      *SubmitShippingLabelsResponse
	JSON415      *SubmitShippingLabelsResponse
	JSON429      *SubmitShippingLabelsResponse
	JSON500      *SubmitShippingLabelsResponse
	JSON503      *SubmitShippingLabelsResponse
}

func ParseSubmitShippingLabelRequestResp 

func ParseSubmitShippingLabelRequestResp(rsp *http.Response) (*SubmitShippingLabelRequestResp, error)

ParseSubmitShippingLabelRequestResp parses an HTTP response from a SubmitShippingLabelRequestWithResponse call

func (SubmitShippingLabelRequestResp) Status 

func (r SubmitShippingLabelRequestResp) Status() string

Status returns HTTPResponse.Status

func (SubmitShippingLabelRequestResp) StatusCode 

func (r SubmitShippingLabelRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitShippingLabelsRequest 

type SubmitShippingLabelsRequest struct {
	// ShippingLabelRequests An array of shipping label requests to be processed.
	ShippingLabelRequests *[]ShippingLabelRequest `json:"shippingLabelRequests,omitempty"`
}

SubmitShippingLabelsRequest The request schema for the `submitShippingLabelRequest` operation.

type SubmitShippingLabelsResponse 

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

	// Payload Response containing the transaction ID.
	Payload *TransactionReference `json:"payload,omitempty"`
}

SubmitShippingLabelsResponse The response schema for the `submitShippingLabelRequest` operation.

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 (
	GST TaxRegistrationDetailsTaxRegistrationType = "GST"
	VAT TaxRegistrationDetailsTaxRegistrationType = "VAT"
)

Defines values for TaxRegistrationDetailsTaxRegistrationType.

type TransactionReference 

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

TransactionReference Response containing the transaction ID.

type Weight 

type Weight struct {
	// UnitOfMeasure The unit of measurement.
	UnitOfMeasure WeightUnitOfMeasure `json:"unitOfMeasure"`

	// Value A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.  <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
	Value Decimal `json:"value"`
}

Weight The weight.

type WeightUnitOfMeasure 

type WeightUnitOfMeasure string

WeightUnitOfMeasure The unit of measurement. 

const (
	KG WeightUnitOfMeasure = "KG"
	LB WeightUnitOfMeasure = "LB"
)

Defines values for WeightUnitOfMeasure.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.