customerInvoices

package
v0.0.0-...-f22db7b Latest Latest
Warning

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

Go to latest
Published: Jul 16, 2022 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package customerInvoices provides primitives to interact the openapi HTTP API.

Code generated by go-sdk-codegen DO NOT EDIT.

Package customerInvoices provides primitives to interact the openapi HTTP API.

Code generated by go-sdk-codegen DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetCustomerInvoiceRequest

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

NewGetCustomerInvoiceRequest generates requests for GetCustomerInvoice

func NewGetCustomerInvoicesRequest

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

NewGetCustomerInvoicesRequest generates requests for GetCustomerInvoices

func NewGetPackingSlipRequest

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

NewGetPackingSlipRequest generates requests for GetPackingSlip

func NewGetPackingSlipsRequest

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

NewGetPackingSlipsRequest generates requests for GetPackingSlips

func NewGetShippingLabelRequest

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

NewGetShippingLabelRequest generates requests for GetShippingLabel

func NewGetShippingLabelsRequest

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

NewGetShippingLabelsRequest generates requests for GetShippingLabels

func NewSubmitShipmentConfirmationsRequest

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

NewSubmitShipmentConfirmationsRequest calls the generic SubmitShipmentConfirmations builder with application/json body

func NewSubmitShipmentConfirmationsRequestWithBody

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

NewSubmitShipmentConfirmationsRequestWithBody generates requests for SubmitShipmentConfirmations with any type of body

func NewSubmitShipmentStatusUpdatesRequest

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

NewSubmitShipmentStatusUpdatesRequest calls the generic SubmitShipmentStatusUpdates builder with application/json body

func NewSubmitShipmentStatusUpdatesRequestWithBody

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

NewSubmitShipmentStatusUpdatesRequestWithBody generates requests for SubmitShipmentStatusUpdates with any type of body

func NewSubmitShippingLabelRequestRequest

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

NewSubmitShippingLabelRequestRequest calls the generic SubmitShippingLabelRequest builder with application/json body

func NewSubmitShippingLabelRequestRequestWithBody

