dist¶

Interfaces¶

AmazonAddress¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

AddressLine1?¶

optional AddressLine1?: string;

AddressLine2?¶

optional AddressLine2?: string;

AddressLine3?¶

optional AddressLine3?: string;

AddressType?¶

optional AddressType?: string;

City?¶

optional City?: string;

CountryCode?¶

optional CountryCode?: string;

County?¶

optional County?: string;

District?¶

optional District?: string;

Name?¶

optional Name?: string;

Phone?¶

optional Phone?: string;

PostalCode?¶

optional PostalCode?: string;

StateOrRegion?¶

optional StateOrRegion?: string;

AmazonAwsSigningOptions¶

Properties¶

accessKeyId¶

accessKeyId: string;

region¶

region: string;

secretAccessKey¶

secretAccessKey: string;

service?¶

optional service?: string;

sessionToken?¶

optional sessionToken?: string;

AmazonBuyerInfo¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

BuyerCounty?¶

optional BuyerCounty?: string;

BuyerEmail?¶

optional BuyerEmail?: string;

BuyerName?¶

optional BuyerName?: string;

BuyerTaxInfo?¶

optional BuyerTaxInfo?: {
  CompanyLegalName?: string;
  TaxClassifications?: {
     Name?: string;
     Value?: string;
  }[];
  TaxingRegion?: string;
};

CompanyLegalName?¶

optional CompanyLegalName?: string;

TaxClassifications?¶

optional TaxClassifications?: {
  Name?: string;
  Value?: string;
}[];

TaxingRegion?¶

optional TaxingRegion?: string;

PurchaseOrderNumber?¶

optional PurchaseOrderNumber?: string;

AmazonCreateSubscriptionInput¶

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

destinationId¶

destinationId: string;

marketplaceIds?¶

optional marketplaceIds?: string[];

Deprecated¶

Amazon Notifications createSubscription does not accept marketplaceIds as a query parameter. Use processingDirective.eventFilter when supported by the notification type.

notificationType¶

notificationType: string;

payloadVersion?¶

optional payloadVersion?: string;

processingDirective?¶

optional processingDirective?: AmazonMarketplaceJsonObject;

AmazonCredentialStatusInput¶

Properties¶

accessTokenConfigured?¶

optional accessTokenConfigured?: boolean;

awsRegion?¶

optional awsRegion?: string;

awsRoleConfigured?¶

optional awsRoleConfigured?: boolean;

expiresAt?¶

optional expiresAt?: string;

lwaClientConfigured?¶

optional lwaClientConfigured?: boolean;

marketplaceId?¶

optional marketplaceId?: string;

notificationDestinationConfigured?¶

optional notificationDestinationConfigured?: boolean;

notificationSignatureConfigured?¶

optional notificationSignatureConfigured?: boolean;

refreshTokenConfigured?¶

optional refreshTokenConfigured?: boolean;

scopes?¶

optional scopes?: string[];

AmazonDeleteSubscriptionInput¶

Properties¶

notificationType¶

notificationType: string;

subscriptionId¶

subscriptionId: string;

AmazonGetSubscriptionInput¶

Properties¶

notificationType¶

notificationType: string;

payloadVersion?¶

optional payloadVersion?: string;

AmazonKnownOperationRequestMap¶

Properties¶

notifications:createSubscription¶

notifications:createSubscription: AmazonOperationRequestInput & {
  body: Omit<AmazonCreateSubscriptionInput, "notificationType">;
  pathParams: {
     notificationType: string;
  };
};

Type Declaration¶

body¶

body: Omit<AmazonCreateSubscriptionInput, "notificationType">;

pathParams¶

pathParams: {
  notificationType: string;
};

pathParams.notificationType¶

notificationType: string;

notifications:deleteSubscriptionById¶

notifications:deleteSubscriptionById: AmazonOperationRequestInput & {
  pathParams: {
     notificationType: string;
     subscriptionId: string;
  };
};

Type Declaration¶

pathParams¶

pathParams: {
  notificationType: string;
  subscriptionId: string;
};

pathParams.notificationType¶

notificationType: string;

pathParams.subscriptionId¶

subscriptionId: string;

notifications:getDestination¶

notifications:getDestination: AmazonOperationRequestInput & {
  pathParams: {
     destinationId: string;
  };
};

Type Declaration¶

pathParams¶

pathParams: {
  destinationId: string;
};

pathParams.destinationId¶

destinationId: string;

notifications:getDestinations¶

notifications:getDestinations: AmazonOperationRequestInput;

notifications:getSubscription¶

notifications:getSubscription: AmazonOperationRequestInput & {
  pathParams: {
     notificationType: string;
  };
  query?: {
     payloadVersion?: string;
  };
};

Type Declaration¶

pathParams¶

pathParams: {
  notificationType: string;
};

pathParams.notificationType¶

notificationType: string;

query?¶

optional query?: {
  payloadVersion?: string;
};

query.payloadVersion?¶

optional payloadVersion?: string;

ordersV0:getOrder¶

ordersV0:getOrder: AmazonOperationRequestInput & {
  pathParams: {
     orderId: string;
  };
};

Type Declaration¶

pathParams¶

pathParams: {
  orderId: string;
};

pathParams.orderId¶

orderId: string;

ordersV0:getOrderItems¶

ordersV0:getOrderItems: AmazonOperationRequestInput & {
  pathParams: {
     orderId: string;
  };
  query?: {
     NextToken?: string;
  };
};

Type Declaration¶

pathParams¶

pathParams: {
  orderId: string;
};

pathParams.orderId¶

orderId: string;

query?¶

optional query?: {
  NextToken?: string;
};

query.NextToken?¶

optional NextToken?: string;

ordersV0:getOrders¶

ordersV0:getOrders: AmazonOperationRequestInput & {
  query?: AmazonOrderSearchInput;
};

Type Declaration¶

query?¶

optional query?: AmazonOrderSearchInput;

sellers:getMarketplaceParticipations¶

sellers:getMarketplaceParticipations: AmazonOperationRequestInput;

tokens_2021-03-01:createRestrictedDataToken¶

tokens_2021-03-01:createRestrictedDataToken: AmazonOperationRequestInput & {
  body: AmazonRestrictedDataTokenRequest;
};

Type Declaration¶

body¶

body: AmazonRestrictedDataTokenRequest;

AmazonKnownOperationResponseMap¶

Properties¶

notifications:createSubscription¶

notifications:createSubscription: AmazonNotificationSubscriptionResponse;

notifications:deleteSubscriptionById¶

notifications:deleteSubscriptionById: Record<string, never>;

notifications:getDestination¶

notifications:getDestination: AmazonNotificationDestinationResponse;

notifications:getDestinations¶

notifications:getDestinations: AmazonNotificationDestinationsResponse;

notifications:getSubscription¶

notifications:getSubscription: AmazonNotificationSubscriptionResponse;

ordersV0:getOrder¶

ordersV0:getOrder: AmazonOrderResponse;

ordersV0:getOrderItems¶

ordersV0:getOrderItems: AmazonOrderItemsResponse;

ordersV0:getOrders¶

ordersV0:getOrders: AmazonOrdersResponse;

sellers:getMarketplaceParticipations¶

sellers:getMarketplaceParticipations: AmazonMarketplaceParticipationsResponse;

tokens_2021-03-01:createRestrictedDataToken¶

tokens_2021-03-01:createRestrictedDataToken: AmazonRestrictedDataTokenResponse;

AmazonLiveCheckOptions¶

Extends¶

AmazonMarketplaceClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

AmazonMarketplaceClientOptions.accessToken

apiBaseUrl?¶

optional apiBaseUrl?: string;

Inherited from¶

AmazonMarketplaceClientOptions.apiBaseUrl

aws?¶

optional aws?: AmazonAwsSigningOptions;

Inherited from¶

AmazonMarketplaceClientOptions.aws

client?¶

optional client?: Pick<AmazonMarketplaceClient, "getMarketplaceParticipations">;

endpoint?¶

optional endpoint?: AmazonSpApiEndpoint;

Inherited from¶

AmazonMarketplaceClientOptions.endpoint

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Inherited from¶

AmazonMarketplaceClientOptions.fetch

lwaClientId?¶

optional lwaClientId?: string;

Inherited from¶

AmazonMarketplaceClientOptions.lwaClientId

lwaClientSecret?¶

optional lwaClientSecret?: string;

Inherited from¶

AmazonMarketplaceClientOptions.lwaClientSecret

lwaTokenUrl?¶

optional lwaTokenUrl?: string;

Inherited from¶

AmazonMarketplaceClientOptions.lwaTokenUrl

marketplaceId?¶

optional marketplaceId?: string;

Inherited from¶

AmazonMarketplaceClientOptions.marketplaceId

officialSdk?¶

optional officialSdk?: AmazonSpApiOfficialSdk;

Inherited from¶

AmazonMarketplaceClientOptions.officialSdk

refreshToken?¶

optional refreshToken?: string;

Inherited from¶

AmazonMarketplaceClientOptions.refreshToken

region?¶

optional region?: string;

Inherited from¶

AmazonMarketplaceClientOptions.region

restrictedDataToken?¶

optional restrictedDataToken?: string;

Inherited from¶

AmazonMarketplaceClientOptions.restrictedDataToken

restrictedDataTokenProvider?¶

optional restrictedDataTokenProvider?: (input) =>
  | string
  | AmazonRestrictedDataTokenResponse
  | Promise<
  | string
| AmazonRestrictedDataTokenResponse>;

Parameters¶

Parameter	Type
`input`	`AmazonRestrictedDataTokenRequest`

Returns¶

Inherited from¶

AmazonMarketplaceClientOptions.restrictedDataTokenProvider

restrictedDataTokenTargetApplication?¶

optional restrictedDataTokenTargetApplication?: string;

Inherited from¶

AmazonMarketplaceClientOptions.restrictedDataTokenTargetApplication

userAgent?¶

optional userAgent?: string;

Inherited from¶

AmazonMarketplaceClientOptions.userAgent

AmazonLwaTokenResponse¶

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

access_token?¶

optional access_token?: string;

expires_in?¶

optional expires_in?: number;

refresh_token?¶

optional refresh_token?: string;

token_type?¶

optional token_type?: string;

