swagger

package

v0.0.0-...-c324a2f Latest Latest Go to latest Published: May 6, 2023 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/skeleton1231/amz-sp-api-gosdk

Links

Open Source Insights

README ¶

Go API client for swagger

With the Messaging API you can build applications that send messages to buyers. You can get a list of message types that are available for an order that you specify, then call an operation that sends a message to the buyer for that order. The Messaging API returns responses that are formed according to the JSON Hypertext Application Language (HAL) standard.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: v1
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://sellercentral.amazon.com/gp/mws/contactus.html

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://sellingpartnerapi-na.amazon.com/

Class	Method	HTTP request
MessagingApi	ConfirmCustomizationDetails	Post /messaging/v1/orders/{amazonOrderId}/messages/confirmCustomizationDetails
MessagingApi	CreateAmazonMotors	Post /messaging/v1/orders/{amazonOrderId}/messages/amazonMotors
MessagingApi	CreateConfirmDeliveryDetails	Post /messaging/v1/orders/{amazonOrderId}/messages/confirmDeliveryDetails
MessagingApi	CreateConfirmOrderDetails	Post /messaging/v1/orders/{amazonOrderId}/messages/confirmOrderDetails
MessagingApi	CreateConfirmServiceDetails	Post /messaging/v1/orders/{amazonOrderId}/messages/confirmServiceDetails
MessagingApi	CreateDigitalAccessKey	Post /messaging/v1/orders/{amazonOrderId}/messages/digitalAccessKey
MessagingApi	CreateLegalDisclosure	Post /messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure
MessagingApi	CreateNegativeFeedbackRemoval	Post /messaging/v1/orders/{amazonOrderId}/messages/negativeFeedbackRemoval
MessagingApi	CreateUnexpectedProblem	Post /messaging/v1/orders/{amazonOrderId}/messages/unexpectedProblem
MessagingApi	CreateWarranty	Post /messaging/v1/orders/{amazonOrderId}/messages/warranty
MessagingApi	GetAttributes	Get /messaging/v1/orders/{amazonOrderId}/attributes
MessagingApi	GetMessagingActionsForOrder	Get /messaging/v1/orders/{amazonOrderId}
MessagingApi	SendInvoice	Post /messaging/v1/orders/{amazonOrderId}/messages/invoice

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Selling Partner API for Messaging * * With the Messaging API you can build applications that send messages to buyers. You can get a list of message types that are available for an order that you specify, then call an operation that sends a message to the buyer for that order. The Messaging API returns responses that are formed according to the <a href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language</a> (HAL) standard. * * API version: v1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type Attachment
type BasicAuth
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type CreateAmazonMotorsRequest
type CreateAmazonMotorsResponse
type CreateConfirmCustomizationDetailsRequest
type CreateConfirmCustomizationDetailsResponse
type CreateConfirmDeliveryDetailsRequest
type CreateConfirmDeliveryDetailsResponse
type CreateConfirmOrderDetailsRequest
type CreateConfirmOrderDetailsResponse
type CreateConfirmServiceDetailsRequest
type CreateConfirmServiceDetailsResponse
type CreateDigitalAccessKeyRequest
type CreateDigitalAccessKeyResponse
type CreateLegalDisclosureRequest
type CreateLegalDisclosureResponse
type CreateNegativeFeedbackRemovalResponse
type CreateUnexpectedProblemRequest
type CreateUnexpectedProblemResponse
type CreateWarrantyRequest
type CreateWarrantyResponse
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetAttributesResponse
type GetAttributesResponseBuyer
type GetMessagingActionResponse
type GetMessagingActionResponseEmbedded
type GetMessagingActionResponseLinks
type GetMessagingActionsForOrderResponse
type GetMessagingActionsForOrderResponseEmbedded
type GetMessagingActionsForOrderResponseLinks
type GetSchemaResponse
type GetSchemaResponseLinks
type InvoiceRequest
type InvoiceResponse
type LinkObject
type MessagingAction
type MessagingApiService
- func (a *MessagingApiService) ConfirmCustomizationDetails(ctx context.Context, body CreateConfirmCustomizationDetailsRequest, ...) (CreateConfirmCustomizationDetailsResponse, *http.Response, error)
- func (a *MessagingApiService) CreateAmazonMotors(ctx context.Context, body CreateAmazonMotorsRequest, marketplaceIds []string, ...) (CreateAmazonMotorsResponse, *http.Response, error)
- func (a *MessagingApiService) CreateConfirmDeliveryDetails(ctx context.Context, body CreateConfirmDeliveryDetailsRequest, ...) (CreateConfirmDeliveryDetailsResponse, *http.Response, error)
- func (a *MessagingApiService) CreateConfirmOrderDetails(ctx context.Context, body CreateConfirmOrderDetailsRequest, ...) (CreateConfirmOrderDetailsResponse, *http.Response, error)
- func (a *MessagingApiService) CreateConfirmServiceDetails(ctx context.Context, body CreateConfirmServiceDetailsRequest, ...) (CreateConfirmServiceDetailsResponse, *http.Response, error)
- func (a *MessagingApiService) CreateDigitalAccessKey(ctx context.Context, body CreateDigitalAccessKeyRequest, ...) (CreateDigitalAccessKeyResponse, *http.Response, error)
- func (a *MessagingApiService) CreateLegalDisclosure(ctx context.Context, body CreateLegalDisclosureRequest, ...) (CreateLegalDisclosureResponse, *http.Response, error)
- func (a *MessagingApiService) CreateNegativeFeedbackRemoval(ctx context.Context, amazonOrderId string, marketplaceIds []string) (CreateNegativeFeedbackRemovalResponse, *http.Response, error)
- func (a *MessagingApiService) CreateUnexpectedProblem(ctx context.Context, body CreateUnexpectedProblemRequest, ...) (CreateUnexpectedProblemResponse, *http.Response, error)
- func (a *MessagingApiService) CreateWarranty(ctx context.Context, body CreateWarrantyRequest, marketplaceIds []string, ...) (CreateWarrantyResponse, *http.Response, error)
- func (a *MessagingApiService) GetAttributes(ctx context.Context, amazonOrderId string, marketplaceIds []string) (GetAttributesResponse, *http.Response, error)
- func (a *MessagingApiService) GetMessagingActionsForOrder(ctx context.Context, amazonOrderId string, marketplaceIds []string) (GetMessagingActionsForOrderResponse, *http.Response, error)
- func (a *MessagingApiService) SendInvoice(ctx context.Context, body InvoiceRequest, marketplaceIds []string, ...) (InvoiceResponse, *http.Response, error)
type ModelError

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	MessagingApi *MessagingApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Selling Partner API for Messaging API vv1 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Attachment ¶