func NewSubmitShippingLabelRequestRequestWithBody(endpoint 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 {

	// First line of the address.
	AddressLine1 string `json:"addressLine1"`

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

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

	// The city where the person, business or institution is located.
	City *string `json:"city,omitempty"`

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

	// 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 name of the person, business or institution at that address.
	Name string `json:"name"`

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

	// The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
	PostalCode *string `json:"postalCode,omitempty"`

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

Address defines model for Address.

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.
	Endpoint string

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

	// A callback for modifying requests which are generated before sending over
	// the network.
	RequestBefore RequestBeforeFn

	// A callback for modifying response which are generated before sending over
	// the network.
	ResponseAfter ResponseAfterFn

	// 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(endpoint 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)

	// SubmitShipmentConfirmations 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)

	// SubmitShipmentStatusUpdates 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)

	// SubmitShippingLabelRequest 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 WithRequestBefore

func WithRequestBefore(fn RequestBeforeFn) ClientOption

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

func WithResponseAfter

func WithResponseAfter(fn ResponseAfterFn) ClientOption

WithResponseAfter allows setting up a callback function, which will be called right after get response the request. This can be used to log.

func WithUserAgent

func WithUserAgent(userAgent string) ClientOption

WithUserAgent set up useragent add user agent to every request automatically

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(endpoint 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 *GetCustomerInvoiceResponse

func (*ClientWithResponses) GetCustomerInvoicesWithResponse

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

GetCustomerInvoicesWithResponse request returning *GetCustomerInvoicesResponse

func (*ClientWithResponses) GetPackingSlipWithResponse

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

GetPackingSlipWithResponse request returning *GetPackingSlipResponse

func (*ClientWithResponses) GetPackingSlipsWithResponse

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

GetPackingSlipsWithResponse request returning *GetPackingSlipsResponse

func (*ClientWithResponses) GetShippingLabelWithResponse

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

GetShippingLabelWithResponse request returning *GetShippingLabelResponse

func (*ClientWithResponses) GetShippingLabelsWithResponse

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

GetShippingLabelsWithResponse request returning *GetShippingLabelsResponse

func (*ClientWithResponses) SubmitShipmentConfirmationsWithBodyWithResponse

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

SubmitShipmentConfirmationsWithBodyWithResponse request with arbitrary body returning *SubmitShipmentConfirmationsResponse

func (*ClientWithResponses) SubmitShipmentConfirmationsWithResponse

func (*ClientWithResponses) SubmitShipmentStatusUpdatesWithBodyWithResponse

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

SubmitShipmentStatusUpdatesWithBodyWithResponse request with arbitrary body returning *SubmitShipmentStatusUpdatesResponse

func (*ClientWithResponses) SubmitShipmentStatusUpdatesWithResponse

func (*ClientWithResponses) SubmitShippingLabelRequestWithBodyWithResponse

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

SubmitShippingLabelRequestWithBodyWithResponse request with arbitrary body returning *SubmitShippingLabelRequestResponse

func (*ClientWithResponses) SubmitShippingLabelRequestWithResponse

type ClientWithResponsesInterface

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

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

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

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

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

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

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

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

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

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

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

	// GetShippingLabel 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 required for EU VOC vendors only.
	Carrier *string `json:"carrier,omitempty"`

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

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

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

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

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

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

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

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

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

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

	// The weight.
	Weight *Weight `json:"weight,omitempty"`
}

Container defines model for Container.

type CustomerInvoice

type CustomerInvoice struct {

	// The Base64encoded customer invoice.
	Content string `json:"content"`

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

CustomerInvoice defines model for CustomerInvoice.

type CustomerInvoiceList

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

CustomerInvoiceList defines model for CustomerInvoiceList.

type Decimal

type Decimal string

Decimal defines model for Decimal.

type Dimensions

type Dimensions struct {

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

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

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

	// 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 defines model for Dimensions.

type Error

type Error struct {

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

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

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

Error defines model for Error.

type ErrorList

type ErrorList []Error

ErrorList defines model for ErrorList.

type GetCustomerInvoiceResp

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 {

	// A list of error responses returned when a request is unsuccessful.
	Errors  *ErrorList       `json:"errors,omitempty"`
	Payload *CustomerInvoice `json:"payload,omitempty"`
}

GetCustomerInvoiceResponse defines model for GetCustomerInvoiceResponse.

type GetCustomerInvoicesParams

type GetCustomerInvoicesParams struct {

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

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

	// 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 `json:"createdAfter"`

	// 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 `json:"createdBefore"`

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

	// 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 `json:"nextToken,omitempty"`
}

GetCustomerInvoicesParams defines parameters for GetCustomerInvoices.

type GetCustomerInvoicesResp

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 {

	// A list of error responses returned when a request is unsuccessful.
	Errors  *ErrorList           `json:"errors,omitempty"`
	Payload *CustomerInvoiceList `json:"payload,omitempty"`
}

GetCustomerInvoicesResponse defines model for GetCustomerInvoicesResponse.

type GetPackingSlipListResponse

type GetPackingSlipListResponse struct {

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

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

GetPackingSlipListResponse defines model for GetPackingSlipListResponse.

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 {

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

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

GetPackingSlipResponse defines model for GetPackingSlipResponse.

type GetPackingSlipsParams

type GetPackingSlipsParams struct {

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

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

	// Packing slips 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 `json:"createdAfter"`

	// Packing slips 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 `json:"createdBefore"`

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

	// 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 `json:"nextToken,omitempty"`
}

GetPackingSlipsParams defines parameters for GetPackingSlips.

type GetPackingSlipsResp

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 {

	// A list of error responses returned when a request is unsuccessful.
	Errors  *ErrorList         `json:"errors,omitempty"`
	Payload *ShippingLabelList `json:"payload,omitempty"`
}

GetShippingLabelListResponse defines model for GetShippingLabelListResponse.

type GetShippingLabelResp

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 {

	// A list of error responses returned when a request is unsuccessful.
	Errors  *ErrorList     `json:"errors,omitempty"`
	Payload *ShippingLabel `json:"payload,omitempty"`
}

GetShippingLabelResponse defines model for GetShippingLabelResponse.

type GetShippingLabelsParams

type GetShippingLabelsParams struct {

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

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

	// Shipping labels 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 `json:"createdAfter"`

	// Shipping labels 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 `json:"createdBefore"`

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

	// 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 `json:"nextToken,omitempty"`
}

GetShippingLabelsParams defines parameters for GetShippingLabels.

type GetShippingLabelsResp

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 {

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

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

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

	// 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 defines model for Item.

type ItemQuantity

type ItemQuantity struct {

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

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

ItemQuantity defines model for ItemQuantity.

type LabelData

type LabelData struct {

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

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

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

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

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

LabelData defines model for LabelData.

type PackedItem

type PackedItem struct {

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

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

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

	// 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 defines model for PackedItem.

type PackingSlip

type PackingSlip struct {

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

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

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

PackingSlip defines model for PackingSlip.

type PackingSlipList

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

PackingSlipList defines model for PackingSlipList.

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

Pagination defines model for Pagination.

type PartyIdentification

type PartyIdentification struct {

	// Address of the party.
	Address *Address `json:"address,omitempty"`

	// Assigned Identification for the party.
	PartyId string `json:"partyId"`

	// Tax registration details of the entity.
	TaxRegistrationDetails *[]TaxRegistrationDetails `json:"taxRegistrationDetails,omitempty"`
}

PartyIdentification defines model for PartyIdentification.

type RequestBeforeFn

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

RequestBeforeFn is the function signature for the RequestBefore callback function

type ResponseAfterFn

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

ResponseAfterFn is the function signature for the ResponseAfter callback function

type ShipmentConfirmation

type ShipmentConfirmation struct {

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

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

	// Purchase order number corresponding to the shipment.
	PurchaseOrderNumber string              `json:"purchaseOrderNumber"`
	SellingParty        PartyIdentification `json:"sellingParty"`
	ShipFromParty       PartyIdentification `json:"shipFromParty"`

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

ShipmentConfirmation defines model for ShipmentConfirmation.

type ShipmentDetails

type ShipmentDetails struct {

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

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

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

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

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

ShipmentDetails defines model for ShipmentDetails.

type ShipmentStatusUpdate

type ShipmentStatusUpdate struct {

	// Purchase order number of the shipment for which to update the shipment status.
	PurchaseOrderNumber string              `json:"purchaseOrderNumber"`
	SellingParty        PartyIdentification `json:"sellingParty"`
	ShipFromParty       PartyIdentification `json:"shipFromParty"`

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

ShipmentStatusUpdate defines model for ShipmentStatusUpdate.

type ShippingLabel

type ShippingLabel struct {

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

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

	// This field will contain the Purchase Order Number for this order.
	PurchaseOrderNumber string              `json:"purchaseOrderNumber"`
	SellingParty        PartyIdentification `json:"sellingParty"`
	ShipFromParty       PartyIdentification `json:"shipFromParty"`
}

ShippingLabel defines model for ShippingLabel.

type ShippingLabelList

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

ShippingLabelList defines model for ShippingLabelList.

type ShippingLabelRequest

type ShippingLabelRequest struct {

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

	// Purchase order number of the order for which to create a shipping label.
	PurchaseOrderNumber string              `json:"purchaseOrderNumber"`
	SellingParty        PartyIdentification `json:"sellingParty"`
	ShipFromParty       PartyIdentification `json:"shipFromParty"`
}

ShippingLabelRequest defines model for ShippingLabelRequest.

type StatusUpdateDetails

type StatusUpdateDetails struct {

	// Provides a reason code for the status of the package that will provide additional information about the transportation status.
	ReasonCode       string `json:"reasonCode"`
	ShipmentSchedule *struct {

		// This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
		ApptWindowEndDateTime *time.Time `json:"apptWindowEndDateTime,omitempty"`

		// This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
		ApptWindowStartDateTime *time.Time `json:"apptWindowStartDateTime,omitempty"`

		// Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
		EstimatedDeliveryDateTime *time.Time `json:"estimatedDeliveryDateTime,omitempty"`
	} `json:"shipmentSchedule,omitempty"`

	// Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer.
	StatusCode string `json:"statusCode"`

	// The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
	StatusDateTime time.Time `json:"statusDateTime"`

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

	// 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 defines model for StatusUpdateDetails.

type SubmitShipmentConfirmationsJSONBody

type SubmitShipmentConfirmationsJSONBody SubmitShipmentConfirmationsRequest

SubmitShipmentConfirmationsJSONBody defines parameters for SubmitShipmentConfirmations.

type SubmitShipmentConfirmationsJSONRequestBody

type SubmitShipmentConfirmationsJSONRequestBody SubmitShipmentConfirmationsJSONBody

SubmitShipmentConfirmationsRequestBody defines body for SubmitShipmentConfirmations for application/json ContentType.

type SubmitShipmentConfirmationsRequest

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

SubmitShipmentConfirmationsRequest defines model for SubmitShipmentConfirmationsRequest.

type SubmitShipmentConfirmationsResp

func ParseSubmitShipmentConfirmationsResp

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

ParseSubmitShipmentConfirmationsResp parses an HTTP response from a SubmitShipmentConfirmationsWithResponse call

func (SubmitShipmentConfirmationsResp) Status

Status returns HTTPResponse.Status

func (SubmitShipmentConfirmationsResp) StatusCode

func (r SubmitShipmentConfirmationsResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitShipmentConfirmationsResponse

type SubmitShipmentConfirmationsResponse struct {

	// A list of error responses returned when a request is unsuccessful.
	Errors  *ErrorList            `json:"errors,omitempty"`
	Payload *TransactionReference `json:"payload,omitempty"`
}

SubmitShipmentConfirmationsResponse defines model for SubmitShipmentConfirmationsResponse.

type SubmitShipmentStatusUpdatesJSONBody

type SubmitShipmentStatusUpdatesJSONBody SubmitShipmentStatusUpdatesRequest

SubmitShipmentStatusUpdatesJSONBody defines parameters for SubmitShipmentStatusUpdates.

type SubmitShipmentStatusUpdatesJSONRequestBody

type SubmitShipmentStatusUpdatesJSONRequestBody SubmitShipmentStatusUpdatesJSONBody

SubmitShipmentStatusUpdatesRequestBody defines body for SubmitShipmentStatusUpdates for application/json ContentType.

type SubmitShipmentStatusUpdatesRequest

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

SubmitShipmentStatusUpdatesRequest defines model for SubmitShipmentStatusUpdatesRequest.

type SubmitShipmentStatusUpdatesResp

func ParseSubmitShipmentStatusUpdatesResp

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

ParseSubmitShipmentStatusUpdatesResp parses an HTTP response from a SubmitShipmentStatusUpdatesWithResponse call

func (SubmitShipmentStatusUpdatesResp) Status

Status returns HTTPResponse.Status

func (SubmitShipmentStatusUpdatesResp) StatusCode

func (r SubmitShipmentStatusUpdatesResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitShipmentStatusUpdatesResponse

type SubmitShipmentStatusUpdatesResponse struct {

	// A list of error responses returned when a request is unsuccessful.
	Errors  *ErrorList            `json:"errors,omitempty"`
	Payload *TransactionReference `json:"payload,omitempty"`
}

SubmitShipmentStatusUpdatesResponse defines model for SubmitShipmentStatusUpdatesResponse.

type SubmitShippingLabelRequestJSONBody

type SubmitShippingLabelRequestJSONBody SubmitShippingLabelsRequest

SubmitShippingLabelRequestJSONBody defines parameters for SubmitShippingLabelRequest.

type SubmitShippingLabelRequestJSONRequestBody

type SubmitShippingLabelRequestJSONRequestBody SubmitShippingLabelRequestJSONBody

SubmitShippingLabelRequestRequestBody defines body for SubmitShippingLabelRequest for application/json ContentType.

type SubmitShippingLabelRequestResp

func ParseSubmitShippingLabelRequestResp

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

ParseSubmitShippingLabelRequestResp parses an HTTP response from a SubmitShippingLabelRequestWithResponse call

func (SubmitShippingLabelRequestResp) Status

Status returns HTTPResponse.Status

func (SubmitShippingLabelRequestResp) StatusCode

func (r SubmitShippingLabelRequestResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitShippingLabelsRequest

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

SubmitShippingLabelsRequest defines model for SubmitShippingLabelsRequest.

type SubmitShippingLabelsResponse

type SubmitShippingLabelsResponse struct {

	// A list of error responses returned when a request is unsuccessful.
	Errors  *ErrorList            `json:"errors,omitempty"`
	Payload *TransactionReference `json:"payload,omitempty"`
}

SubmitShippingLabelsResponse defines model for SubmitShippingLabelsResponse.

type TaxRegistrationDetails

type TaxRegistrationDetails struct {

	// Address of the party.
	TaxRegistrationAddress *Address `json:"taxRegistrationAddress,omitempty"`

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

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

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

TaxRegistrationDetails defines model for TaxRegistrationDetails.

type TransactionReference

type TransactionReference struct {

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

TransactionReference defines model for TransactionReference.

type Weight

type Weight struct {

	// The unit of measurement.
	UnitOfMeasure string `json:"unitOfMeasure"`

	// 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 defines model for Weight.

Jump to

Keyboard shortcuts

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