AmazonMarketplaceClient¶

Methods¶

createProductReviewAndSellerFeedbackSolicitation()¶

createProductReviewAndSellerFeedbackSolicitation(amazonOrderId, marketplaceIds?): Promise<AmazonResource>;

Parameters¶

Parameter	Type
`amazonOrderId`	`string`
`marketplaceIds?`	`string`[]

Returns¶

Promise\<AmazonResource>

createRestrictedDataToken()¶

createRestrictedDataToken(input): Promise<AmazonRestrictedDataTokenResponse>;

Parameters¶

Parameter	Type
`input`	`AmazonRestrictedDataTokenRequest`

Returns¶

Promise\<AmazonRestrictedDataTokenResponse>

createSubscription()¶

createSubscription(input): Promise<AmazonNotificationSubscriptionResponse>;

Parameters¶

Parameter	Type
`input`	`AmazonCreateSubscriptionInput`

Returns¶

Promise\<AmazonNotificationSubscriptionResponse>

deleteSubscription()¶

deleteSubscription(input): Promise<Record<string, never>>;

Parameters¶

Parameter	Type
`input`	`AmazonDeleteSubscriptionInput`

Returns¶

Promise\<Record\<string, never>>

getDestination()¶

getDestination(destinationId): Promise<AmazonNotificationDestinationResponse>;

Parameters¶

Parameter	Type
`destinationId`	`string`

Returns¶

Promise\<AmazonNotificationDestinationResponse>

getDestinations()¶

getDestinations(): Promise<AmazonNotificationDestinationsResponse>;

Returns¶

Promise\<AmazonNotificationDestinationsResponse>

getMarketplaceParticipations()¶

getMarketplaceParticipations(input?): Promise<AmazonMarketplaceParticipationsResponse>;

Parameters¶

Parameter	Type
`input?`	{ `signal?`: `AbortSignal`; }
`input.signal?`	`AbortSignal`

Returns¶

Promise\<AmazonMarketplaceParticipationsResponse>

getOrder()¶

getOrder(amazonOrderId): Promise<AmazonOrderResponse<AmazonOrder>>;

Parameters¶

Parameter	Type
`amazonOrderId`	`string`

Returns¶

Promise\<AmazonOrderResponse\<AmazonOrder>>

getOrderBuyerInfo()¶

getOrderBuyerInfo(amazonOrderId): Promise<AmazonOrderResponse<AmazonOrder & {
  BuyerInfo?: AmazonBuyerInfo;
}>>;

Parameters¶

Parameter	Type
`amazonOrderId`	`string`

Returns¶

Promise\<AmazonOrderResponse\<AmazonOrder & { BuyerInfo?: AmazonBuyerInfo; }>>

getOrderItems()¶

getOrderItems(amazonOrderId, input?): Promise<AmazonOrderItemsResponse<AmazonOrderItem>>;

Parameters¶

Parameter	Type
`amazonOrderId`	`string`
`input?`	{ `nextToken?`: `string`; }
`input.nextToken?`	`string`

Returns¶

Promise\<AmazonOrderItemsResponse\<AmazonOrderItem>>

getOrderItemsBuyerInfo()¶

getOrderItemsBuyerInfo(amazonOrderId, input?): Promise<AmazonOrderItemsResponse<AmazonOrderItem & {
  BuyerInfo?: AmazonBuyerInfo;
}>>;

Parameters¶

Parameter	Type
`amazonOrderId`	`string`
`input?`	{ `nextToken?`: `string`; }
`input.nextToken?`	`string`

Returns¶

Promise\<AmazonOrderItemsResponse\<AmazonOrderItem & { BuyerInfo?: AmazonBuyerInfo; }>>

getOrders()¶

getOrders(input?): Promise<AmazonOrdersResponse<AmazonOrder>>;

Parameters¶

Parameter	Type
`input?`	`AmazonOrderSearchInput`

Returns¶

Promise\<AmazonOrdersResponse\<AmazonOrder>>

getOrderV2026()¶

getOrderV2026(amazonOrderId, input?): Promise<AmazonOrderResponse<AmazonOrder>>;

Parameters¶

Parameter	Type
`amazonOrderId`	`string`
`input?`	`AmazonOrdersV2026GetInput`

Returns¶

Promise\<AmazonOrderResponse\<AmazonOrder>>

getSolicitationActionsForOrder()¶

getSolicitationActionsForOrder(amazonOrderId, marketplaceIds?): Promise<AmazonSolicitationActionsResponse>;

Parameters¶

Parameter	Type
`amazonOrderId`	`string`
`marketplaceIds?`	`string`[]

Returns¶

Promise\<AmazonSolicitationActionsResponse>

getSubscription()¶

getSubscription(input): Promise<AmazonNotificationSubscriptionResponse>;

Parameters¶

Parameter	Type
`input`	`AmazonGetSubscriptionInput`

Returns¶

Promise\<AmazonNotificationSubscriptionResponse>

refreshAccessToken()¶

refreshAccessToken(): Promise<AmazonLwaTokenResponse>;

Returns¶

Promise\<AmazonLwaTokenResponse>

searchOrdersV2026()¶

searchOrdersV2026(input?): Promise<AmazonOrdersResponse<AmazonOrder>>;

Parameters¶

Parameter	Type
`input?`	`AmazonOrdersV2026SearchInput`

Returns¶

Promise\<AmazonOrdersResponse\<AmazonOrder>>

AmazonMarketplaceClientOptions¶

Extended by¶

AmazonLiveCheckOptions

Properties¶

accessToken?¶

optional accessToken?: string;

apiBaseUrl?¶

optional apiBaseUrl?: string;

aws?¶

optional aws?: AmazonAwsSigningOptions;

endpoint?¶

optional endpoint?: AmazonSpApiEndpoint;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

lwaClientId?¶

optional lwaClientId?: string;

lwaClientSecret?¶

optional lwaClientSecret?: string;

lwaTokenUrl?¶

optional lwaTokenUrl?: string;

marketplaceId?¶

optional marketplaceId?: string;

officialSdk?¶

optional officialSdk?: AmazonSpApiOfficialSdk;

refreshToken?¶

optional refreshToken?: string;

region?¶

optional region?: string;

restrictedDataToken?¶

optional restrictedDataToken?: string;

restrictedDataTokenProvider?¶

optional restrictedDataTokenProvider?: (input) =>
  | string
  | AmazonRestrictedDataTokenResponse
  | Promise<
  | string
| AmazonRestrictedDataTokenResponse>;

Parameters¶

Parameter	Type
`input`	`AmazonRestrictedDataTokenRequest`

Returns¶

restrictedDataTokenTargetApplication?¶

optional restrictedDataTokenTargetApplication?: string;

userAgent?¶

optional userAgent?: string;

AmazonMarketplaceJsonObject¶

Extended by¶

AmazonMarketplaceProviderExtensionFields
AmazonMarketplaceProviderResponse

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

AmazonMarketplaceParticipation¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

marketplace?¶

optional marketplace?: {
  countryCode?: string;
  defaultCurrencyCode?: string;
  defaultLanguageCode?: string;
  domainName?: string;
  id?: string;
  name?: string;
};

countryCode?¶

optional countryCode?: string;

defaultCurrencyCode?¶

optional defaultCurrencyCode?: string;

defaultLanguageCode?¶

optional defaultLanguageCode?: string;

domainName?¶

optional domainName?: string;

id?¶

optional id?: string;

name?¶

optional name?: string;

participation?¶

optional participation?: {
  hasSuspendedListings?: boolean;
  isParticipating?: boolean;
};

hasSuspendedListings?¶

optional hasSuspendedListings?: boolean;

isParticipating?¶

optional isParticipating?: boolean;

AmazonMarketplaceParticipationsResponse¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

errors?¶

optional errors?: AmazonSpApiError[];

payload?¶

optional payload?: AmazonMarketplaceParticipation[];

AmazonMarketplaceProviderExtensionFields¶

Extends¶

AmazonMarketplaceJsonObject

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

AmazonMarketplaceProviderResponse¶

Extends¶

AmazonMarketplaceJsonObject

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

AmazonMoney¶

Properties¶

Amount?¶

optional Amount?: string;

CurrencyCode?¶

optional CurrencyCode?: string;

AmazonNotificationDestination¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

destinationId?¶

optional destinationId?: string;

name?¶

optional name?: string;

resource?¶

optional resource?: {
[providerField: string]: AmazonMarketplaceProviderExtensionValue;
  eventBridge?: {
     accountId?: string;
     name?: string;
     region?: string;
  };
  sqs?: {
     arn?: string;
  };
};

Index Signature¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

eventBridge?¶

optional eventBridge?: {
  accountId?: string;
  name?: string;
  region?: string;
};

eventBridge.accountId?¶

optional accountId?: string;

eventBridge.name?¶

optional name?: string;

eventBridge.region?¶

optional region?: string;

sqs?¶

optional sqs?: {
  arn?: string;
};

sqs.arn?¶

optional arn?: string;

AmazonNotificationDestinationResponse¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

errors?¶

optional errors?: AmazonSpApiError[];

payload?¶

optional payload?: AmazonNotificationDestination;

AmazonNotificationDestinationsResponse¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

errors?¶

optional errors?: AmazonSpApiError[];

payload?¶

optional payload?: AmazonNotificationDestination[];

AmazonNotificationEnvelope¶

Properties¶

marketplaceId?¶

optional marketplaceId?: string;

notificationId?¶

optional notificationId?: string;

notificationType?¶

optional notificationType?: string;

payload¶

payload: unknown;

rawBody¶

rawBody: string;

sellerId?¶

optional sellerId?: string;

transport?¶

optional transport?: "direct" | "sns" | "sqs" | "eventbridge";

verifiedBy¶

verifiedBy: "signature" | "hook" | "shared-secret" | "unverified";

AmazonNotificationSubscription¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

destinationId?¶

optional destinationId?: string;

payloadVersion?¶

optional payloadVersion?: string;

processingDirective?¶

optional processingDirective?: AmazonMarketplaceJsonObject;

subscriptionId?¶

optional subscriptionId?: string;

AmazonNotificationSubscriptionResponse¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

errors?¶

optional errors?: AmazonSpApiError[];

payload?¶