type Attachment struct {
	// The identifier of the upload destination. Get this value by calling the [createUploadDestinationForResource](doc:uploads-api-reference#post-uploads2020-11-01uploaddestinationsresource) operation of the Uploads API.
	UploadDestinationId string `json:"uploadDestinationId"`
	// The name of the file, including the extension. This is the file name that will appear in the message. This does not need to match the file name of the file that you uploaded.
	FileName string `json:"fileName"`
}

Represents a file uploaded to a destination that was created by the [createUploadDestinationForResource](doc:uploads-api-reference#post-uploads2020-11-01uploaddestinationsresource) operation of the Selling Partner API for Uploads.

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateAmazonMotorsRequest ¶

type CreateAmazonMotorsRequest struct {
	// Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Attachments []Attachment `json:"attachments,omitempty"`
}

The request schema for the createAmazonMotors operation.

type CreateAmazonMotorsResponse ¶

type CreateAmazonMotorsResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createAmazonMotors operation.

type CreateConfirmCustomizationDetailsRequest ¶

type CreateConfirmCustomizationDetailsRequest struct {
	// The text to be sent to the buyer. Only links related to customization details are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Text string `json:"text,omitempty"`
	// Attachments to include in the message to the buyer.
	Attachments []Attachment `json:"attachments,omitempty"`
}

The request schema for the confirmCustomizationDetails operation.

type CreateConfirmCustomizationDetailsResponse ¶

type CreateConfirmCustomizationDetailsResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the confirmCustomizationDetails operation.

type CreateConfirmDeliveryDetailsRequest ¶

type CreateConfirmDeliveryDetailsRequest struct {
	// The text to be sent to the buyer. Only links related to order delivery are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Text string `json:"text,omitempty"`
}

The request schema for the createConfirmDeliveryDetails operation.

type CreateConfirmDeliveryDetailsResponse ¶

type CreateConfirmDeliveryDetailsResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createConfirmDeliveryDetails operation.

type CreateConfirmOrderDetailsRequest ¶

type CreateConfirmOrderDetailsRequest struct {
	// The text to be sent to the buyer. Only links related to order completion are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Text string `json:"text,omitempty"`
}

The request schema for the createConfirmOrderDetails operation.

type CreateConfirmOrderDetailsResponse ¶

type CreateConfirmOrderDetailsResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createConfirmOrderDetails operation.

type CreateConfirmServiceDetailsRequest ¶

type CreateConfirmServiceDetailsRequest struct {
	// The text to be sent to the buyer. Only links related to Home Service calls are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Text string `json:"text,omitempty"`
}

The request schema for the createConfirmServiceDetails operation.

type CreateConfirmServiceDetailsResponse ¶

type CreateConfirmServiceDetailsResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createConfirmServiceDetails operation.

type CreateDigitalAccessKeyRequest ¶

type CreateDigitalAccessKeyRequest struct {
	// The text to be sent to the buyer. Only links related to the digital access key are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Text string `json:"text,omitempty"`
	// Attachments to include in the message to the buyer.
	Attachments []Attachment `json:"attachments,omitempty"`
}

The request schema for the createDigitalAccessKey operation.

type CreateDigitalAccessKeyResponse ¶

type CreateDigitalAccessKeyResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createDigitalAccessKey operation.

type CreateLegalDisclosureRequest ¶

type CreateLegalDisclosureRequest struct {
	// Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Attachments []Attachment `json:"attachments,omitempty"`
}

The request schema for the createLegalDisclosure operation.

type CreateLegalDisclosureResponse ¶

type CreateLegalDisclosureResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createLegalDisclosure operation.

type CreateNegativeFeedbackRemovalResponse ¶

type CreateNegativeFeedbackRemovalResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createNegativeFeedbackRemoval operation.

type CreateUnexpectedProblemRequest ¶

type CreateUnexpectedProblemRequest struct {
	// The text to be sent to the buyer. Only links related to unexpected problem calls are allowed. Do not include HTML or email addresses. The text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Text string `json:"text,omitempty"`
}

The request schema for the createUnexpectedProblem operation.

type CreateUnexpectedProblemResponse ¶

type CreateUnexpectedProblemResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createUnexpectedProblem operation.

type CreateWarrantyRequest ¶

type CreateWarrantyRequest struct {
	// Attachments to include in the message to the buyer. If any text is included in the attachment, the text must be written in the buyer's language of preference, which can be retrieved from the GetAttributes operation.
	Attachments []Attachment `json:"attachments,omitempty"`
	// The start date of the warranty coverage to include in the message to the buyer.
	CoverageStartDate time.Time `json:"coverageStartDate,omitempty"`
	// The end date of the warranty coverage to include in the message to the buyer.
	CoverageEndDate time.Time `json:"coverageEndDate,omitempty"`
}

The request schema for the createWarranty operation.

type CreateWarrantyResponse ¶

type CreateWarrantyResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the createWarranty operation.

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetAttributesResponse ¶

type GetAttributesResponse struct {
	Buyer  *GetAttributesResponseBuyer `json:"buyer,omitempty"`
	Errors *[]ModelError               `json:"errors,omitempty"`
}

The response schema for the GetAttributes operation.

type GetAttributesResponseBuyer ¶

type GetAttributesResponseBuyer struct {
	// The buyer's language of preference, indicated with a locale-specific language tag. Examples: \"en-US\", \"zh-CN\", and \"en-GB\".
	Locale string `json:"locale,omitempty"`
}

The list of attributes related to the buyer.

type GetMessagingActionResponse ¶

type GetMessagingActionResponse struct {
	Links    *GetMessagingActionResponseLinks    `json:"_links,omitempty"`
	Embedded *GetMessagingActionResponseEmbedded `json:"_embedded,omitempty"`
	Payload  *MessagingAction                    `json:"payload,omitempty"`
	Errors   *[]ModelError                       `json:"errors,omitempty"`
}

Describes a messaging action that can be taken for an order. Provides a JSON Hypertext Application Language (HAL) link to the JSON schema document that describes the expected input.

type GetMessagingActionResponseEmbedded ¶

type GetMessagingActionResponseEmbedded struct {
	Schema *GetSchemaResponse `json:"schema,omitempty"`
}

type GetMessagingActionResponseLinks ¶

type GetMessagingActionResponseLinks struct {
	Self   *LinkObject `json:"self"`
	Schema *LinkObject `json:"schema"`
}

type GetMessagingActionsForOrderResponse ¶

type GetMessagingActionsForOrderResponse struct {
	Links    *GetMessagingActionsForOrderResponseLinks    `json:"_links,omitempty"`
	Embedded *GetMessagingActionsForOrderResponseEmbedded `json:"_embedded,omitempty"`
	Errors   *[]ModelError                                `json:"errors,omitempty"`
}

The response schema for the getMessagingActionsForOrder operation.

type GetMessagingActionsForOrderResponseEmbedded ¶

type GetMessagingActionsForOrderResponseEmbedded struct {
	Actions []GetMessagingActionResponse `json:"actions"`
}

type GetMessagingActionsForOrderResponseLinks ¶

type GetMessagingActionsForOrderResponseLinks struct {
	Self *LinkObject `json:"self"`
	// Eligible actions for the specified amazonOrderId.
	Actions []LinkObject `json:"actions"`
}

type GetSchemaResponse ¶

type GetSchemaResponse struct {
	Links   *GetSchemaResponseLinks `json:"_links,omitempty"`
	Payload *map[string]interface{} `json:"payload,omitempty"`
	Errors  *[]ModelError           `json:"errors,omitempty"`
}

type GetSchemaResponseLinks ¶

type GetSchemaResponseLinks struct {
	Self *LinkObject `json:"self"`
}

type InvoiceRequest ¶

type InvoiceRequest struct {
	// Attachments to include in the message to the buyer.
	Attachments []Attachment `json:"attachments,omitempty"`
}

The request schema for the sendInvoice operation.

type InvoiceResponse ¶

type InvoiceResponse struct {
	Errors *[]ModelError `json:"errors,omitempty"`
}

The response schema for the sendInvoice operation.

type LinkObject ¶

type LinkObject struct {
	// A URI for this object.
	Href string `json:"href"`
	// An identifier for this object.
	Name string `json:"name,omitempty"`
}

A Link object.

type MessagingAction ¶

type MessagingAction struct {
	Name string `json:"name"`
}

A simple object containing the name of the template.

type MessagingApiService ¶

type MessagingApiService service

func (*MessagingApiService) ConfirmCustomizationDetails ¶

func (a *MessagingApiService) ConfirmCustomizationDetails(ctx context.Context, body CreateConfirmCustomizationDetailsRequest, marketplaceIds []string, amazonOrderId string) (CreateConfirmCustomizationDetailsResponse, *http.Response, error)

MessagingApiService Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateConfirmCustomizationDetailsResponse

func (*MessagingApiService) CreateAmazonMotors ¶

func (a *MessagingApiService) CreateAmazonMotors(ctx context.Context, body CreateAmazonMotorsRequest, marketplaceIds []string, amazonOrderId string) (CreateAmazonMotorsResponse, *http.Response, error)

MessagingApiService Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateAmazonMotorsResponse

func (*MessagingApiService) CreateConfirmDeliveryDetails ¶

func (a *MessagingApiService) CreateConfirmDeliveryDetails(ctx context.Context, body CreateConfirmDeliveryDetailsRequest, marketplaceIds []string, amazonOrderId string) (CreateConfirmDeliveryDetailsResponse, *http.Response, error)

MessagingApiService Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateConfirmDeliveryDetailsResponse

func (*MessagingApiService) CreateConfirmOrderDetails ¶

func (a *MessagingApiService) CreateConfirmOrderDetails(ctx context.Context, body CreateConfirmOrderDetailsRequest, marketplaceIds []string, amazonOrderId string) (CreateConfirmOrderDetailsResponse, *http.Response, error)

MessagingApiService Sends a message to ask a buyer an order-related question prior to shipping their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateConfirmOrderDetailsResponse

func (*MessagingApiService) CreateConfirmServiceDetails ¶

func (a *MessagingApiService) CreateConfirmServiceDetails(ctx context.Context, body CreateConfirmServiceDetailsRequest, marketplaceIds []string, amazonOrderId string) (CreateConfirmServiceDetailsResponse, *http.Response, error)

MessagingApiService Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateConfirmServiceDetailsResponse

func (*MessagingApiService) CreateDigitalAccessKey ¶

func (a *MessagingApiService) CreateDigitalAccessKey(ctx context.Context, body CreateDigitalAccessKeyRequest, marketplaceIds []string, amazonOrderId string) (CreateDigitalAccessKeyResponse, *http.Response, error)

MessagingApiService Sends a message to a buyer to share a digital access key needed to utilize digital content in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateDigitalAccessKeyResponse

func (*MessagingApiService) CreateLegalDisclosure ¶

func (a *MessagingApiService) CreateLegalDisclosure(ctx context.Context, body CreateLegalDisclosureRequest, marketplaceIds []string, amazonOrderId string) (CreateLegalDisclosureResponse, *http.Response, error)

MessagingApiService Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateLegalDisclosureResponse

func (*MessagingApiService) CreateNegativeFeedbackRemoval ¶

func (a *MessagingApiService) CreateNegativeFeedbackRemoval(ctx context.Context, amazonOrderId string, marketplaceIds []string) (CreateNegativeFeedbackRemovalResponse, *http.Response, error)

MessagingApiService Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer's problem. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

@return CreateNegativeFeedbackRemovalResponse

func (*MessagingApiService) CreateUnexpectedProblem ¶

func (a *MessagingApiService) CreateUnexpectedProblem(ctx context.Context, body CreateUnexpectedProblemRequest, marketplaceIds []string, amazonOrderId string) (CreateUnexpectedProblemResponse, *http.Response, error)

MessagingApiService Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateUnexpectedProblemResponse

func (*MessagingApiService) CreateWarranty ¶

func (a *MessagingApiService) CreateWarranty(ctx context.Context, body CreateWarrantyRequest, marketplaceIds []string, amazonOrderId string) (CreateWarrantyResponse, *http.Response, error)

MessagingApiService Sends a message to a buyer to provide details about warranty information on a purchase in their order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return CreateWarrantyResponse

func (*MessagingApiService) GetAttributes ¶

func (a *MessagingApiService) GetAttributes(ctx context.Context, amazonOrderId string, marketplaceIds []string) (GetAttributesResponse, *http.Response, error)

MessagingApiService Returns a response containing attributes related to an order. This includes buyer preferences. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

@return GetAttributesResponse

func (*MessagingApiService) GetMessagingActionsForOrder ¶

func (a *MessagingApiService) GetMessagingActionsForOrder(ctx context.Context, amazonOrderId string, marketplaceIds []string) (GetMessagingActionsForOrderResponse, *http.Response, error)

MessagingApiService Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param amazonOrderId An Amazon order identifier. This specifies the order for which you want a list of available message types.
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

@return GetMessagingActionsForOrderResponse

func (*MessagingApiService) SendInvoice ¶

func (a *MessagingApiService) SendInvoice(ctx context.Context, body InvoiceRequest, marketplaceIds []string, amazonOrderId string) (InvoiceResponse, *http.Response, error)

MessagingApiService Sends a message providing the buyer an invoice

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param marketplaceIds A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.
@param amazonOrderId An Amazon order identifier. This specifies the order for which a message is sent.

@return InvoiceResponse

type ModelError ¶

type ModelError struct {
	// An error code that identifies the type of error that occurred.
	Code string `json:"code"`
	// A message that describes the error condition.
	Message string `json:"message"`
	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`
}

Error response returned when the request is unsuccessful.

Source Files ¶

View all Source files

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