optional payload?: AmazonNotificationSubscription;

AmazonOperationRequestInput¶

Properties¶

body?¶

optional body?: AmazonMarketplaceProviderPayload;

headers?¶

optional headers?: Record<string, string>;

pathParams?¶

optional pathParams?: Record<string, string | number | boolean>;

query?¶

optional query?: AmazonMarketplaceProviderQuery;

AmazonOrder¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

AmazonOrderId?¶

optional AmazonOrderId?: string;

BuyerInfo?¶

optional BuyerInfo?: AmazonBuyerInfo;

CbaDisplayableShippingLabel?¶

optional CbaDisplayableShippingLabel?: string;

EarliestDeliveryDate?¶

optional EarliestDeliveryDate?: string;

EarliestShipDate?¶

optional EarliestShipDate?: string;

EasyShipShipmentStatus?¶

optional EasyShipShipmentStatus?: string;

FulfillmentChannel?¶

optional FulfillmentChannel?:
  | string & {
}
  | "AFN"
  | "MFN";

IsBusinessOrder?¶

optional IsBusinessOrder?: boolean;

IsGlobalExpressEnabled?¶

optional IsGlobalExpressEnabled?: boolean;

IsPremiumOrder?¶

optional IsPremiumOrder?: boolean;

IsPrime?¶

optional IsPrime?: boolean;

IsReplacementOrder?¶

optional IsReplacementOrder?: boolean;

LastUpdateDate?¶

optional LastUpdateDate?: string;

LatestDeliveryDate?¶

optional LatestDeliveryDate?: string;

LatestShipDate?¶

optional LatestShipDate?: string;

MarketplaceId?¶

optional MarketplaceId?: string;

NumberOfItemsShipped?¶

optional NumberOfItemsShipped?: number;

NumberOfItemsUnshipped?¶

optional NumberOfItemsUnshipped?: number;

OrderChannel?¶

optional OrderChannel?: string;

OrderStatus?¶

optional OrderStatus?:
  | string & {
}
  | AmazonOrderStatus;

OrderTotal?¶

optional OrderTotal?: AmazonMoney;

OrderType?¶

optional OrderType?: string;

PaymentMethod?¶

optional PaymentMethod?: string;

PaymentMethodDetails?¶

optional PaymentMethodDetails?: string[];

PurchaseDate?¶

optional PurchaseDate?: string;

ReplacedOrderId?¶

optional ReplacedOrderId?: string;

SalesChannel?¶

optional SalesChannel?: string;

SellerOrderId?¶

optional SellerOrderId?: string;

ShipmentServiceLevelCategory?¶

optional ShipmentServiceLevelCategory?: string;

ShippingAddress?¶

optional ShippingAddress?: AmazonAddress;

ShipServiceLevel?¶

optional ShipServiceLevel?: string;

AmazonOrderItem¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

ASIN?¶

optional ASIN?: string;

BuyerInfo?¶

optional BuyerInfo?: AmazonBuyerInfo;

ConditionId?¶

optional ConditionId?: string;

ConditionNote?¶

optional ConditionNote?: string;

ConditionSubtypeId?¶

optional ConditionSubtypeId?: string;

ItemPrice?¶

optional ItemPrice?: AmazonMoney;

ItemTax?¶

optional ItemTax?: AmazonMoney;

OrderItemId?¶

optional OrderItemId?: string;

PointsGranted?¶

optional PointsGranted?: {
  PointsMonetaryValue?: AmazonMoney;
  PointsNumber?: number;
};

PointsMonetaryValue?¶

optional PointsMonetaryValue?: AmazonMoney;

PointsNumber?¶

optional PointsNumber?: number;

ProductInfo?¶

optional ProductInfo?: {
  NumberOfItems?: number;
};

NumberOfItems?¶

optional NumberOfItems?: number;

PromotionDiscount?¶

optional PromotionDiscount?: AmazonMoney;

QuantityOrdered?¶

optional QuantityOrdered?: number;

QuantityShipped?¶

optional QuantityShipped?: number;

SellerSKU?¶

optional SellerSKU?: string;

ShippingDiscount?¶

optional ShippingDiscount?: AmazonMoney;

ShippingPrice?¶

optional ShippingPrice?: AmazonMoney;

ShippingTax?¶

optional ShippingTax?: AmazonMoney;

Title?¶

optional Title?: string;

AmazonOrderItemsPayload¶

Type Parameters¶

Type Parameter	Default type
`TItem` extends `AmazonMarketplaceProviderExtensionValue`	`AmazonOrderItem`

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

AmazonOrderId?¶

optional AmazonOrderId?: string;

NextToken?¶

optional NextToken?: string;

OrderItems?¶

optional OrderItems?: TItem[];

AmazonOrderItemsResponse¶

Type Parameters¶

Type Parameter	Default type
`TItem` extends `AmazonMarketplaceProviderExtensionValue`	`AmazonOrderItem`

Properties¶

errors?¶

optional errors?: AmazonSpApiError[];

payload?¶

optional payload?: AmazonOrderItemsPayload<TItem>;

AmazonOrderPayload¶

Type Parameters¶

Type Parameter	Default type
`TOrder` extends `AmazonMarketplaceProviderExtensionValue`	`AmazonOrder`

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

Order?¶

optional Order?: TOrder;

AmazonOrderResponse¶

Type Parameters¶

Type Parameter	Default type
`TOrder` extends `AmazonMarketplaceProviderExtensionValue`	`AmazonOrder`

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

errors?¶

optional errors?: AmazonSpApiError[];

payload?¶

optional payload?: TOrder | AmazonOrderPayload<TOrder>;

AmazonOrderSearchInput¶

Properties¶

amazonOrderIds?¶

optional amazonOrderIds?: string[];

buyerEmail?¶

optional buyerEmail?: string;

createdAfter?¶

optional createdAfter?: string;

createdBefore?¶

optional createdBefore?: string;

easyShipShipmentStatuses?¶

optional easyShipShipmentStatuses?: string[];

electronicInvoiceStatuses?¶

optional electronicInvoiceStatuses?: string[];

fulfillmentChannels?¶

optional fulfillmentChannels?: string[];

lastUpdatedAfter?¶

optional lastUpdatedAfter?: string;

lastUpdatedBefore?¶

optional lastUpdatedBefore?: string;

marketplaceIds?¶

optional marketplaceIds?: string[];

maxResultsPerPage?¶

optional maxResultsPerPage?: number;

nextToken?¶

optional nextToken?: string;

orderStatuses?¶

optional orderStatuses?: string[];

paymentMethods?¶

optional paymentMethods?: string[];

sellerOrderId?¶

optional sellerOrderId?: string;

AmazonOrdersPayload¶

Type Parameters¶

Type Parameter	Default type
`TOrder` extends `AmazonMarketplaceProviderExtensionValue`	`AmazonOrder`

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

CreatedBefore?¶

optional CreatedBefore?: string;

LastUpdatedBefore?¶

optional LastUpdatedBefore?: string;

NextToken?¶

optional NextToken?: string;

Orders?¶

optional Orders?: TOrder[];

AmazonOrdersResponse¶

Extends¶

AmazonRestCollection\<TOrder>

Type Parameters¶

Type Parameter	Default type
`TOrder` extends `AmazonMarketplaceProviderExtensionValue`	`AmazonOrder`

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

errors?¶

optional errors?: AmazonSpApiError[];

Inherited from¶

AmazonRestCollection.errors

payload?¶

optional payload?: AmazonOrdersPayload<TOrder>;

Overrides¶

AmazonRestCollection.payload

AmazonOrdersV2026GetInput¶

Properties¶

includedData?¶

optional includedData?: AmazonOrdersIncludedData[];

AmazonOrdersV2026SearchInput¶

Properties¶

amazonOrderIds?¶

optional amazonOrderIds?: string[];

createdAfter?¶

optional createdAfter?: string;

createdBefore?¶

optional createdBefore?: string;

fulfilledBy?¶

optional fulfilledBy?:
  | string & {
}
  | "AMAZON"
  | "MERCHANT";

fulfillmentStatuses?¶

optional fulfillmentStatuses?: string[];

includedData?¶

optional includedData?: AmazonOrdersIncludedData[];

lastUpdatedAfter?¶

optional lastUpdatedAfter?: string;

lastUpdatedBefore?¶

optional lastUpdatedBefore?: string;

marketplaceIds?¶

optional marketplaceIds?: string[];

maxResultsPerPage?¶

optional maxResultsPerPage?: number;

paginationToken?¶

optional paginationToken?: string;

AmazonResource¶

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

AmazonRestCollection¶

Extended by¶

AmazonOrdersResponse

Type Parameters¶

Type Parameter	Default type
`TItem` extends `AmazonMarketplaceProviderExtensionValue`	`AmazonMarketplaceJsonObject`

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

errors?¶

optional errors?: AmazonSpApiError[];

payload?¶

optional payload?: {
[key: string]: AmazonMarketplaceProviderExtensionValue;
  NextToken?: string;
  OrderItems?: TItem[];
  Orders?: TItem[];
};

Index Signature¶

[key: string]: AmazonMarketplaceProviderExtensionValue

NextToken?¶

optional NextToken?: string;

OrderItems?¶

optional OrderItems?: TItem[];

Orders?¶

optional Orders?: TItem[];

AmazonRestrictedDataTokenRequest¶

Properties¶

restrictedResources¶

restrictedResources: AmazonRestrictedResource[];

targetApplication?¶

optional targetApplication?: string;

AmazonRestrictedDataTokenResponse¶

Indexable¶

[key: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

expiresIn?¶

optional expiresIn?: number;

restrictedDataToken?¶

optional restrictedDataToken?: string;

AmazonRestrictedResource¶

Properties¶

dataElements?¶

optional dataElements?: string[];

method¶

method: AmazonSpApiMethod;

path¶

path: string;

AmazonSolicitationActionsResponse¶

Indexable¶

[providerField: string]: AmazonMarketplaceProviderExtensionValue

Properties¶

_embedded?¶

optional _embedded?: AmazonMarketplaceJsonObject;

_links?¶

optional _links?: {
  actions?: {
     href?: string;
     name?: string;
  }[];
  self?: {
     href?: string;
  };
};

actions?¶

optional actions?: {
  href?: string;
  name?: string;
}[];

self?¶

optional self?: {
  href?: string;
};

self.href?¶

optional href?: string;

errors?¶

optional errors?: AmazonSpApiError[];

AmazonSpApiError¶

Properties¶

code?¶

optional code?: string;

details?¶

optional details?: string;

message?¶

optional message?: string;

AmazonSpApiOfficialSdk¶

Properties¶

NotificationsSpApi?¶

optional NotificationsSpApi?: {
  ApiClient: AmazonSpApiOfficialApiClientConstructor;
  NotificationsApi: (apiClient) => AmazonNotificationsSdkApi;
};

ApiClient¶

ApiClient: AmazonSpApiOfficialApiClientConstructor;

NotificationsApi¶

NotificationsApi: (apiClient) => AmazonNotificationsSdkApi;

Parameters¶

Parameter	Type
`apiClient`	`AmazonSpApiOfficialApiClient`

Returns¶

AmazonNotificationsSdkApi

Orders_v2026SpApi?¶

optional Orders_v2026SpApi?: {
  ApiClient: AmazonSpApiOfficialApiClientConstructor;
  GetOrderApi: (apiClient) => AmazonOrdersV2026GetSdkApi;
  SearchOrdersApi: (apiClient) => AmazonOrdersV2026SearchSdkApi;
};

ApiClient¶

ApiClient: AmazonSpApiOfficialApiClientConstructor;

GetOrderApi¶

GetOrderApi: (apiClient) => AmazonOrdersV2026GetSdkApi;

Parameters¶

Parameter	Type
`apiClient`	`AmazonSpApiOfficialApiClient`

Returns¶

AmazonOrdersV2026GetSdkApi

SearchOrdersApi¶

SearchOrdersApi: (apiClient) => AmazonOrdersV2026SearchSdkApi;

Parameters¶

Parameter	Type
`apiClient`	`AmazonSpApiOfficialApiClient`

Returns¶

AmazonOrdersV2026SearchSdkApi

OrdersSpApi?¶

optional OrdersSpApi?: {
  ApiClient: AmazonSpApiOfficialApiClientConstructor;
  OrdersV0Api: (apiClient) => AmazonOrdersV0SdkApi;
};

ApiClient¶

ApiClient: AmazonSpApiOfficialApiClientConstructor;

OrdersV0Api¶

OrdersV0Api: (apiClient) => AmazonOrdersV0SdkApi;

Parameters¶

Parameter	Type
`apiClient`	`AmazonSpApiOfficialApiClient`

Returns¶

AmazonOrdersV0SdkApi

SellersSpApi?¶

optional SellersSpApi?: {
  ApiClient: AmazonSpApiOfficialApiClientConstructor;
  SellersApi: (apiClient) => AmazonSellersSdkApi;
};

ApiClient¶

ApiClient: AmazonSpApiOfficialApiClientConstructor;

SellersApi¶

SellersApi: (apiClient) => AmazonSellersSdkApi;

Parameters¶

Parameter	Type
`apiClient`	`AmazonSpApiOfficialApiClient`

Returns¶

AmazonSellersSdkApi

SolicitationsSpApi?¶

optional SolicitationsSpApi?: {
  ApiClient: AmazonSpApiOfficialApiClientConstructor;
  SolicitationsApi: (apiClient) => AmazonSolicitationsSdkApi;
};

ApiClient¶

ApiClient: AmazonSpApiOfficialApiClientConstructor;

SolicitationsApi¶

SolicitationsApi: (apiClient) => AmazonSolicitationsSdkApi;

Parameters¶

Parameter	Type
`apiClient`	`AmazonSpApiOfficialApiClient`

Returns¶

AmazonSolicitationsSdkApi

TokensSpApi?¶

optional TokensSpApi?: {
  ApiClient: AmazonSpApiOfficialApiClientConstructor;
  TokensApi: (apiClient) => AmazonTokensSdkApi;
};

ApiClient¶

ApiClient: AmazonSpApiOfficialApiClientConstructor;

TokensApi¶

TokensApi: (apiClient) => AmazonTokensSdkApi;

Parameters¶

Parameter	Type
`apiClient`	`AmazonSpApiOfficialApiClient`

Returns¶

AmazonTokensSdkApi

ParseAmazonNotificationOptions¶

Properties¶

expectedSharedSecret?¶

optional expectedSharedSecret?: string;

expectedSignatureSecret?¶

optional expectedSignatureSecret?: string;

requireVerification?¶

optional requireVerification?: boolean;

sharedSecretHeaderName?¶

optional sharedSecretHeaderName?: string;

signatureHeaderName?¶

optional signatureHeaderName?: string;

verifyNotification?¶

optional verifyNotification?: (input) => boolean | Promise<boolean>;

Parameters¶

Parameter	Type
`input`	{ `headers`: `Headers`; `payload`: `unknown`; `rawBody`: `string`; }
`input.headers`	`Headers`
`input.payload`	`unknown`
`input.rawBody`	`string`

Returns¶

boolean | Promise\<boolean>

Type Aliases¶

AmazonKnownOperationUid¶

type AmazonKnownOperationUid = keyof AmazonKnownOperationRequestMap;

AmazonMarketplaceJsonPrimitive¶

type AmazonMarketplaceJsonPrimitive = string | number | boolean | null;

AmazonMarketplaceJsonValue¶

type AmazonMarketplaceJsonValue =
  | AmazonMarketplaceJsonPrimitive
  | AmazonMarketplaceJsonObject
  | readonly AmazonMarketplaceJsonValue[];

AmazonMarketplaceProviderExtensionValue¶

type AmazonMarketplaceProviderExtensionValue =
  | AmazonMarketplaceJsonValue
  | object
  | undefined;

AmazonMarketplaceProviderPayload¶

type AmazonMarketplaceProviderPayload = AmazonMarketplaceJsonObject | object;

AmazonMarketplaceProviderQuery¶

type AmazonMarketplaceProviderQuery = Record<string, AmazonMarketplaceProviderExtensionValue>;

AmazonOrdersIncludedData¶

type AmazonOrdersIncludedData =
  | "BUYER"
  | "RECIPIENT"
  | "FULFILLMENT"
  | "PROCEEDS"
  | "EXPENSE"
  | "PROMOTION"
  | "TAX"
  | "PAYMENT"
  | "CANCELLATION"
  | string & {
};

AmazonOrderStatus¶

type AmazonOrderStatus =
  | "Pending"
  | "Unshipped"
  | "PartiallyShipped"
  | "Shipped"
  | "Canceled"
  | "Unfulfillable"
  | "InvoiceUnconfirmed"
  | "PendingAvailability";

AmazonSpApiEndpoint¶

type AmazonSpApiEndpoint = "na" | "eu" | "fe";

AmazonSpApiMethod¶

type AmazonSpApiMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";

Variables¶

amazonMarketplaceIntegration¶

const amazonMarketplaceIntegration: DefinedIntegration<{
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "bidirectional"
     | "inbound-only"
    | "outbound-only")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official" | "community" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official" | "community" | "verified" | "experimental";
} & {
  capabilities: readonly [{
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "receive";
     description: "Parses SP-API notification payloads from SQS, EventBridge, or SDK-user webhooks after configured verification succeeds.";
     exposesSensitiveData: true;
     label: "Receive Amazon marketplace notifications";
     providerObjects: readonly [{
        kind: "amazonNotification";
        label: "Amazon Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Reads seller orders, order items, buyer information where authorized, solicitation metadata, seller participation, and notification configuration.";
     exposesSensitiveData: true;
     label: "Read Amazon marketplace records";
     providerObjects: readonly [{
        kind: "amazonOrder";
        label: "Amazon Order";
      }, {
        kind: "amazonOrderItem";
        label: "Amazon Order Item";
      }, {
        kind: "amazonBuyerInfo";
        label: "Amazon Buyer Info";
      }, {
        kind: "amazonSolicitation";
        label: "Amazon Solicitation";
      }, {
        kind: "amazonSellerAccount";
        label: "Amazon Seller Account";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "search-provider-object";
     description: "Searches orders and notification resources with SDK-user-supplied marketplace, date, status, and pagination filters.";
     exposesSensitiveData: true;
     label: "Search Amazon marketplace records";
     providerObjects: readonly [{
        kind: "amazonOrder";
        label: "Amazon Order";
      }, {
        kind: "amazonNotificationSubscription";
        label: "Amazon Notification Subscription";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     description: "Creates review/feedback solicitations and notification subscriptions only when the SDK user's marketplace policy allows outbound actions.";
     exposesSensitiveData: true;
     label: "Create Amazon support actions";
     providerObjects: readonly [{
        kind: "amazonSolicitation";
        label: "Amazon Solicitation";
      }, {
        kind: "amazonNotificationSubscription";
        label: "Amazon Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "delete-provider-object";
     changesWorkflow: true;
     description: "Deletes Amazon notification subscriptions only when the SDK user's marketplace policy allows subscription lifecycle changes.";
     exposesSensitiveData: true;
     label: "Delete Amazon support resources";
     providerObjects: readonly [{
        kind: "amazonNotificationSubscription";
        label: "Amazon Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "send";
     description: "Sends supported Solicitations API review/feedback requests chosen by the SDK user's workflow.";
     exposesSensitiveData: true;
     label: "Send Amazon buyer solicitations";
     providerObjects: readonly [{
        kind: "amazonSolicitation";
        label: "Amazon Solicitation";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.notification-signature";
     description: "Requires a SDK-user verifier, shared secret, or gateway signature policy before returning normalized Amazon notification payloads.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate Amazon notification ingress";
     providerObjects: readonly [{
        kind: "amazonVerifiedNotification";
        label: "Amazon Verified Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.sigv4";
     description: "Optionally signs SP-API REST requests with AWS SigV4 for SDK users that operate signed gateways or explicit authorization paths.";
     extension: true;
     label: "Sign Amazon SP-API requests";
     providerObjects: readonly [{
        kind: "amazonSignedRequest";
        label: "Amazon Signed Request";
     }];
     requiresCredential: true;
  }];
  category: "marketplace";
  channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "Amazon official SP-API JavaScript SDK";
        url: "https://github.com/amzn/selling-partner-api-sdk";
      }, {
        label: "Amazon prebuilt JavaScript SDK tutorial";
        url: "https://developer-docs.amazon.com/sp-api/docs/automate-your-sp-api-calls-using-a-prebuilt-javascript-sdk";
      }, {
        label: "Amazon SP-API Orders v0 reference";
        url: "https://developer-docs.amazon.com/sp-api/reference/orders-v0";
      }, {
        label: "Amazon SP-API Orders v2026-01-01 reference";
        url: "https://developer-docs.amazon.com/sp-api/reference/orders-v2026-01-01";
      }, {
        label: "Amazon SP-API Restricted Data Token";
        url: "https://developer-docs.amazon.com/sp-api/reference/createrestricteddatatoken";
      }, {
        label: "Amazon SP-API Notifications API";
        url: "https://developer-docs.amazon.com/sp-api/docs/notifications-api";
     }];
     notes: readonly ["Coverage is limited to Cognidesk marketplace support primitives, not full Amazon SP-API ownership.", "The official Amazon JavaScript SDK is the preferred raw-client escape hatch, but this package keeps local helpers for RDT and normalized support operations because the SDK README notes RDT requires an extra step.", "Manifest/runtime exports do not expose Cognidesk-generated full-provider SP-API clones.", "Orders v0 remains available for existing SDK callers while Amazon's removal window remains relevant; v2026 order helpers are exposed for migration flows."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     description: "Login with Amazon client ID and secret owned by the SDK user for SP-API token refresh.";
     id: "amazon-lwa-client";
     label: "Amazon LWA client credentials";
     required: true;
   }, {
     description: "Seller-authorized refresh/access token for role-gated SP-API calls, or grantless token material for Notifications API operations.";
     id: "amazon-lwa-token";
     label: "Amazon LWA refresh or access token";
     required: true;
   }, {
     description: "Optional IAM role/region and SigV4 material for SDK users who operate through signed gateway paths.";
     id: "amazon-aws-role-region";
     label: "Amazon SP-API AWS role and region";
     required: false;
   }, {
     description: "SDK-user-selected Amazon marketplace such as ATVPDKIKX0DER or A1PA6795UKMFR9.";
     id: "amazon-marketplace-id";
     label: "Amazon marketplace ID";
     required: true;
   }, {
     description: "Notifications API destination, SQS/EventBridge routing, and SDK-user webhook gateway metadata.";
     id: "amazon-notification-destination";
     label: "Amazon notification destination";
     required: true;
   }, {
     description: "SDK-user-provided verifier, shared secret, or gateway signature policy for fail-closed notification ingestion.";
     id: "amazon-notification-signature";
     label: "Amazon notification verification";
     required: true;
  }];
  directions: readonly ["receive-only", "send-only", "bidirectional"];
  id: "marketplace.amazon";
  limitations: readonly ["The SDK user chooses marketplaces, roles, restricted-data-token policy, notification topics, outbound solicitation rules, operator visibility, retention, consent, and redaction.", "Some SP-API operations require role approval, restricted data tokens, marketplace availability, or grantless authorization; this package exposes typed support foundations and does not decide seller eligibility.", "Amazon notification transports vary by destination; this package fails closed unless the SDK user configures a verifier, gateway signature, or shared-secret check appropriate to their ingress path."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     channelCoverage: {
        buyerInfoRdt: "typed-read-restricted";
        lwaTokenRefresh: "typed-token-refresh";
        notificationDestinations: "typed-read";
        notificationIngress: "typed-verify-parse";
        notificationSubscriptions: "typed-create-read-delete";
        orderItems: "typed-read";
        ordersV0: "typed-read-search";
        ordersV2026: "typed-read-search";
        rawSellingPartnerApi: "official-sdk-escape-hatch";
        restrictedDataTokens: "typed-create";
        sellerParticipation: "typed-read";
        sigv4Signing: "typed-sign";
        solicitations: "typed-read-create-send";
     };
     implementation: {
        caveats: readonly ["The npm package has no root types metadata; this package uses a local typed facade for raw SDK loading.", "RDT support remains local because the SDK README says some APIs need an extra RDT step."];
        sdkModifiedAt: "2026-05-29T13:03:51.597Z";
        sdkPackage: "@amazon-sp-api-release/amazon-sp-api-sdk-js";
        sdkRepository: "https://github.com/amzn/selling-partner-api-sdk";
        sdkVersionChecked: "1.9.0";
        strategy: "official-sdk-plus-support-slice";
     };
     supportSlice: {
        allowlist: (
           | "amazon.refreshAccessToken"
           | "amazon.createRestrictedDataToken"
           | "amazon.getOrders"
           | "amazon.getOrder"
           | "amazon.getOrderBuyerInfo"
           | "amazon.getOrderItems"
           | "amazon.getOrderItemsBuyerInfo"
           | "amazon.searchOrdersV2026"
           | "amazon.getOrderV2026"
           | "amazon.getSolicitationActionsForOrder"
           | "amazon.createProductReviewAndSellerFeedbackSolicitation"
           | "amazon.getMarketplaceParticipations"
           | "amazon.getDestinations"
           | "amazon.getDestination"
           | "amazon.createSubscription"
           | "amazon.getSubscription"
           | "amazon.deleteSubscription"
          | "amazon.parseNotificationWebhook")[];
        source: "local-reviewed-support-operations";
        verifiedAt: "2026-06-21";
     };
  };
  name: "Amazon Marketplace";
  operations: readonly [{
     alias: "amazon.refreshAccessToken";
     capability: "read-provider-object";
     extension: true;
     label: "Refresh Amazon LWA access token";
     providerOperation: "lwa.refreshAccessToken";
     requiresCredential: true;
   }, {
     alias: "amazon.createRestrictedDataToken";
     capability: "create-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Create Amazon restricted data token";
     providerOperation: "tokens.createRestrictedDataToken";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrders";
     capability: "search-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Search Amazon orders";
     providerOperation: "ordersV0.getOrders";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrder";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon order";
     providerOperation: "ordersV0.getOrder";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrderBuyerInfo";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon order buyer info";
     providerOperation: "ordersV0.getOrderBuyerInfo";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrderItems";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon order items";
     providerOperation: "ordersV0.getOrderItems";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrderItemsBuyerInfo";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon order item buyer info";
     providerOperation: "ordersV0.getOrderItemsBuyerInfo";
     requiresCredential: true;
   }, {
     alias: "amazon.searchOrdersV2026";
     capability: "search-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Search Amazon Orders v2026";
     providerOperation: "ordersV2026.searchOrders";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrderV2026";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon Orders v2026 order";
     providerOperation: "ordersV2026.getOrder";
     requiresCredential: true;
   }, {
     alias: "amazon.getSolicitationActionsForOrder";
     capability: "read-provider-object";
     extension: true;
     label: "Read Amazon solicitation actions";
     providerOperation: "solicitations.getActionsForOrder";
     requiresCredential: true;
   }, {
     alias: "amazon.createProductReviewAndSellerFeedbackSolicitation";
     capability: "send";
     changesWorkflow: true;
     extension: true;
     label: "Create Amazon review and seller feedback solicitation";
     providerOperation: "solicitations.createProductReviewAndSellerFeedback";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "amazon.getMarketplaceParticipations";
     capability: "read-provider-object";
     extension: true;
     label: "Read Amazon marketplace participations";
     providerOperation: "sellers.getMarketplaceParticipations";
     requiresCredential: true;
   }, {
     alias: "amazon.getDestinations";
     capability: "search-provider-object";
     extension: true;
     label: "List Amazon notification destinations";
     providerOperation: "notifications.getDestinations";
     requiresCredential: true;
   }, {
     alias: "amazon.getDestination";
     capability: "read-provider-object";
     extension: true;
     label: "Read Amazon notification destination";
     providerOperation: "notifications.getDestination";
     requiresCredential: true;
   }, {
     alias: "amazon.createSubscription";
     capability: "create-provider-object";
     changesWorkflow: true;
     extension: true;
     label: "Create Amazon notification subscription";
     providerOperation: "notifications.createSubscription";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "amazon.getSubscription";
     capability: "read-provider-object";
     extension: true;
     label: "Read Amazon notification subscription";
     providerOperation: "notifications.getSubscription";
     requiresCredential: true;
   }, {
     alias: "amazon.deleteSubscription";
     capability: "delete-provider-object";
     changesWorkflow: true;
     extension: true;
     label: "Delete Amazon notification subscription";
     providerOperation: "notifications.deleteSubscription";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "amazon.parseNotificationWebhook";
     capability: "receive";
     exposesSensitiveData: true;
     extension: true;
     label: "Parse Amazon notification webhook";
     providerOperation: "notifications.parseWebhook";
     requiresCredential: true;
  }];
  packageName: "@cognidesk/integration-marketplace-amazon";
  privacyNotes: readonly ["Amazon marketplace orders, order items, buyer information, seller account records, solicitations, and notifications can contain customer data, addresses, identifiers, and support context.", "LWA secrets, refresh tokens, access tokens, AWS role/signing material, notification shared secrets, and verifier logic stay server-side; Studio receives only readiness and capability metadata."];
  provider: "amazon";
  trustLevel: "official";
}, unknown, AmazonMarketplaceOperations>;

createAmazonIntegration¶

const createAmazonIntegration: typeof createAmazonMarketplaceIntegration;

createAmazonIntegrationOperationHandlers¶

const createAmazonIntegrationOperationHandlers: typeof createAmazonMarketplaceIntegrationOperationHandlers;

Functions¶

amazonMarketplaceCredentialStatuses()¶

function amazonMarketplaceCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`AmazonCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]

createAmazonMarketplaceClient()¶

function createAmazonMarketplaceClient(options): AmazonMarketplaceClient;

Parameters¶

Parameter	Type
`options`	`AmazonMarketplaceClientOptions`

Returns¶

AmazonMarketplaceClient

createAmazonMarketplaceIntegration()¶

function createAmazonMarketplaceIntegration(options?): DefinedIntegration<{
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "community" | "official" | "verified" | "experimental";
} & {
  capabilities: readonly [{
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "receive";
     description: "Parses SP-API notification payloads from SQS, EventBridge, or SDK-user webhooks after configured verification succeeds.";
     exposesSensitiveData: true;
     label: "Receive Amazon marketplace notifications";
     providerObjects: readonly [{
        kind: "amazonNotification";
        label: "Amazon Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Reads seller orders, order items, buyer information where authorized, solicitation metadata, seller participation, and notification configuration.";
     exposesSensitiveData: true;
     label: "Read Amazon marketplace records";
     providerObjects: readonly [{
        kind: "amazonOrder";
        label: "Amazon Order";
      }, {
        kind: "amazonOrderItem";
        label: "Amazon Order Item";
      }, {
        kind: "amazonBuyerInfo";
        label: "Amazon Buyer Info";
      }, {
        kind: "amazonSolicitation";
        label: "Amazon Solicitation";
      }, {
        kind: "amazonSellerAccount";
        label: "Amazon Seller Account";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "search-provider-object";
     description: "Searches orders and notification resources with SDK-user-supplied marketplace, date, status, and pagination filters.";
     exposesSensitiveData: true;
     label: "Search Amazon marketplace records";
     providerObjects: readonly [{
        kind: "amazonOrder";
        label: "Amazon Order";
      }, {
        kind: "amazonNotificationSubscription";
        label: "Amazon Notification Subscription";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     description: "Creates review/feedback solicitations and notification subscriptions only when the SDK user's marketplace policy allows outbound actions.";
     exposesSensitiveData: true;
     label: "Create Amazon support actions";
     providerObjects: readonly [{
        kind: "amazonSolicitation";
        label: "Amazon Solicitation";
      }, {
        kind: "amazonNotificationSubscription";
        label: "Amazon Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "delete-provider-object";
     changesWorkflow: true;
     description: "Deletes Amazon notification subscriptions only when the SDK user's marketplace policy allows subscription lifecycle changes.";
     exposesSensitiveData: true;
     label: "Delete Amazon support resources";
     providerObjects: readonly [{
        kind: "amazonNotificationSubscription";
        label: "Amazon Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "send";
     description: "Sends supported Solicitations API review/feedback requests chosen by the SDK user's workflow.";
     exposesSensitiveData: true;
     label: "Send Amazon buyer solicitations";
     providerObjects: readonly [{
        kind: "amazonSolicitation";
        label: "Amazon Solicitation";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.notification-signature";
     description: "Requires a SDK-user verifier, shared secret, or gateway signature policy before returning normalized Amazon notification payloads.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate Amazon notification ingress";
     providerObjects: readonly [{
        kind: "amazonVerifiedNotification";
        label: "Amazon Verified Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.sigv4";
     description: "Optionally signs SP-API REST requests with AWS SigV4 for SDK users that operate signed gateways or explicit authorization paths.";
     extension: true;
     label: "Sign Amazon SP-API requests";
     providerObjects: readonly [{
        kind: "amazonSignedRequest";
        label: "Amazon Signed Request";
     }];
     requiresCredential: true;
  }];
  category: "marketplace";
  channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "Amazon official SP-API JavaScript SDK";
        url: "https://github.com/amzn/selling-partner-api-sdk";
      }, {
        label: "Amazon prebuilt JavaScript SDK tutorial";
        url: "https://developer-docs.amazon.com/sp-api/docs/automate-your-sp-api-calls-using-a-prebuilt-javascript-sdk";
      }, {
        label: "Amazon SP-API Orders v0 reference";
        url: "https://developer-docs.amazon.com/sp-api/reference/orders-v0";
      }, {
        label: "Amazon SP-API Orders v2026-01-01 reference";
        url: "https://developer-docs.amazon.com/sp-api/reference/orders-v2026-01-01";
      }, {
        label: "Amazon SP-API Restricted Data Token";
        url: "https://developer-docs.amazon.com/sp-api/reference/createrestricteddatatoken";
      }, {
        label: "Amazon SP-API Notifications API";
        url: "https://developer-docs.amazon.com/sp-api/docs/notifications-api";
     }];
     notes: readonly ["Coverage is limited to Cognidesk marketplace support primitives, not full Amazon SP-API ownership.", "The official Amazon JavaScript SDK is the preferred raw-client escape hatch, but this package keeps local helpers for RDT and normalized support operations because the SDK README notes RDT requires an extra step.", "Manifest/runtime exports do not expose Cognidesk-generated full-provider SP-API clones.", "Orders v0 remains available for existing SDK callers while Amazon's removal window remains relevant; v2026 order helpers are exposed for migration flows."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     description: "Login with Amazon client ID and secret owned by the SDK user for SP-API token refresh.";
     id: "amazon-lwa-client";
     label: "Amazon LWA client credentials";
     required: true;
   }, {
     description: "Seller-authorized refresh/access token for role-gated SP-API calls, or grantless token material for Notifications API operations.";
     id: "amazon-lwa-token";
     label: "Amazon LWA refresh or access token";
     required: true;
   }, {
     description: "Optional IAM role/region and SigV4 material for SDK users who operate through signed gateway paths.";
     id: "amazon-aws-role-region";
     label: "Amazon SP-API AWS role and region";
     required: false;
   }, {
     description: "SDK-user-selected Amazon marketplace such as ATVPDKIKX0DER or A1PA6795UKMFR9.";
     id: "amazon-marketplace-id";
     label: "Amazon marketplace ID";
     required: true;
   }, {
     description: "Notifications API destination, SQS/EventBridge routing, and SDK-user webhook gateway metadata.";
     id: "amazon-notification-destination";
     label: "Amazon notification destination";
     required: true;
   }, {
     description: "SDK-user-provided verifier, shared secret, or gateway signature policy for fail-closed notification ingestion.";
     id: "amazon-notification-signature";
     label: "Amazon notification verification";
     required: true;
  }];
  directions: readonly ["receive-only", "send-only", "bidirectional"];
  id: "marketplace.amazon";
  limitations: readonly ["The SDK user chooses marketplaces, roles, restricted-data-token policy, notification topics, outbound solicitation rules, operator visibility, retention, consent, and redaction.", "Some SP-API operations require role approval, restricted data tokens, marketplace availability, or grantless authorization; this package exposes typed support foundations and does not decide seller eligibility.", "Amazon notification transports vary by destination; this package fails closed unless the SDK user configures a verifier, gateway signature, or shared-secret check appropriate to their ingress path."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     channelCoverage: {
        buyerInfoRdt: "typed-read-restricted";
        lwaTokenRefresh: "typed-token-refresh";
        notificationDestinations: "typed-read";
        notificationIngress: "typed-verify-parse";
        notificationSubscriptions: "typed-create-read-delete";
        orderItems: "typed-read";
        ordersV0: "typed-read-search";
        ordersV2026: "typed-read-search";
        rawSellingPartnerApi: "official-sdk-escape-hatch";
        restrictedDataTokens: "typed-create";
        sellerParticipation: "typed-read";
        sigv4Signing: "typed-sign";
        solicitations: "typed-read-create-send";
     };
     implementation: {
        caveats: readonly ["The npm package has no root types metadata; this package uses a local typed facade for raw SDK loading.", "RDT support remains local because the SDK README says some APIs need an extra RDT step."];
        sdkModifiedAt: "2026-05-29T13:03:51.597Z";
        sdkPackage: "@amazon-sp-api-release/amazon-sp-api-sdk-js";
        sdkRepository: "https://github.com/amzn/selling-partner-api-sdk";
        sdkVersionChecked: "1.9.0";
        strategy: "official-sdk-plus-support-slice";
     };
     supportSlice: {
        allowlist: (
           | "amazon.refreshAccessToken"
           | "amazon.createRestrictedDataToken"
           | "amazon.getOrders"
           | "amazon.getOrder"
           | "amazon.getOrderBuyerInfo"
           | "amazon.getOrderItems"
           | "amazon.getOrderItemsBuyerInfo"
           | "amazon.searchOrdersV2026"
           | "amazon.getOrderV2026"
           | "amazon.getSolicitationActionsForOrder"
           | "amazon.createProductReviewAndSellerFeedbackSolicitation"
           | "amazon.getMarketplaceParticipations"
           | "amazon.getDestinations"
           | "amazon.getDestination"
           | "amazon.createSubscription"
           | "amazon.getSubscription"
           | "amazon.deleteSubscription"
          | "amazon.parseNotificationWebhook")[];
        source: "local-reviewed-support-operations";
        verifiedAt: "2026-06-21";
     };
  };
  name: "Amazon Marketplace";
  operations: readonly [{
     alias: "amazon.refreshAccessToken";
     capability: "read-provider-object";
     extension: true;
     label: "Refresh Amazon LWA access token";
     providerOperation: "lwa.refreshAccessToken";
     requiresCredential: true;
   }, {
     alias: "amazon.createRestrictedDataToken";
     capability: "create-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Create Amazon restricted data token";
     providerOperation: "tokens.createRestrictedDataToken";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrders";
     capability: "search-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Search Amazon orders";
     providerOperation: "ordersV0.getOrders";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrder";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon order";
     providerOperation: "ordersV0.getOrder";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrderBuyerInfo";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon order buyer info";
     providerOperation: "ordersV0.getOrderBuyerInfo";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrderItems";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon order items";
     providerOperation: "ordersV0.getOrderItems";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrderItemsBuyerInfo";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon order item buyer info";
     providerOperation: "ordersV0.getOrderItemsBuyerInfo";
     requiresCredential: true;
   }, {
     alias: "amazon.searchOrdersV2026";
     capability: "search-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Search Amazon Orders v2026";
     providerOperation: "ordersV2026.searchOrders";
     requiresCredential: true;
   }, {
     alias: "amazon.getOrderV2026";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     extension: true;
     label: "Read Amazon Orders v2026 order";
     providerOperation: "ordersV2026.getOrder";
     requiresCredential: true;
   }, {
     alias: "amazon.getSolicitationActionsForOrder";
     capability: "read-provider-object";
     extension: true;
     label: "Read Amazon solicitation actions";
     providerOperation: "solicitations.getActionsForOrder";
     requiresCredential: true;
   }, {
     alias: "amazon.createProductReviewAndSellerFeedbackSolicitation";
     capability: "send";
     changesWorkflow: true;
     extension: true;
     label: "Create Amazon review and seller feedback solicitation";
     providerOperation: "solicitations.createProductReviewAndSellerFeedback";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "amazon.getMarketplaceParticipations";
     capability: "read-provider-object";
     extension: true;
     label: "Read Amazon marketplace participations";
     providerOperation: "sellers.getMarketplaceParticipations";
     requiresCredential: true;
   }, {
     alias: "amazon.getDestinations";
     capability: "search-provider-object";
     extension: true;
     label: "List Amazon notification destinations";
     providerOperation: "notifications.getDestinations";
     requiresCredential: true;
   }, {
     alias: "amazon.getDestination";
     capability: "read-provider-object";
     extension: true;
     label: "Read Amazon notification destination";
     providerOperation: "notifications.getDestination";
     requiresCredential: true;
   }, {
     alias: "amazon.createSubscription";
     capability: "create-provider-object";
     changesWorkflow: true;
     extension: true;
     label: "Create Amazon notification subscription";
     providerOperation: "notifications.createSubscription";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "amazon.getSubscription";
     capability: "read-provider-object";
     extension: true;
     label: "Read Amazon notification subscription";
     providerOperation: "notifications.getSubscription";
     requiresCredential: true;
   }, {
     alias: "amazon.deleteSubscription";
     capability: "delete-provider-object";
     changesWorkflow: true;
     extension: true;
     label: "Delete Amazon notification subscription";
     providerOperation: "notifications.deleteSubscription";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "amazon.parseNotificationWebhook";
     capability: "receive";
     exposesSensitiveData: true;
     extension: true;
     label: "Parse Amazon notification webhook";
     providerOperation: "notifications.parseWebhook";
     requiresCredential: true;
  }];
  packageName: "@cognidesk/integration-marketplace-amazon";
  privacyNotes: readonly ["Amazon marketplace orders, order items, buyer information, seller account records, solicitations, and notifications can contain customer data, addresses, identifiers, and support context.", "LWA secrets, refresh tokens, access tokens, AWS role/signing material, notification shared secrets, and verifier logic stay server-side; Studio receives only readiness and capability metadata."];
  provider: "amazon";
  trustLevel: "official";
}, unknown, AmazonMarketplaceOperations>;

Parameters¶

Parameter	Type
`options?`	`AmazonMarketplaceIntegrationOptions`

Returns¶

DefinedIntegration\<{ capabilities: { audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; label?: string; metadata?: Record\<string, unknown>; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; requiresCredential?: boolean; sideEffect?: boolean; }[]; category: string; channelAudiences: ("customer-facing" | "internal-support" | "mixed")[]; coverage: { evidence: { label: string; url?: string; }[]; notes: string[]; scope: | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"; }; credentialRequirements: { description?: string; id: string; label?: string; metadata?: Record\<string, unknown>; required: boolean; scopes: string[]; }[]; directions: ( | "receive-only" | "send-only" | "inbound-only" | "outbound-only" | "bidirectional")[]; id: string; limitations: string[]; maintainers: { name: string; type: "community" | "official" | "unknown" | "partner"; url?: string; }[]; metadata?: Record\<string, unknown>; name: string; operations: { alias: string; audience?: "customer-facing" | "internal-support" | "mixed"; audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension: boolean; externallyVisible?: boolean; inputSchema?: unknown; inputSchemaName?: string; inputSchemaRef?: string; label?: string; metadata?: Record\<string, unknown>; outputSchema?: unknown; outputSchemaName?: string; outputSchemaRef?: string; providerObject?: string; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; providerOperation?: string; requiredPolicyIds?: string[]; requiresApproval?: boolean; requiresCredential?: boolean; sideEffect?: boolean; }[]; packageName: string; privacyNotes: string[]; provider: string; trustLevel: "community" | "official" | "verified" | "experimental"; } & { capabilities: readonly [{ audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "receive"; description: "Parses SP-API notification payloads from SQS, EventBridge, or SDK-user webhooks after configured verification succeeds."; exposesSensitiveData: true; label: "Receive Amazon marketplace notifications"; providerObjects: readonly [{ kind: "amazonNotification"; label: "Amazon Notification"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "read-provider-object"; description: "Reads seller orders, order items, buyer information where authorized, solicitation metadata, seller participation, and notification configuration."; exposesSensitiveData: true; label: "Read Amazon marketplace records"; providerObjects: readonly [{ kind: "amazonOrder"; label: "Amazon Order"; }, { kind: "amazonOrderItem"; label: "Amazon Order Item"; }, { kind: "amazonBuyerInfo"; label: "Amazon Buyer Info"; }, { kind: "amazonSolicitation"; label: "Amazon Solicitation"; }, { kind: "amazonSellerAccount"; label: "Amazon Seller Account"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "search-provider-object"; description: "Searches orders and notification resources with SDK-user-supplied marketplace, date, status, and pagination filters."; exposesSensitiveData: true; label: "Search Amazon marketplace records"; providerObjects: readonly [{ kind: "amazonOrder"; label: "Amazon Order"; }, { kind: "amazonNotificationSubscription"; label: "Amazon Notification Subscription"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "create-provider-object"; changesWorkflow: true; description: "Creates review/feedback solicitations and notification subscriptions only when the SDK user's marketplace policy allows outbound actions."; exposesSensitiveData: true; label: "Create Amazon support actions"; providerObjects: readonly [{ kind: "amazonSolicitation"; label: "Amazon Solicitation"; }, { kind: "amazonNotificationSubscription"; label: "Amazon Notification Subscription"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "delete-provider-object"; changesWorkflow: true; description: "Deletes Amazon notification subscriptions only when the SDK user's marketplace policy allows subscription lifecycle changes."; exposesSensitiveData: true; label: "Delete Amazon support resources"; providerObjects: readonly [{ kind: "amazonNotificationSubscription"; label: "Amazon Notification Subscription"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "send"; description: "Sends supported Solicitations API review/feedback requests chosen by the SDK user's workflow."; exposesSensitiveData: true; label: "Send Amazon buyer solicitations"; providerObjects: readonly [{ kind: "amazonSolicitation"; label: "Amazon Solicitation"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support"]; capability: "marketplace.notification-signature"; description: "Requires a SDK-user verifier, shared secret, or gateway signature policy before returning normalized Amazon notification payloads."; exposesSensitiveData: true; extension: true; label: "Validate Amazon notification ingress"; providerObjects: readonly [{ kind: "amazonVerifiedNotification"; label: "Amazon Verified Notification"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support"]; capability: "marketplace.sigv4"; description: "Optionally signs SP-API REST requests with AWS SigV4 for SDK users that operate signed gateways or explicit authorization paths."; extension: true; label: "Sign Amazon SP-API requests"; providerObjects: readonly [{ kind: "amazonSignedRequest"; label: "Amazon Signed Request"; }]; requiresCredential: true; }]; category: "marketplace"; channelAudiences: readonly ["customer-facing", "internal-support", "mixed"]; coverage: { evidence: readonly [{ label: "Amazon official SP-API JavaScript SDK"; url: "https://github.com/amzn/selling-partner-api-sdk"; }, { label: "Amazon prebuilt JavaScript SDK tutorial"; url: "https://developer-docs.amazon.com/sp-api/docs/automate-your-sp-api-calls-using-a-prebuilt-javascript-sdk"; }, { label: "Amazon SP-API Orders v0 reference"; url: "https://developer-docs.amazon.com/sp-api/reference/orders-v0"; }, { label: "Amazon SP-API Orders v2026-01-01 reference"; url: "https://developer-docs.amazon.com/sp-api/reference/orders-v2026-01-01"; }, { label: "Amazon SP-API Restricted Data Token"; url: "https://developer-docs.amazon.com/sp-api/reference/createrestricteddatatoken"; }, { label: "Amazon SP-API Notifications API"; url: "https://developer-docs.amazon.com/sp-api/docs/notifications-api"; }]; notes: readonly ["Coverage is limited to Cognidesk marketplace support primitives, not full Amazon SP-API ownership.", "The official Amazon JavaScript SDK is the preferred raw-client escape hatch, but this package keeps local helpers for RDT and normalized support operations because the SDK README notes RDT requires an extra step.", "Manifest/runtime exports do not expose Cognidesk-generated full-provider SP-API clones.", "Orders v0 remains available for existing SDK callers while Amazon's removal window remains relevant; v2026 order helpers are exposed for migration flows."]; scope: "support-workflow-subset"; }; credentialRequirements: readonly [{ description: "Login with Amazon client ID and secret owned by the SDK user for SP-API token refresh."; id: "amazon-lwa-client"; label: "Amazon LWA client credentials"; required: true; }, { description: "Seller-authorized refresh/access token for role-gated SP-API calls, or grantless token material for Notifications API operations."; id: "amazon-lwa-token"; label: "Amazon LWA refresh or access token"; required: true; }, { description: "Optional IAM role/region and SigV4 material for SDK users who operate through signed gateway paths."; id: "amazon-aws-role-region"; label: "Amazon SP-API AWS role and region"; required: false; }, { description: "SDK-user-selected Amazon marketplace such as ATVPDKIKX0DER or A1PA6795UKMFR9."; id: "amazon-marketplace-id"; label: "Amazon marketplace ID"; required: true; }, { description: "Notifications API destination, SQS/EventBridge routing, and SDK-user webhook gateway metadata."; id: "amazon-notification-destination"; label: "Amazon notification destination"; required: true; }, { description: "SDK-user-provided verifier, shared secret, or gateway signature policy for fail-closed notification ingestion."; id: "amazon-notification-signature"; label: "Amazon notification verification"; required: true; }]; directions: readonly ["receive-only", "send-only", "bidirectional"]; id: "marketplace.amazon"; limitations: readonly ["The SDK user chooses marketplaces, roles, restricted-data-token policy, notification topics, outbound solicitation rules, operator visibility, retention, consent, and redaction.", "Some SP-API operations require role approval, restricted data tokens, marketplace availability, or grantless authorization; this package exposes typed support foundations and does not decide seller eligibility.", "Amazon notification transports vary by destination; this package fails closed unless the SDK user configures a verifier, gateway signature, or shared-secret check appropriate to their ingress path."]; maintainers: readonly [{ name: "Cognidesk"; type: "official"; }]; metadata: { channelCoverage: { buyerInfoRdt: "typed-read-restricted"; lwaTokenRefresh: "typed-token-refresh"; notificationDestinations: "typed-read"; notificationIngress: "typed-verify-parse"; notificationSubscriptions: "typed-create-read-delete"; orderItems: "typed-read"; ordersV0: "typed-read-search"; ordersV2026: "typed-read-search"; rawSellingPartnerApi: "official-sdk-escape-hatch"; restrictedDataTokens: "typed-create"; sellerParticipation: "typed-read"; sigv4Signing: "typed-sign"; solicitations: "typed-read-create-send"; }; implementation: { caveats: readonly ["The npm package has no root types metadata; this package uses a local typed facade for raw SDK loading.", "RDT support remains local because the SDK README says some APIs need an extra RDT step."]; sdkModifiedAt: "2026-05-29T13:03:51.597Z"; sdkPackage: "@amazon-sp-api-release/amazon-sp-api-sdk-js"; sdkRepository: "https://github.com/amzn/selling-partner-api-sdk"; sdkVersionChecked: "1.9.0"; strategy: "official-sdk-plus-support-slice"; }; supportSlice: { allowlist: ( | "amazon.refreshAccessToken" | "amazon.createRestrictedDataToken" | "amazon.getOrders" | "amazon.getOrder" | "amazon.getOrderBuyerInfo" | "amazon.getOrderItems" | "amazon.getOrderItemsBuyerInfo" | "amazon.searchOrdersV2026" | "amazon.getOrderV2026" | "amazon.getSolicitationActionsForOrder" | "amazon.createProductReviewAndSellerFeedbackSolicitation" | "amazon.getMarketplaceParticipations" | "amazon.getDestinations" | "amazon.getDestination" | "amazon.createSubscription" | "amazon.getSubscription" | "amazon.deleteSubscription" | "amazon.parseNotificationWebhook")[]; source: "local-reviewed-support-operations"; verifiedAt: "2026-06-21"; }; }; name: "Amazon Marketplace"; operations: readonly [{ alias: "amazon.refreshAccessToken"; capability: "read-provider-object"; extension: true; label: "Refresh Amazon LWA access token"; providerOperation: "lwa.refreshAccessToken"; requiresCredential: true; }, { alias: "amazon.createRestrictedDataToken"; capability: "create-provider-object"; exposesSensitiveData: true; extension: true; label: "Create Amazon restricted data token"; providerOperation: "tokens.createRestrictedDataToken"; requiresCredential: true; }, { alias: "amazon.getOrders"; capability: "search-provider-object"; exposesSensitiveData: true; extension: true; label: "Search Amazon orders"; providerOperation: "ordersV0.getOrders"; requiresCredential: true; }, { alias: "amazon.getOrder"; capability: "read-provider-object"; exposesSensitiveData: true; extension: true; label: "Read Amazon order"; providerOperation: "ordersV0.getOrder"; requiresCredential: true; }, { alias: "amazon.getOrderBuyerInfo"; capability: "read-provider-object"; exposesSensitiveData: true; extension: true; label: "Read Amazon order buyer info"; providerOperation: "ordersV0.getOrderBuyerInfo"; requiresCredential: true; }, { alias: "amazon.getOrderItems"; capability: "read-provider-object"; exposesSensitiveData: true; extension: true; label: "Read Amazon order items"; providerOperation: "ordersV0.getOrderItems"; requiresCredential: true; }, { alias: "amazon.getOrderItemsBuyerInfo"; capability: "read-provider-object"; exposesSensitiveData: true; extension: true; label: "Read Amazon order item buyer info"; providerOperation: "ordersV0.getOrderItemsBuyerInfo"; requiresCredential: true; }, { alias: "amazon.searchOrdersV2026"; capability: "search-provider-object"; exposesSensitiveData: true; extension: true; label: "Search Amazon Orders v2026"; providerOperation: "ordersV2026.searchOrders"; requiresCredential: true; }, { alias: "amazon.getOrderV2026"; capability: "read-provider-object"; exposesSensitiveData: true; extension: true; label: "Read Amazon Orders v2026 order"; providerOperation: "ordersV2026.getOrder"; requiresCredential: true; }, { alias: "amazon.getSolicitationActionsForOrder"; capability: "read-provider-object"; extension: true; label: "Read Amazon solicitation actions"; providerOperation: "solicitations.getActionsForOrder"; requiresCredential: true; }, { alias: "amazon.createProductReviewAndSellerFeedbackSolicitation"; capability: "send"; changesWorkflow: true; extension: true; label: "Create Amazon review and seller feedback solicitation"; providerOperation: "solicitations.createProductReviewAndSellerFeedback"; requiresCredential: true; sideEffect: true; }, { alias: "amazon.getMarketplaceParticipations"; capability: "read-provider-object"; extension: true; label: "Read Amazon marketplace participations"; providerOperation: "sellers.getMarketplaceParticipations"; requiresCredential: true; }, { alias: "amazon.getDestinations"; capability: "search-provider-object"; extension: true; label: "List Amazon notification destinations"; providerOperation: "notifications.getDestinations"; requiresCredential: true; }, { alias: "amazon.getDestination"; capability: "read-provider-object"; extension: true; label: "Read Amazon notification destination"; providerOperation: "notifications.getDestination"; requiresCredential: true; }, { alias: "amazon.createSubscription"; capability: "create-provider-object"; changesWorkflow: true; extension: true; label: "Create Amazon notification subscription"; providerOperation: "notifications.createSubscription"; requiresCredential: true; sideEffect: true; }, { alias: "amazon.getSubscription"; capability: "read-provider-object"; extension: true; label: "Read Amazon notification subscription"; providerOperation: "notifications.getSubscription"; requiresCredential: true; }, { alias: "amazon.deleteSubscription"; capability: "delete-provider-object"; changesWorkflow: true; extension: true; label: "Delete Amazon notification subscription"; providerOperation: "notifications.deleteSubscription"; requiresCredential: true; sideEffect: true; }, { alias: "amazon.parseNotificationWebhook"; capability: "receive"; exposesSensitiveData: true; extension: true; label: "Parse Amazon notification webhook"; providerOperation: "notifications.parseWebhook"; requiresCredential: true; }]; packageName: "@cognidesk/integration-marketplace-amazon"; privacyNotes: readonly ["Amazon marketplace orders, order items, buyer information, seller account records, solicitations, and notifications can contain customer data, addresses, identifiers, and support context.", "LWA secrets, refresh tokens, access tokens, AWS role/signing material, notification shared secrets, and verifier logic stay server-side; Studio receives only readiness and capability metadata."]; provider: "amazon"; trustLevel: "official"; }, unknown, AmazonMarketplaceOperations>

createAmazonMarketplaceIntegrationOperationHandlers()¶

function createAmazonMarketplaceIntegrationOperationHandlers(options?): AmazonMarketplaceOperations;

Parameters¶

Parameter	Type
`options?`	`AmazonMarketplaceIntegrationOptions`

Returns¶

AmazonMarketplaceOperations

createAmazonMarketplaceLiveChecks()¶

function createAmazonMarketplaceLiveChecks(options): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        marketplaceId: string;
        participations: string | number;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options`	`AmazonLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { marketplaceId: string; participations: string | number; }; }>; }[]

createAmazonRestrictedDataToken()¶

function createAmazonRestrictedDataToken(options, input): Promise<AmazonRestrictedDataTokenResponse>;

Parameters¶

Parameter	Type
`options`	`AmazonMarketplaceClientOptions`
`input`	`AmazonRestrictedDataTokenRequest`

Returns¶

Promise\<AmazonRestrictedDataTokenResponse>

createAmazonSpApiOfficialSdkApis()¶

function createAmazonSpApiOfficialSdkApis(options): AmazonSpApiOfficialSdkApis;

Parameters¶

Parameter	Type
`options`	`AmazonMarketplaceClientOptions`

Returns¶

AmazonSpApiOfficialSdkApis

getAmazonSpApiOfficialSdk()¶

function getAmazonSpApiOfficialSdk(): AmazonSpApiOfficialSdk;

Returns¶

AmazonSpApiOfficialSdk

loadAmazonSpApiOfficialSdk()¶

function loadAmazonSpApiOfficialSdk(): Promise<AmazonSpApiOfficialSdk>;

Returns¶

Promise\<AmazonSpApiOfficialSdk>

parseAmazonMarketplaceNotificationWebhook()¶

function parseAmazonMarketplaceNotificationWebhook(request, options?): Promise<AmazonNotificationEnvelope>;

Parameters¶

Parameter	Type
`request`	`Request`
`options?`	`ParseAmazonNotificationOptions`

Returns¶

Promise\<AmazonNotificationEnvelope>

refreshAmazonLwaAccessToken()¶

function refreshAmazonLwaAccessToken(options): Promise<AmazonLwaTokenResponse>;

Parameters¶

Parameter	Type
`options`	`Pick`\<`AmazonMarketplaceClientOptions`, \| `"refreshToken"` \| `"lwaClientId"` \| `"lwaClientSecret"` \| `"lwaTokenUrl"` \| `"fetch"`>

Returns¶

Promise\<AmazonLwaTokenResponse>

signAmazonSpApiRequest()¶

function signAmazonSpApiRequest(input): Record<string, string>;

Parameters¶

Parameter	Type
`input`	{ `accessKeyId`: `string`; `body?`: `string`; `headers?`: `Record`\<`string`, `string`>; `method`: `string`; `now?`: `Date`; `region`: `string`; `secretAccessKey`: `string`; `service?`: `string`; `sessionToken?`: `string`; `url`: `string`; }
`input.accessKeyId`	`string`
`input.body?`	`string`
`input.headers?`	`Record`\<`string`, `string`>
`input.method`	`string`
`input.now?`	`Date`
`input.region`	`string`
`input.secretAccessKey`	`string`
`input.service?`	`string`
`input.sessionToken?`	`string`
`input.url`	`string`

Returns¶

Record\<string, string>

unwrapAmazonNotificationPayload()¶

function unwrapAmazonNotificationPayload(payload): unknown;

Parameters¶

Parameter	Type
`payload`	`unknown`

Returns¶

unknown

References¶

amazonMarketplaceOperationAliases¶

Re-exports amazonMarketplaceOperationAliases

amazonMarketplaceProviderManifest¶

Re-exports amazonMarketplaceProviderManifest