integrations/marketplace/ebay/dist

Interfaces

EbayAmount

Properties

currency?

optional currency?: string;

value?

optional value?: string;

---

EbayBulkUpdateConversationsInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations

conversations: EbayMarketplaceJsonObject[];

---

EbayConversation

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

conversationId?

optional conversationId?: string;

creationDate?

optional creationDate?: string;

lastModifiedDate?

optional lastModifiedDate?: string;

messages?

optional messages?: EbayMarketplaceJsonObject[];

status?

optional status?: string;

---

EbayConversationsCollection

Extends

• EbayRestCollection\<EbayConversation>

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations?

optional conversations?: EbayConversation[];

Overrides

EbayRestCollection.conversations

href?

optional href?: string;

Inherited from

EbayRestCollection.href

limit?

optional limit?: number;

Inherited from

EbayRestCollection.limit

offset?

optional offset?: number;

Inherited from

EbayRestCollection.offset

orders?

optional orders?: EbayConversation[];

Inherited from

EbayRestCollection.orders

paymentDisputeSummaries?

optional paymentDisputeSummaries?: EbayConversation[];

Inherited from

EbayRestCollection.paymentDisputeSummaries

total?

optional total?: number;

Inherited from

EbayRestCollection.total

---

EbayConversationSearchInput

Properties

filter?

optional filter?: string | string[];

limit?

optional limit?: number;

offset?

optional offset?: number;

---

EbayCreateSigningKeyInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

signingKeyCipher?

optional signingKeyCipher?: string;

---

EbayCredentialStatusInput

Properties

accessTokenConfigured?

optional accessTokenConfigured?: boolean;

applicationAccessTokenConfigured?

optional applicationAccessTokenConfigured?: boolean;

clientIdConfigured?

optional clientIdConfigured?: boolean;

clientSecretConfigured?

optional clientSecretConfigured?: boolean;

digitalSignatureConfigured?

optional digitalSignatureConfigured?: boolean;

expiresAt?

optional expiresAt?: string;

marketplaceId?

optional marketplaceId?: string;

notificationVerificationTokenConfigured?

optional notificationVerificationTokenConfigured?: boolean;

providerClientConfigured?

optional providerClientConfigured?: boolean;

requireDigitalSignatureForRefunds?

optional requireDigitalSignatureForRefunds?: boolean;

scopes?

optional scopes?: string[];

sellerDomicileCountry?

optional sellerDomicileCountry?: string;

---

EbayDigitalSignatureOptions

Properties

algorithm?

optional algorithm?: "rsa-v1_5-sha256";

created?

optional created?: number;

privateKey

privateKey: string;

publicKeyJwe

publicKeyJwe: string;

---

EbayIssueRefundInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

comment?

optional comment?: string;

reasonForRefund

reasonForRefund: string;

refundItems?

optional refundItems?: EbayMarketplaceJsonObject[];

---

EbayLiveCheckOptions

Extends

• EbayMarketplaceClientOptions

Properties

accessToken?

optional accessToken?: string;

Inherited from

EbayMarketplaceClientOptions.accessToken

applicationAccessToken?

optional applicationAccessToken?: string;

Inherited from

EbayMarketplaceClientOptions.applicationAccessToken

baseUrl?

optional baseUrl?: string;

Inherited from

EbayMarketplaceClientOptions.baseUrl

client?

optional client?: Pick<EbayMarketplaceProviderClient, "getUser">;

environment?

optional environment?: "sandbox" | "production";

Inherited from

EbayMarketplaceClientOptions.environment

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

EbayMarketplaceClientOptions.fetch

marketplaceId?

optional marketplaceId?: string;

Inherited from

EbayMarketplaceClientOptions.marketplaceId

providerClient?

optional providerClient?: EbayMarketplaceProviderClient;

Inherited from

EbayMarketplaceClientOptions.providerClient

requestSigner?

optional requestSigner?: EbayRequestSigner;

Inherited from

EbayMarketplaceClientOptions.requestSigner

retry?

optional retry?:
  | number
  | ProviderJsonRetryOptions;

Inherited from

EbayMarketplaceClientOptions.retry

signal?

optional signal?: AbortSignal;

Inherited from

EbayMarketplaceClientOptions.signal

timeoutMs?

optional timeoutMs?: number;

Inherited from

EbayMarketplaceClientOptions.timeoutMs

---

EbayMarketplaceClient

Extends

• EbayMarketplaceProviderClient

Properties

providerClient

providerClient: EbayMarketplaceProviderClient;

Methods

acceptPaymentDispute()

acceptPaymentDispute(paymentDisputeId, input?): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input?	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

Inherited from

EbayMarketplaceProviderClient.acceptPaymentDispute

addPaymentDisputeEvidence()

addPaymentDisputeEvidence(paymentDisputeId, input): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

Inherited from

EbayMarketplaceProviderClient.addPaymentDisputeEvidence

bulkUpdateConversations()

bulkUpdateConversations(input): Promise<{
[providerField: string]: EbayMarketplaceJsonValue;
  conversations?: EbayConversation[];
}>;

Parameters

Parameter	Type
input	EbayBulkUpdateConversationsInput

Returns

Promise\<{ [providerField: string]: EbayMarketplaceJsonValue; conversations?: EbayConversation[]; }>

Inherited from

EbayMarketplaceProviderClient.bulkUpdateConversations

contestPaymentDispute()

contestPaymentDispute(paymentDisputeId, input): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

Inherited from

EbayMarketplaceProviderClient.contestPaymentDispute

createNotificationDestination()

createNotificationDestination(input): Promise<EbayNotificationDestination>;

Parameters

Parameter	Type
input	EbayNotificationDestinationInput

Returns

Promise\<EbayNotificationDestination>

Inherited from

EbayMarketplaceProviderClient.createNotificationDestination

createNotificationSubscription()

createNotificationSubscription(input): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
input	EbayNotificationSubscriptionInput

Returns

Promise\<EbayNotificationSubscription>

Inherited from

EbayMarketplaceProviderClient.createNotificationSubscription

createNotificationSubscriptionFilter()

createNotificationSubscriptionFilter(subscriptionId, input): Promise<EbayNotificationSubscriptionFilter>;

Parameters

Parameter	Type
subscriptionId	string
input	EbayNotificationSubscriptionFilterInput

Returns

Promise\<EbayNotificationSubscriptionFilter>

Inherited from

EbayMarketplaceProviderClient.createNotificationSubscriptionFilter

createShippingFulfillment()

createShippingFulfillment(orderId, input): Promise<EbayShippingFulfillment>;

Parameters

Parameter	Type
orderId	string
input	EbayShippingFulfillmentInput

Returns

Promise\<EbayShippingFulfillment>

Inherited from

EbayMarketplaceProviderClient.createShippingFulfillment

createSigningKey()

createSigningKey(input?): Promise<EbaySigningKey>;

Parameters

Parameter	Type
input?	EbayCreateSigningKeyInput

Returns

Promise\<EbaySigningKey>

Inherited from

EbayMarketplaceProviderClient.createSigningKey

deleteNotificationDestination()

deleteNotificationDestination(destinationId): Promise<Record<string, never>>;

Parameters

Parameter	Type
destinationId	string

Returns

Promise\<Record\<string, never>>

Inherited from

EbayMarketplaceProviderClient.deleteNotificationDestination

deleteNotificationSubscription()

deleteNotificationSubscription(subscriptionId): Promise<Record<string, never>>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<Record\<string, never>>

Inherited from

EbayMarketplaceProviderClient.deleteNotificationSubscription

deleteNotificationSubscriptionFilter()

deleteNotificationSubscriptionFilter(subscriptionId, filterId): Promise<Record<string, never>>;

Parameters

Parameter	Type
subscriptionId	string
filterId	string

Returns

Promise\<Record\<string, never>>

Inherited from

EbayMarketplaceProviderClient.deleteNotificationSubscriptionFilter

disableNotificationSubscription()

disableNotificationSubscription(subscriptionId): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<EbayNotificationSubscription>

Inherited from

EbayMarketplaceProviderClient.disableNotificationSubscription

enableNotificationSubscription()

enableNotificationSubscription(subscriptionId): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<EbayNotificationSubscription>

Inherited from

EbayMarketplaceProviderClient.enableNotificationSubscription

fetchPaymentDisputeEvidenceContent()

fetchPaymentDisputeEvidenceContent(paymentDisputeId): Promise<ArrayBuffer | EbayMarketplaceJsonObject>;

Parameters

Parameter	Type
paymentDisputeId	string

Returns

Promise\<ArrayBuffer | EbayMarketplaceJsonObject>

Inherited from

EbayMarketplaceProviderClient.fetchPaymentDisputeEvidenceContent

getConversation()

getConversation(conversationId): Promise<EbayConversation>;

Parameters

Parameter	Type
conversationId	string

Returns

Promise\<EbayConversation>

Inherited from

EbayMarketplaceProviderClient.getConversation

getConversations()

getConversations(input?): Promise<EbayConversationsCollection>;

Parameters

Parameter	Type
input?	EbayConversationSearchInput

Returns

Promise\<EbayConversationsCollection>

Inherited from

EbayMarketplaceProviderClient.getConversations

getNotificationConfig()

getNotificationConfig(): Promise<EbayNotificationConfig>;

Returns

Promise\<EbayNotificationConfig>

Inherited from

EbayMarketplaceProviderClient.getNotificationConfig

getNotificationDestination()

getNotificationDestination(destinationId): Promise<EbayNotificationDestination>;

Parameters

Parameter	Type
destinationId	string

Returns

Promise\<EbayNotificationDestination>

Inherited from

EbayMarketplaceProviderClient.getNotificationDestination

getNotificationDestinations()

getNotificationDestinations(): Promise<EbayNotificationDestinationsCollection>;

Returns

Promise\<EbayNotificationDestinationsCollection>

Inherited from

EbayMarketplaceProviderClient.getNotificationDestinations

getNotificationPublicKey()

getNotificationPublicKey(publicKeyId): Promise<EbayNotificationPublicKey>;

Parameters

Parameter	Type
publicKeyId	string

Returns

Promise\<EbayNotificationPublicKey>

Inherited from

EbayMarketplaceProviderClient.getNotificationPublicKey

getNotificationSubscription()

getNotificationSubscription(subscriptionId): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<EbayNotificationSubscription>

Inherited from

EbayMarketplaceProviderClient.getNotificationSubscription

getNotificationSubscriptionFilter()

getNotificationSubscriptionFilter(subscriptionId, filterId): Promise<EbayNotificationSubscriptionFilter>;

Parameters

Parameter	Type
subscriptionId	string
filterId	string

Returns

Promise\<EbayNotificationSubscriptionFilter>

Inherited from

EbayMarketplaceProviderClient.getNotificationSubscriptionFilter

getNotificationSubscriptions()

getNotificationSubscriptions(): Promise<EbayNotificationSubscriptionsCollection>;

Returns

Promise\<EbayNotificationSubscriptionsCollection>

Inherited from

EbayMarketplaceProviderClient.getNotificationSubscriptions

getNotificationTopic()

getNotificationTopic(topicId): Promise<{
[providerField: string]: EbayMarketplaceJsonValue;
  description?: string;
  supportedPayloadVersions?: string[];
  topicId?: string;
}>;

Parameters

Parameter	Type
topicId	string

Returns

Promise\<{ [providerField: string]: EbayMarketplaceJsonValue; description?: string; supportedPayloadVersions?: string[]; topicId?: string; }>

Inherited from

EbayMarketplaceProviderClient.getNotificationTopic

getNotificationTopics()

getNotificationTopics(input?): Promise<EbayRestCollection<EbayMarketplaceJsonObject>>;

Parameters

Parameter	Type
input?	EbayNotificationTopicSearchInput

Returns

Promise\<EbayRestCollection\<EbayMarketplaceJsonObject>>

Inherited from

EbayMarketplaceProviderClient.getNotificationTopics

getOrder()

getOrder(orderId): Promise<EbayOrder>;

Parameters

Parameter	Type
orderId	string

Returns

Promise\<EbayOrder>

Inherited from

EbayMarketplaceProviderClient.getOrder

getPaymentDispute()

getPaymentDispute(paymentDisputeId): Promise<EbayPaymentDispute>;

Parameters

Parameter	Type
paymentDisputeId	string

Returns

Promise\<EbayPaymentDispute>

Inherited from

EbayMarketplaceProviderClient.getPaymentDispute

getPaymentDisputeActivities()

getPaymentDisputeActivities(paymentDisputeId): Promise<EbayPaymentDisputeActivities>;

Parameters

Parameter	Type
paymentDisputeId	string

Returns

Promise\<EbayPaymentDisputeActivities>

Inherited from

EbayMarketplaceProviderClient.getPaymentDisputeActivities

getShippingFulfillment()

getShippingFulfillment(orderId, fulfillmentId): Promise<EbayShippingFulfillment>;

Parameters

Parameter	Type
orderId	string
fulfillmentId	string

Returns

Promise\<EbayShippingFulfillment>

Inherited from

EbayMarketplaceProviderClient.getShippingFulfillment

getShippingFulfillments()

getShippingFulfillments(orderId): Promise<EbayShippingFulfillmentsCollection>;

Parameters

Parameter	Type
orderId	string

Returns

Promise\<EbayShippingFulfillmentsCollection>

Inherited from

EbayMarketplaceProviderClient.getShippingFulfillments

getSigningKey()

getSigningKey(signingKeyId): Promise<EbaySigningKey>;

Parameters

Parameter	Type
signingKeyId	string

Returns

Promise\<EbaySigningKey>

Inherited from

EbayMarketplaceProviderClient.getSigningKey

getSigningKeys()

getSigningKeys(): Promise<EbaySigningKeysCollection>;

Returns

Promise\<EbaySigningKeysCollection>

Inherited from

EbayMarketplaceProviderClient.getSigningKeys

getUser()

getUser(): Promise<EbayUser>;

Returns

Promise\<EbayUser>

Inherited from

EbayMarketplaceProviderClient.getUser

issueRefund()

issueRefund(orderId, input): Promise<EbayRefund>;

Parameters

Parameter	Type
orderId	string
input	EbayIssueRefundInput

Returns

Promise\<EbayRefund>

Inherited from

EbayMarketplaceProviderClient.issueRefund

searchOrders()

searchOrders(input?): Promise<EbayOrdersCollection>;

Parameters

Parameter	Type
input?	EbayOrderSearchInput

Returns

Promise\<EbayOrdersCollection>

Inherited from

EbayMarketplaceProviderClient.searchOrders

searchPaymentDisputes()

searchPaymentDisputes(input?): Promise<EbayPaymentDisputesCollection>;

Parameters

Parameter	Type
input?	EbayPaymentDisputeSearchInput

Returns

Promise\<EbayPaymentDisputesCollection>

Inherited from

EbayMarketplaceProviderClient.searchPaymentDisputes

sendMessage()

sendMessage(input): Promise<EbayMessageResponse>;

Parameters

Parameter	Type
input	EbaySendMessageInput

Returns

Promise\<EbayMessageResponse>

Inherited from

EbayMarketplaceProviderClient.sendMessage

testNotificationSubscription()

testNotificationSubscription(subscriptionId): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<EbayNotificationSubscription>

Inherited from

EbayMarketplaceProviderClient.testNotificationSubscription

updateConversation()

updateConversation(input): Promise<EbayConversation>;

Parameters

Parameter	Type
input	EbayUpdateConversationInput

Returns

Promise\<EbayConversation>

Inherited from

EbayMarketplaceProviderClient.updateConversation

updateNotificationConfig()

updateNotificationConfig(input): Promise<EbayNotificationConfig>;

Parameters

Parameter	Type
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayNotificationConfig>

Inherited from

EbayMarketplaceProviderClient.updateNotificationConfig

updateNotificationDestination()

updateNotificationDestination(destinationId, input): Promise<EbayNotificationDestination>;

Parameters

Parameter	Type
destinationId	string
input	EbayNotificationDestinationInput

Returns

Promise\<EbayNotificationDestination>

Inherited from

EbayMarketplaceProviderClient.updateNotificationDestination

updateNotificationSubscription()

updateNotificationSubscription(subscriptionId, input): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string
input	EbayNotificationSubscriptionInput

Returns

Promise\<EbayNotificationSubscription>

Inherited from

EbayMarketplaceProviderClient.updateNotificationSubscription

updatePaymentDisputeEvidence()

updatePaymentDisputeEvidence(paymentDisputeId, input): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

Inherited from

EbayMarketplaceProviderClient.updatePaymentDisputeEvidence

uploadPaymentDisputeEvidenceFile()

uploadPaymentDisputeEvidenceFile(paymentDisputeId, input): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

Inherited from

EbayMarketplaceProviderClient.uploadPaymentDisputeEvidenceFile

---

EbayMarketplaceClientOptions

Extended by

• EbayMarketplaceIntegrationOptions
• EbayLiveCheckOptions

Properties

accessToken?

optional accessToken?: string;

applicationAccessToken?

optional applicationAccessToken?: string;

baseUrl?

optional baseUrl?: string;

environment?

optional environment?: "sandbox" | "production";

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>

marketplaceId?

optional marketplaceId?: string;

providerClient?

optional providerClient?: EbayMarketplaceProviderClient;

requestSigner?

optional requestSigner?: EbayRequestSigner;

retry?

optional retry?:
  | number
  | ProviderJsonRetryOptions;

signal?

optional signal?: AbortSignal;

timeoutMs?

optional timeoutMs?: number;

---

EbayMarketplaceIntegrationOptions

Extends

• EbayMarketplaceClientOptions

Properties

accessToken?

optional accessToken?: string;

Inherited from

EbayMarketplaceClientOptions.accessToken

applicationAccessToken?

optional applicationAccessToken?: string;

Inherited from

EbayMarketplaceClientOptions.applicationAccessToken

baseUrl?

optional baseUrl?: string;

Inherited from

EbayMarketplaceClientOptions.baseUrl

client?

optional client?: EbayMarketplaceClient;

environment?

optional environment?: "sandbox" | "production";

Inherited from

EbayMarketplaceClientOptions.environment

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

EbayMarketplaceClientOptions.fetch

marketplaceId?

optional marketplaceId?: string;

Inherited from

EbayMarketplaceClientOptions.marketplaceId

providerClient?

optional providerClient?: EbayMarketplaceProviderClient;

Inherited from

EbayMarketplaceClientOptions.providerClient

requestSigner?

optional requestSigner?: EbayRequestSigner;

Inherited from

EbayMarketplaceClientOptions.requestSigner

retry?

optional retry?:
  | number
  | ProviderJsonRetryOptions;

Inherited from

EbayMarketplaceClientOptions.retry

signal?

optional signal?: AbortSignal;

Inherited from

EbayMarketplaceClientOptions.signal

timeoutMs?

optional timeoutMs?: number;

Inherited from

EbayMarketplaceClientOptions.timeoutMs

---

EbayMarketplaceJsonObject

Extended by

• EbayMarketplaceProviderExtensionFields
• EbayMarketplaceProviderResponse

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

---

EbayMarketplaceOperationInput

Properties

args?

optional args?: unknown[];

client?

optional client?: EbayMarketplaceClient;

providerClient?

optional providerClient?: EbayMarketplaceProviderClient;

---

EbayMarketplaceProviderClient

Extended by

• EbayMarketplaceClient

Methods

acceptPaymentDispute()

acceptPaymentDispute(paymentDisputeId, input?): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input?	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

addPaymentDisputeEvidence()

addPaymentDisputeEvidence(paymentDisputeId, input): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

bulkUpdateConversations()

bulkUpdateConversations(input): Promise<{
[providerField: string]: EbayMarketplaceJsonValue;
  conversations?: EbayConversation[];
}>;

Parameters

Parameter	Type
input	EbayBulkUpdateConversationsInput

Returns

Promise\<{ [providerField: string]: EbayMarketplaceJsonValue; conversations?: EbayConversation[]; }>

contestPaymentDispute()

contestPaymentDispute(paymentDisputeId, input): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

createNotificationDestination()

createNotificationDestination(input): Promise<EbayNotificationDestination>;

Parameters

Parameter	Type
input	EbayNotificationDestinationInput

Returns

Promise\<EbayNotificationDestination>

createNotificationSubscription()

createNotificationSubscription(input): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
input	EbayNotificationSubscriptionInput

Returns

Promise\<EbayNotificationSubscription>

createNotificationSubscriptionFilter()

createNotificationSubscriptionFilter(subscriptionId, input): Promise<EbayNotificationSubscriptionFilter>;

Parameters

Parameter	Type
subscriptionId	string
input	EbayNotificationSubscriptionFilterInput

Returns

Promise\<EbayNotificationSubscriptionFilter>

createShippingFulfillment()

createShippingFulfillment(orderId, input): Promise<EbayShippingFulfillment>;

Parameters

Parameter	Type
orderId	string
input	EbayShippingFulfillmentInput

Returns

Promise\<EbayShippingFulfillment>

createSigningKey()

createSigningKey(input?): Promise<EbaySigningKey>;

Parameters

Parameter	Type
input?	EbayCreateSigningKeyInput

Returns

Promise\<EbaySigningKey>

deleteNotificationDestination()

deleteNotificationDestination(destinationId): Promise<Record<string, never>>;

Parameters

Parameter	Type
destinationId	string

Returns

Promise\<Record\<string, never>>

deleteNotificationSubscription()

deleteNotificationSubscription(subscriptionId): Promise<Record<string, never>>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<Record\<string, never>>

deleteNotificationSubscriptionFilter()

deleteNotificationSubscriptionFilter(subscriptionId, filterId): Promise<Record<string, never>>;

Parameters

Parameter	Type
subscriptionId	string
filterId	string

Returns

Promise\<Record\<string, never>>

disableNotificationSubscription()

disableNotificationSubscription(subscriptionId): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<EbayNotificationSubscription>

enableNotificationSubscription()

enableNotificationSubscription(subscriptionId): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<EbayNotificationSubscription>

fetchPaymentDisputeEvidenceContent()

fetchPaymentDisputeEvidenceContent(paymentDisputeId): Promise<ArrayBuffer | EbayMarketplaceJsonObject>;

Parameters

Parameter	Type
paymentDisputeId	string

Returns

Promise\<ArrayBuffer | EbayMarketplaceJsonObject>

getConversation()

getConversation(conversationId): Promise<EbayConversation>;

Parameters

Parameter	Type
conversationId	string

Returns

Promise\<EbayConversation>

getConversations()

getConversations(input?): Promise<EbayConversationsCollection>;

Parameters

Parameter	Type
input?	EbayConversationSearchInput

Returns

Promise\<EbayConversationsCollection>

getNotificationConfig()

getNotificationConfig(): Promise<EbayNotificationConfig>;

Returns

Promise\<EbayNotificationConfig>

getNotificationDestination()

getNotificationDestination(destinationId): Promise<EbayNotificationDestination>;

Parameters

Parameter	Type
destinationId	string

Returns

Promise\<EbayNotificationDestination>

getNotificationDestinations()

getNotificationDestinations(): Promise<EbayNotificationDestinationsCollection>;

Returns

Promise\<EbayNotificationDestinationsCollection>

getNotificationPublicKey()

getNotificationPublicKey(publicKeyId): Promise<EbayNotificationPublicKey>;

Parameters

Parameter	Type
publicKeyId	string

Returns

Promise\<EbayNotificationPublicKey>

getNotificationSubscription()

getNotificationSubscription(subscriptionId): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<EbayNotificationSubscription>

getNotificationSubscriptionFilter()

getNotificationSubscriptionFilter(subscriptionId, filterId): Promise<EbayNotificationSubscriptionFilter>;

Parameters

Parameter	Type
subscriptionId	string
filterId	string

Returns

Promise\<EbayNotificationSubscriptionFilter>

getNotificationSubscriptions()

getNotificationSubscriptions(): Promise<EbayNotificationSubscriptionsCollection>;

Returns

Promise\<EbayNotificationSubscriptionsCollection>

getNotificationTopic()

getNotificationTopic(topicId): Promise<{
[providerField: string]: EbayMarketplaceJsonValue;
  description?: string;
  supportedPayloadVersions?: string[];
  topicId?: string;
}>;

Parameters

Parameter	Type
topicId	string

Returns

Promise\<{ [providerField: string]: EbayMarketplaceJsonValue; description?: string; supportedPayloadVersions?: string[]; topicId?: string; }>

getNotificationTopics()

getNotificationTopics(input?): Promise<EbayRestCollection<EbayMarketplaceJsonObject>>;

Parameters

Parameter	Type
input?	EbayNotificationTopicSearchInput

Returns

Promise\<EbayRestCollection\<EbayMarketplaceJsonObject>>

getOrder()

getOrder(orderId): Promise<EbayOrder>;

Parameters

Parameter	Type
orderId	string

Returns

Promise\<EbayOrder>

getPaymentDispute()

getPaymentDispute(paymentDisputeId): Promise<EbayPaymentDispute>;

Parameters

Parameter	Type
paymentDisputeId	string

Returns

Promise\<EbayPaymentDispute>

getPaymentDisputeActivities()

getPaymentDisputeActivities(paymentDisputeId): Promise<EbayPaymentDisputeActivities>;

Parameters

Parameter	Type
paymentDisputeId	string

Returns

Promise\<EbayPaymentDisputeActivities>

getShippingFulfillment()

getShippingFulfillment(orderId, fulfillmentId): Promise<EbayShippingFulfillment>;

Parameters

Parameter	Type
orderId	string
fulfillmentId	string

Returns

Promise\<EbayShippingFulfillment>

getShippingFulfillments()

getShippingFulfillments(orderId): Promise<EbayShippingFulfillmentsCollection>;

Parameters

Parameter	Type
orderId	string

Returns

Promise\<EbayShippingFulfillmentsCollection>

getSigningKey()

getSigningKey(signingKeyId): Promise<EbaySigningKey>;

Parameters

Parameter	Type
signingKeyId	string

Returns

Promise\<EbaySigningKey>

getSigningKeys()

getSigningKeys(): Promise<EbaySigningKeysCollection>;

Returns

Promise\<EbaySigningKeysCollection>

getUser()

getUser(): Promise<EbayUser>;

Returns

Promise\<EbayUser>

issueRefund()

issueRefund(orderId, input): Promise<EbayRefund>;

Parameters

Parameter	Type
orderId	string
input	EbayIssueRefundInput

Returns

Promise\<EbayRefund>

searchOrders()

searchOrders(input?): Promise<EbayOrdersCollection>;

Parameters

Parameter	Type
input?	EbayOrderSearchInput

Returns

Promise\<EbayOrdersCollection>

searchPaymentDisputes()

searchPaymentDisputes(input?): Promise<EbayPaymentDisputesCollection>;

Parameters

Parameter	Type
input?	EbayPaymentDisputeSearchInput

Returns

Promise\<EbayPaymentDisputesCollection>

sendMessage()

sendMessage(input): Promise<EbayMessageResponse>;

Parameters

Parameter	Type
input	EbaySendMessageInput

Returns

Promise\<EbayMessageResponse>

testNotificationSubscription()

testNotificationSubscription(subscriptionId): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string

Returns

Promise\<EbayNotificationSubscription>

updateConversation()

updateConversation(input): Promise<EbayConversation>;

Parameters

Parameter	Type
input	EbayUpdateConversationInput

Returns

Promise\<EbayConversation>

updateNotificationConfig()

updateNotificationConfig(input): Promise<EbayNotificationConfig>;

Parameters

Parameter	Type
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayNotificationConfig>

updateNotificationDestination()

updateNotificationDestination(destinationId, input): Promise<EbayNotificationDestination>;

Parameters

Parameter	Type
destinationId	string
input	EbayNotificationDestinationInput

Returns

Promise\<EbayNotificationDestination>

updateNotificationSubscription()

updateNotificationSubscription(subscriptionId, input): Promise<EbayNotificationSubscription>;

Parameters

Parameter	Type
subscriptionId	string
input	EbayNotificationSubscriptionInput

Returns

Promise\<EbayNotificationSubscription>

updatePaymentDisputeEvidence()

updatePaymentDisputeEvidence(paymentDisputeId, input): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

uploadPaymentDisputeEvidenceFile()

uploadPaymentDisputeEvidenceFile(paymentDisputeId, input): Promise<EbayPaymentDisputeActionResponse>;

Parameters

Parameter	Type
paymentDisputeId	string
input	EbayMarketplaceJsonObject

Returns

Promise\<EbayPaymentDisputeActionResponse>

---

EbayMarketplaceProviderExtensionFields

Extends

• EbayMarketplaceJsonObject

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

---

EbayMarketplaceProviderResponse

Extends

• EbayMarketplaceJsonObject

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

---

EbayMessageResponse

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

conversationId?

optional conversationId?: string;

messageId?

optional messageId?: string;

status?

optional status?: string;

---

EbayNotificationConfig

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

alertEmail?

optional alertEmail?: string;

alerts?

optional alerts?: EbayMarketplaceJsonObject[];

---

EbayNotificationDestination

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

deliveryConfig?

optional deliveryConfig?: EbayMarketplaceJsonObject;

destinationId?

optional destinationId?: string;

destinationUrl?

optional destinationUrl?: string;

name?

optional name?: string;

status?

optional status?:
  | string & {
}
  | "ENABLED"
  | "DISABLED";

---

EbayNotificationDestinationInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

deliveryConfig?

optional deliveryConfig?: EbayMarketplaceJsonObject;

destinationUrl?

optional destinationUrl?: string;

name?

optional name?: string;

status?

optional status?: string;

---

EbayNotificationDestinationsCollection

Extends

• EbayRestCollection\<EbayNotificationDestination>

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations?

optional conversations?: EbayNotificationDestination[];

Inherited from

EbayRestCollection.conversations

destinations?

optional destinations?: EbayNotificationDestination[];

href?

optional href?: string;

Inherited from

EbayRestCollection.href

limit?

optional limit?: number;

Inherited from

EbayRestCollection.limit

offset?

optional offset?: number;

Inherited from

EbayRestCollection.offset

orders?

optional orders?: EbayNotificationDestination[];

Inherited from

EbayRestCollection.orders

paymentDisputeSummaries?

optional paymentDisputeSummaries?: EbayNotificationDestination[];

Inherited from

EbayRestCollection.paymentDisputeSummaries

total?

optional total?: number;

Inherited from

EbayRestCollection.total

---

EbayNotificationPublicKey

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

algorithm?

optional algorithm?: string;

key?

optional key?: string;

publicKey?

optional publicKey?: string;

---

EbayNotificationSignatureHeader

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

alg?

optional alg?: string;

digest?

optional digest?: string;

kid?

optional kid?: string;

signature?

optional signature?: string;

---

EbayNotificationSubscription

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

creationDate?

optional creationDate?: string;

destinationId?

optional destinationId?: string;

payloadVersion?

optional payloadVersion?: string;

status?

optional status?:
  | string & {
}
  | "ENABLED"
  | "DISABLED";

subscriptionId?

optional subscriptionId?: string;

topicId?

optional topicId?: string;

---

EbayNotificationSubscriptionFilter

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

filter?

optional filter?: EbayMarketplaceJsonObject;

filterId?

optional filterId?: string;

filterType?

optional filterType?: string;

schemaVersion?

optional schemaVersion?: string;

---

EbayNotificationSubscriptionFilterInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

filter?

optional filter?: EbayMarketplaceJsonObject;

filterType?

optional filterType?: string;

schemaVersion?

optional schemaVersion?: string;

---

EbayNotificationSubscriptionInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

destinationId?

optional destinationId?: string;

payloadVersion?

optional payloadVersion?: string;

status?

optional status?: string;

topicId?

optional topicId?: string;

---

EbayNotificationSubscriptionsCollection

Extends

• EbayRestCollection\<EbayNotificationSubscription>

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations?

optional conversations?: EbayNotificationSubscription[];

Inherited from

EbayRestCollection.conversations

href?

optional href?: string;

Inherited from

EbayRestCollection.href

limit?

optional limit?: number;

Inherited from

EbayRestCollection.limit

offset?

optional offset?: number;

Inherited from

EbayRestCollection.offset

orders?

optional orders?: EbayNotificationSubscription[];

Inherited from

EbayRestCollection.orders

paymentDisputeSummaries?

optional paymentDisputeSummaries?: EbayNotificationSubscription[];

Inherited from

EbayRestCollection.paymentDisputeSummaries

subscriptions?

optional subscriptions?: EbayNotificationSubscription[];

total?

optional total?: number;

Inherited from

EbayRestCollection.total

---

EbayNotificationTopicSearchInput

Properties

continuation_token?

optional continuation_token?: string;

continuationToken?

optional continuationToken?: string;

limit?

optional limit?: number;

---

EbayNotificationWebhook

Properties

notificationId?

optional notificationId?: string;

payload

payload: unknown;

rawBody

rawBody: string;

signatureHeader?

optional signatureHeader?: EbayNotificationSignatureHeader;

topic?

optional topic?: string;

---

EbayOrder

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

buyer?

optional buyer?: {
[providerField: string]: EbayMarketplaceJsonValue;
  taxAddress?: EbayMarketplaceJsonObject;
  username?: string;
};

Index Signature

[providerField: string]: EbayMarketplaceJsonValue

taxAddress?

optional taxAddress?: EbayMarketplaceJsonObject;

username?

optional username?: string;

creationDate?

optional creationDate?: string;

fulfillmentStartInstructions?

optional fulfillmentStartInstructions?: EbayMarketplaceJsonObject[];

lastModifiedDate?

optional lastModifiedDate?: string;

legacyOrderId?

optional legacyOrderId?: string;

lineItems?

optional lineItems?: EbayOrderLineItem[];

orderFulfillmentStatus?

optional orderFulfillmentStatus?: string;

orderId?

optional orderId?: string;

orderPaymentStatus?

optional orderPaymentStatus?: string;

paymentSummary?

optional paymentSummary?: EbayMarketplaceJsonObject;

pricingSummary?

optional pricingSummary?: {
[providerField: string]: EbayMarketplaceProviderExtensionValue;
  deliveryCost?: EbayAmount;
  priceSubtotal?: EbayAmount;
  total?: EbayAmount;
};

Index Signature

[providerField: string]: EbayMarketplaceProviderExtensionValue

deliveryCost?

optional deliveryCost?: EbayAmount;

priceSubtotal?

optional priceSubtotal?: EbayAmount;

total?

optional total?: EbayAmount;

sellerId?

optional sellerId?: string;

---

EbayOrderLineItem

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

appliedPromotions?

optional appliedPromotions?: {
  description?: string;
  discountAmount?: EbayAmount;
  promotionId?: string;
}[];

description?

optional description?: string;

discountAmount?

optional discountAmount?: EbayAmount;

promotionId?

optional promotionId?: string;

legacyItemId?

optional legacyItemId?: string;

lineItemCost?

optional lineItemCost?: EbayAmount;

lineItemId?

optional lineItemId?: string;

quantity?

optional quantity?: number;

sku?

optional sku?: string;

taxes?

optional taxes?: {
  amount?: EbayAmount;
  taxType?: string;
}[];

amount?

optional amount?: EbayAmount;

taxType?

optional taxType?: string;

title?

optional title?: string;

total?

optional total?: EbayAmount;

---

EbayOrdersCollection

Extends

• EbayRestCollection\<EbayOrder>

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations?

optional conversations?: EbayOrder[];

Inherited from

EbayRestCollection.conversations

href?

optional href?: string;

Inherited from

EbayRestCollection.href

limit?

optional limit?: number;

Inherited from

EbayRestCollection.limit

offset?

optional offset?: number;

Inherited from

EbayRestCollection.offset

orders?

optional orders?: EbayOrder[];

Overrides

EbayRestCollection.orders

paymentDisputeSummaries?

optional paymentDisputeSummaries?: EbayOrder[];

Inherited from

EbayRestCollection.paymentDisputeSummaries

total?

optional total?: number;

Inherited from

EbayRestCollection.total

---

EbayOrderSearchInput

Properties

fieldGroups?

optional fieldGroups?: string[];

filter?

optional filter?: string | string[];

limit?

optional limit?: number;

offset?

optional offset?: number;

orderIds?

optional orderIds?: string[];

---

EbayPaymentDispute

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

amount?

optional amount?: EbayAmount;

buyerUsername?

optional buyerUsername?: string;

evidence?

optional evidence?: EbayMarketplaceJsonObject[];

openDate?

optional openDate?: string;

orderId?

optional orderId?: string;

paymentDisputeId?

optional paymentDisputeId?: string;

reason?

optional reason?: string;

respondByDate?

optional respondByDate?: string;

status?

optional status?: string;

---

EbayPaymentDisputeActionResponse

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

actionId?

optional actionId?: string;

paymentDisputeId?

optional paymentDisputeId?: string;

status?

optional status?: string;

---

EbayPaymentDisputeActivities

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

activities?

optional activities?: EbayPaymentDisputeActivity[];

---

EbayPaymentDisputeActivity

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

activityDate?

optional activityDate?: string;

activityType?

optional activityType?: string;

actor?

optional actor?: string;

notes?

optional notes?: string;

---

EbayPaymentDisputesCollection

Extends

• EbayRestCollection\<EbayPaymentDispute>

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations?

optional conversations?: EbayPaymentDispute[];

Inherited from

EbayRestCollection.conversations

href?

optional href?: string;

Inherited from

EbayRestCollection.href

limit?

optional limit?: number;

Inherited from

EbayRestCollection.limit

offset?

optional offset?: number;

Inherited from

EbayRestCollection.offset

orders?

optional orders?: EbayPaymentDispute[];

Inherited from

EbayRestCollection.orders

paymentDisputeSummaries?

optional paymentDisputeSummaries?: EbayPaymentDispute[];

Overrides

EbayRestCollection.paymentDisputeSummaries

total?

optional total?: number;

Inherited from

EbayRestCollection.total

---

EbayPaymentDisputeSearchInput

Properties

filter?

optional filter?: string | string[];

limit?

optional limit?: number;

offset?

optional offset?: number;

---

EbayRefund

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

orderId?

optional orderId?: string;

refundAmount?

optional refundAmount?: EbayAmount;

refundDate?

optional refundDate?: string;

refundId?

optional refundId?: string;

refundStatus?

optional refundStatus?: string;

---

EbayRestCollection

Extended by

• EbayConversationsCollection
• EbayNotificationDestinationsCollection
• EbayNotificationSubscriptionsCollection
• EbayOrdersCollection
• EbayPaymentDisputesCollection
• EbayShippingFulfillmentsCollection
• EbaySigningKeysCollection

Type Parameters

Type Parameter	Default type
TItem	EbayMarketplaceJsonObject

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations?

optional conversations?: TItem[];

href?

optional href?: string;

limit?

optional limit?: number;

offset?

optional offset?: number;

orders?

optional orders?: TItem[];

paymentDisputeSummaries?

optional paymentDisputeSummaries?: TItem[];

total?

optional total?: number;

---

EbaySelectedApiOperation

Properties

api

api:
  | "sell.fulfillment"
  | "commerce.message"
  | "commerce.notification"
  | "developer.key-management"
  | "commerce.identity";

functionName

functionName: keyof EbayMarketplaceProviderClient;

method

method: "GET" | "POST" | "PUT" | "DELETE";

operationId

operationId: string;

path

path: string;

resource

resource: string;

specUrl

specUrl: string;

---

EbaySendMessageInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

body?

optional body?: EbayMarketplaceProviderPayload;

conversationId?

optional conversationId?: string;

messageText?

optional messageText?: string;

recipient?

optional recipient?: string;

subject?

optional subject?: string;

---

EbayShippingFulfillment

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

fulfillmentId?

optional fulfillmentId?: string;

lineItems?

optional lineItems?: {
  lineItemId?: string;
  quantity?: number;
}[];

lineItemId?

optional lineItemId?: string;

quantity?

optional quantity?: number;

shipmentTrackingNumber?

optional shipmentTrackingNumber?: string;

shippedDate?

optional shippedDate?: string;

shippingCarrierCode?

optional shippingCarrierCode?: string;

---

EbayShippingFulfillmentInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

lineItemsById?

optional lineItemsById?: {
  lineItemId: string;
  quantity: number;
}[];

lineItemId

lineItemId: string;

quantity

quantity: number;

shippedDate?

optional shippedDate?: string;

shippingCarrierCode?

optional shippingCarrierCode?: string;

trackingNumber?

optional trackingNumber?: string;

---

EbayShippingFulfillmentsCollection

Extends

• EbayRestCollection\<EbayShippingFulfillment>

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations?

optional conversations?: EbayShippingFulfillment[];

Inherited from

EbayRestCollection.conversations

fulfillments?

optional fulfillments?: EbayShippingFulfillment[];

href?

optional href?: string;

Inherited from

EbayRestCollection.href

limit?

optional limit?: number;

Inherited from

EbayRestCollection.limit

offset?

optional offset?: number;

Inherited from

EbayRestCollection.offset

orders?

optional orders?: EbayShippingFulfillment[];

Inherited from

EbayRestCollection.orders

paymentDisputeSummaries?

optional paymentDisputeSummaries?: EbayShippingFulfillment[];

Inherited from

EbayRestCollection.paymentDisputeSummaries

total?

optional total?: number;

Inherited from

EbayRestCollection.total

---

EbaySignedRequestInput

Properties

body?

optional body?: string;

method

method: "GET" | "POST" | "PUT" | "DELETE";

url

url: string;

---

EbaySigningKey

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

expirationDate?

optional expirationDate?: string;

publicKeyJwe?

optional publicKeyJwe?: string;

signingKeyCipher?

optional signingKeyCipher?: string;

signingKeyId?

optional signingKeyId?: string;

---

EbaySigningKeysCollection

Extends

• EbayRestCollection\<EbaySigningKey>

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversations?

optional conversations?: EbaySigningKey[];

Inherited from

EbayRestCollection.conversations

href?

optional href?: string;

Inherited from

EbayRestCollection.href

limit?

optional limit?: number;

Inherited from

EbayRestCollection.limit

offset?

optional offset?: number;

Inherited from

EbayRestCollection.offset

orders?

optional orders?: EbaySigningKey[];

Inherited from

EbayRestCollection.orders

paymentDisputeSummaries?

optional paymentDisputeSummaries?: EbaySigningKey[];

Inherited from

EbayRestCollection.paymentDisputeSummaries

signingKeys?

optional signingKeys?: EbaySigningKey[];

total?

optional total?: number;

Inherited from

EbayRestCollection.total

---

EbayUpdateConversationInput

Indexable

[key: string]: EbayMarketplaceProviderExtensionValue

Properties

conversationId?

optional conversationId?: string;

status?

optional status?: string;

---

EbayUser

Indexable

[providerField: string]: EbayMarketplaceProviderExtensionValue

Properties

registrationMarketplaceId?

optional registrationMarketplaceId?: string;

status?

optional status?: string;

userId?

optional userId?: string;

username?

optional username?: string;

---

ParseEbayNotificationWebhookOptions

Properties

expectedSharedSecret?

optional expectedSharedSecret?: string;

publicKey?

optional publicKey?: string;

requireEbaySignature?

optional requireEbaySignature?: boolean;

sharedSecretHeaderName?

optional sharedSecretHeaderName?: string;

verifySignature?

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

Parameters

Parameter	Type
input	{ rawBody: string; signatureHeader: EbayNotificationSignatureHeader; }
input.rawBody	string
input.signatureHeader	EbayNotificationSignatureHeader

Returns

boolean | Promise\<boolean>

Type Aliases

EbayMarketplaceJsonPrimitive

type EbayMarketplaceJsonPrimitive = string | number | boolean | null;

---

EbayMarketplaceJsonValue

type EbayMarketplaceJsonValue =
  | EbayMarketplaceJsonPrimitive
  | EbayMarketplaceJsonObject
  | readonly EbayMarketplaceJsonValue[];

---

EbayMarketplaceProviderExtensionValue

type EbayMarketplaceProviderExtensionValue =
  | EbayMarketplaceJsonValue
  | object
  | undefined;

---

EbayMarketplaceProviderPayload

type EbayMarketplaceProviderPayload = EbayMarketplaceJsonObject | object;

---

EbayMarketplaceProviderQuery

type EbayMarketplaceProviderQuery = Record<string, EbayMarketplaceProviderExtensionValue>;

---

EbayRequestSigner

type EbayRequestSigner = (input) =>
  | Record<string, string>
| Promise<Record<string, string>>;

Parameters

Parameter	Type
input	EbaySignedRequestInput

Returns

| Record\<string, string> | Promise\<Record\<string, string>>

Variables

EBAY_SELECTED_API_GENERATED_FUNCTION_COUNT

const EBAY_SELECTED_API_GENERATED_FUNCTION_COUNT: 45 = 45;

---

EBAY_SELECTED_API_OPERATION_COUNT

const EBAY_SELECTED_API_OPERATION_COUNT: 45 = 45;

---

EBAY_SELECTED_API_PATH_COUNT

const EBAY_SELECTED_API_PATH_COUNT: 34 = 34;

---

EBAY_SELECTED_API_VERIFICATION_DATE

const EBAY_SELECTED_API_VERIFICATION_DATE: "2026-06-18" = "2026-06-18";

---

ebayMarketplaceIntegration

const ebayMarketplaceIntegration: 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: "Validates eBay notification endpoint challenges and parses signed Notification API events for SDK-user-owned marketplace workflows.";
     exposesSensitiveData: true;
     label: "Receive eBay notifications";
     providerObjects: readonly [{
        kind: "ebayNotification";
        label: "eBay Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Reads eBay seller orders, shipping fulfillments, payment disputes, message conversations, account profile details, and notification destinations/subscriptions.";
     exposesSensitiveData: true;
     label: "Read eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayOrder";
        label: "eBay Order";
      }, {
        kind: "ebayShippingFulfillment";
        label: "eBay Shipping Fulfillment";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayConversation";
        label: "eBay Conversation";
      }, {
        kind: "ebayUser";
        label: "eBay User";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "search-provider-object";
     description: "Searches orders, payment disputes, and message conversations with SDK-user-supplied eBay filters and pagination.";
     exposesSensitiveData: true;
     label: "Search eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayOrder";
        label: "eBay Order";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayConversation";
        label: "eBay Conversation";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "update-provider-object";
     changesWorkflow: true;
     description: "Updates eBay conversations, payment-dispute evidence or outcomes, and notification destination/subscription lifecycle when SDK-user policy permits marketplace mutations.";
     exposesSensitiveData: true;
     label: "Update eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayConversation";
        label: "eBay Conversation";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "delete-provider-object";
     changesWorkflow: true;
     description: "Deletes notification destinations, subscriptions, and filters only when the SDK user's marketplace policy allows lifecycle changes.";
     label: "Delete eBay marketplace resources";
     providerObjects: readonly [{
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     description: "Creates shipping fulfillments, buyer/seller messages, refunds, and payment-dispute actions only when SDK-user policy allows.";
     exposesSensitiveData: true;
     label: "Create eBay fulfillment and message records";
     providerObjects: readonly [{
        kind: "ebayShippingFulfillment";
        label: "eBay Shipping Fulfillment";
      }, {
        kind: "ebayMessage";
        label: "eBay Message";
      }, {
        kind: "ebayRefund";
        label: "eBay Refund";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "send";
     description: "Sends supported Commerce Message API messages to eBay conversations selected by the SDK user's workflow.";
     exposesSensitiveData: true;
     label: "Send eBay marketplace messages";
     providerObjects: readonly [{
        kind: "ebayMessage";
        label: "eBay Message";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.notification-signature";
     description: "Decodes X-EBAY-SIGNATURE, retrieves or accepts the SDK-user-cached public key, and verifies ECDSA/SHA1 payload signatures before parsing.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate eBay notification signatures";
     providerObjects: readonly [{
        kind: "ebaySignedNotification";
        label: "eBay Signed Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.digital-signature";
     changesWorkflow: true;
     description: "Adds Content-Digest, Signature, Signature-Input, and X-EBAY-SIGNATURE-KEY headers to issueRefund when EU/UK seller policy requires eBay HTTP Message Signatures.";
     extension: true;
     label: "Sign regulated eBay refund requests";
     providerObjects: readonly [{
        kind: "ebaySignedRequest";
        label: "eBay Signed Request";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.notification-challenge";
     description: "Computes the SHA-256 challengeResponse from challenge code, verification token, and endpoint URL for eBay destination setup.";
     extension: true;
     label: "Answer eBay notification challenges";
     providerObjects: readonly [{
        kind: "ebayNotificationChallenge";
        label: "eBay Notification Challenge";
     }];
     requiresCredential: true;
  }];
  category: "marketplace";
  channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "eBay Sell Fulfillment API";
        url: "https://developer.ebay.com/develop/api/sell/fulfillment_api";
      }, {
        label: "eBay Digital Signatures for APIs";
        url: "https://developer.ebay.com/develop/guides/digital-signatures-for-apis";
      }, {
        label: "eBay Key Management API";
        url: "https://developer.ebay.com/api-docs/developer/key-management/resources/methods";
      }, {
        label: "eBay Commerce Notification API resources";
        url: "https://developer.ebay.com/api-docs/commerce/notification/resources/methods";
      }, {
        label: "eBay Commerce Notification API overview";
        url: "https://developer.ebay.com/api-docs/commerce/notification/overview.html";
      }, {
        label: "eBay Notification getPublicKey";
        url: "https://developer.ebay.com/api-docs/commerce/notification/resources/public_key/methods/getPublicKey";
      }, {
        label: "eBay OAuth client credentials grant flow";
        url: "https://developer.ebay.com/develop/guides-v2/authorization#the-client-credentials-grant-flow";
      }, {
        label: "eBay Commerce Message API";
        url: "https://developer.ebay.com/api-docs/commerce/message/resources/methods";
      }, {
        label: "eBay OpenAPI specifications";
        url: "https://developer.ebay.com/api-docs/static/gs_take-advantage-of-openapi.html";
      }, {
        label: "eBay Fulfillment OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json";
      }, {
        label: "eBay Commerce Message OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json";
      }, {
        label: "eBay Commerce Notification OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json";
      }, {
        label: "eBay Developer Key Management OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json";
      }, {
        label: "eBay Commerce Identity OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json";
     }];
     notes: readonly ["Coverage is limited to selected eBay marketplace support primitives: Sell Fulfillment order, shipping fulfillment, refund, and payment-dispute operations; Sell Commerce Message conversations; Commerce Notification destination/subscription/config/public-key operations; notification challenges; and signed notification parsing.", "The selected eBay OpenAPI slice documents the provider-client contract for every currently implemented Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, and Commerce Identity resource group operation, and this package ships a built-in REST adapter for those operations.", "The package does not implement full eBay API coverage for inventory/listing management, account policy breadth, marketing/promotions, analytics/reporting, taxonomy/metadata, media, translation, buy APIs, finances beyond supported fulfillment dispute routes, Negotiation/Leads/Charity/Media APIs, or older Trading/Browse/Finding surfaces.", "Runtime provider-data operations use the built-in typed eBay REST adapter when OAuth token/environment/baseUrl/fetch options are provided; host-injected providerClient remains available as an override and must implement the selected operation contract.", "Local helpers for eBay notification challenge/signature parsing and HTTP Message Signature header creation remain available for host clients and webhook handlers.", "The SDK user owns OAuth grant/scopes, marketplace selection, notification topic and filter policy, public-key cache freshness, refund/dispute authority, outbound messaging policy, consent, redaction, retention decisions, and optional provider-client override runtime."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     description: "Server-side OAuth user token with SDK-user-selected Sell, Commerce Message, Identity, and Notification scopes.";
     id: "ebay-oauth-access-token";
     label: "eBay OAuth user access token";
     metadata: {
        scopeKind: "provider-oauth-scopes";
     };
     required: true;
     scopes: readonly ["https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly", "https://api.ebay.com/oauth/api_scope/commerce.message", "https://api.ebay.com/oauth/api_scope/commerce.identity.readonly", "https://api.ebay.com/oauth/api_scope/commerce.notification.subscription"];
   }, {
     description: "Client-credentials OAuth token with https://api.ebay.com/oauth/api_scope for Notification public-key retrieval.";
     id: "ebay-application-access-token";
     label: "eBay application access token";
     metadata: {
        scopeKind: "provider-oauth-scopes";
     };
     required: true;
     scopes: readonly ["https://api.ebay.com/oauth/api_scope"];
   }, {
     description: "Application keyset client ID owned by the SDK user for OAuth and notification ownership metadata.";
     id: "ebay-client-id";
     label: "eBay application client ID";
     required: true;
   }, {
     description: "Application keyset client secret kept server-side by the SDK user for OAuth token lifecycle operations.";
     id: "ebay-client-secret";
     label: "eBay application client secret";
     required: true;
   }, {
     description: "SDK-user-selected marketplace such as EBAY_US or EBAY_DE, forwarded through X-EBAY-C-MARKETPLACE-ID where supported.";
     id: "ebay-marketplace-id";
     label: "eBay marketplace ID";
     required: true;
   }, {
     description: "Optional host-injected client implementing EbayMarketplaceProviderClient when the SDK user wants to override the built-in REST adapter.";
     id: "ebay-provider-client";
     label: "Optional eBay marketplace provider client override";
     required: false;
   }, {
     description: "Destination verification token used to answer eBay challenge_code requests for notification endpoints.";
     id: "ebay-notification-verification-token";
     label: "eBay notification verification token";
     required: true;
   }, {
     description: "Key Management API private key and public-key JWE required for issueRefund when EU/UK seller or SDK policy requires HTTP Message Signatures.";
     id: "ebay-digital-signature-key";
     label: "eBay digital signature keypair";
     required: false;
  }];
  directions: readonly ["receive-only", "send-only", "bidirectional"];
  id: "marketplace.ebay";
  limitations: readonly ["The SDK user chooses marketplaces, OAuth flows, scopes, notification topics, subscription filters, operator visibility, outbound messaging policy, refund/dispute rules, retention, consent, and redaction.", "Some eBay APIs are entitlement, marketplace, scope, topic, or sandbox limited; this package exposes a typed REST/provider-client contract and does not decide whether a seller is eligible for a specific action.", "Provider-data operations fail closed unless OAuth tokens are provided for the built-in typed REST adapter or an injected EbayMarketplaceProviderClient implements the selected operation.", "The local issueRefund signature helper is fail-closed when EU/UK seller or SDK policy requires digital signatures and no eBay signing key material is configured.", "Notification signature verification requires a valid eBay public key retrieved by key ID from the Notification API or a SDK-user-provided verifier/cache implementation."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     channelCoverage: {
        conversationBulkUpdate: "typed-update";
        conversations: "typed-read-search-update";
        digitalSignatures: "typed-sign";
        inventoryMarketingAnalyticsBuyApis: "provider-supported-not-typed";
        keyManagementSigningKeys: "typed-create-read-list";
        messages: "typed-send";
        notificationChallenge: "typed-response";
        notificationConfig: "typed-read-update";
        notificationDestinations: "typed-create-read-list-update-delete";
        notificationFilters: "typed-create-read-delete";
        notificationSignatures: "typed-verify";
        notificationSubscriptions: "typed-create-read-list-update-enable-disable-test-delete";
        notificationTopics: "typed-read-list";
        orders: "typed-read-search";
        paymentDisputeEvidence: "typed-read-upload-add-update";
        paymentDisputes: "typed-read-search-update";
        refunds: "typed-create";
        shippingFulfillments: "typed-create-read-list";
        userProfile: "typed-read";
     };
     docs: "https://developer.ebay.com/api-docs";
     fulfillmentDocs: "https://developer.ebay.com/api-docs/sell/fulfillment/overview.html";
     generatedProviderSliceVerification: {
        apiVersion: string;
        coverageArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json";
        documentedOperationCount: 45;
        documentedPathCount: 34;
        functionCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.functions.json";
        generatedFunctionCount: 45;
        implementedOperationCount: 45;
        operationCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json";
        provider: "ebay-provider-rest-adapter";
        unimplementedOperationCount: 0;
        verifiedAt: "2026-06-18";
     };
     implementation: {
        checkedAt: "2026-06-18";
        communityRestPackagesChecked: readonly [{
           decision: "community-wrapper-rejected-not-provider-owned";
           modifiedAt: "2026-05-11T08:17:20.577Z";
           package: "ebay-api";
           repository: "https://github.com/hendt/ebay-api";
           version: "9.5.2";
         }, {
           decision: "community-wrapper-rejected-not-provider-owned";
           modifiedAt: "2026-03-13T20:45:46.135Z";
           package: "@tradebuddyhq/ebay-wrapper";
           repository: "https://github.com/tradebuddyhq/ebay-wrapper";
           version: "2.0.0";
        }];
        defaultHttpClient: "providerJsonRequest-for-selected-rest-operations";
        officialUtilityPackagesChecked: readonly [{
           decision: "provider-owned-runtime-used-for-default-digital-signature-headers";
           modifiedAt: "2023-07-31T23:11:34.276Z";
           package: "digital-signature-nodejs-sdk";
           repository: "https://github.com/eBay/digital-signature-nodejs-sdk";
           runtimeUse: "generateDigestHeader, generateSignatureInput, and generateSignature are imported and used for default eBay digital signature header creation.";
           version: "3.0.1";
         }, {
           decision: "provider-owned-runtime-used-for-endpoint-challenge";
           modifiedAt: "2023-06-15T21:52:53.428Z";
           package: "event-notification-nodejs-sdk";
           repository: "https://github.com/eBay/event-notification-nodejs-sdk";
           runtimeUse: "validateEndpoint is imported and used for notification endpoint challenge responses; webhook payload parsing and public-key verification remain typed local code because the SDK process() helper owns a broader processor/OAuth flow than this adapter exposes.";
           version: "1.0.3";
         }, {
           decision: "provider-owned-oauth-helper-not-selected-rest-runtime";
           modifiedAt: "2023-06-15T21:52:53.428Z";
           package: "ebay-oauth-nodejs-client";
           reason: "OAuth helper only; it does not expose the selected Sell Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, or Commerce Identity operations.";
           repository: "https://github.com/eBay/ebay-oauth-nodejs-client";
           version: "1.2.2";
        }];
        providerClientOverride: true;
        sdkAuditCheckedAt: "2026-06-25";
        sdkDecision: "provider-owned-utility-sdks-used-no-provider-owned-general-rest-sdk";
        sdkDecisionReason: "eBay's provider-owned Node.js packages cover digital signatures, event notifications, and OAuth helpers rather than a general backend REST client for this selected Sell/Commerce/Developer support slice. This package uses the provider-owned utility SDKs at runtime where they fit, keeps a typed selected REST adapter for API operations, and rejects community REST wrappers as package defaults because they are not eBay/provider-owned.";
        selectedApiCount: 5;
        strategy: "provider-owned-utility-sdks-plus-selected-rest-adapter";
     };
     notificationDocs: "https://developer.ebay.com/api-docs/commerce/notification/overview.html";
     providerClient: {
        defaultClientPolicy: "built-in-rest-with-oauth-tokens-fail-closed";
        failClosedPolicy: "credential-missing-without-token-or-host-client";
        importPolicy: "optional-host-override";
        interface: "EbayMarketplaceProviderClient";
        package: "host-provided";
        transportPolicy: "package-owned-typed-provider-rest-adapter";
     };
     supportSlice: {
        allowlist: {
           alias: `ebay.${string}`;
           api:   | "sell.fulfillment"
              | "commerce.message"
              | "commerce.notification"
              | "developer.key-management"
              | "commerce.identity";
           method: "GET" | "POST" | "PUT" | "DELETE";
           operationId: string;
           path: string;
        }[];
        source: "official-ebay-openapi-selected-provider-contracts";
        specs: {
           api:   | "sell.fulfillment"
              | "commerce.message"
              | "commerce.notification"
              | "developer.key-management"
              | "commerce.identity";
           operationCount: 15 | 5 | 21 | 3 | 1;
           pathCount: 14 | 5 | 12 | 2 | 1;
           specUrl:   | "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json";
           version: "v1.20.7" | "1.0.0" | "v1.6.7" | "v1.0.0" | "v2.0.0";
        }[];
        verifiedAt: "2026-06-18";
     };
  };
  name: "eBay Marketplace";
  operations: {
     alias: `ebay.${string}`;
     capability: string;
     changesWorkflow: boolean;
     description: string;
     exposesSensitiveData: boolean;
     extension: boolean;
     label: keyof EbayMarketplaceProviderClient;
     metadata: {
        api:   | "sell.fulfillment"
           | "commerce.message"
           | "commerce.notification"
           | "developer.key-management"
           | "commerce.identity";
        method: "GET" | "POST" | "PUT" | "DELETE";
        operationId: string;
        path: string;
        specUrl: string;
     };
     providerObject: string;
     providerOperation: string;
     requiresCredential: boolean;
     sideEffect: boolean;
  }[];
  packageName: "@cognidesk/integration-marketplace-ebay";
  privacyNotes: readonly ["eBay orders, buyer/seller conversations, shipping fulfillments, disputes, refunds, notifications, and account profile records can contain customer data, addresses, item details, and internal support context.", "OAuth tokens, keyset secrets, notification verification tokens, public-key caches, and gateway shared secrets stay server-side; Studio receives only readiness and capability metadata."];
  provider: "ebay";
  trustLevel: "official";
}, EbayMarketplaceIntegrationOptions, EbayMarketplaceOperations>;

---

ebayMarketplaceProviderManifest

const ebayMarketplaceProviderManifest: {
  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: "Validates eBay notification endpoint challenges and parses signed Notification API events for SDK-user-owned marketplace workflows.";
     exposesSensitiveData: true;
     label: "Receive eBay notifications";
     providerObjects: readonly [{
        kind: "ebayNotification";
        label: "eBay Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Reads eBay seller orders, shipping fulfillments, payment disputes, message conversations, account profile details, and notification destinations/subscriptions.";
     exposesSensitiveData: true;
     label: "Read eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayOrder";
        label: "eBay Order";
      }, {
        kind: "ebayShippingFulfillment";
        label: "eBay Shipping Fulfillment";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayConversation";
        label: "eBay Conversation";
      }, {
        kind: "ebayUser";
        label: "eBay User";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "search-provider-object";
     description: "Searches orders, payment disputes, and message conversations with SDK-user-supplied eBay filters and pagination.";
     exposesSensitiveData: true;
     label: "Search eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayOrder";
        label: "eBay Order";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayConversation";
        label: "eBay Conversation";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "update-provider-object";
     changesWorkflow: true;
     description: "Updates eBay conversations, payment-dispute evidence or outcomes, and notification destination/subscription lifecycle when SDK-user policy permits marketplace mutations.";
     exposesSensitiveData: true;
     label: "Update eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayConversation";
        label: "eBay Conversation";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "delete-provider-object";
     changesWorkflow: true;
     description: "Deletes notification destinations, subscriptions, and filters only when the SDK user's marketplace policy allows lifecycle changes.";
     label: "Delete eBay marketplace resources";
     providerObjects: readonly [{
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     description: "Creates shipping fulfillments, buyer/seller messages, refunds, and payment-dispute actions only when SDK-user policy allows.";
     exposesSensitiveData: true;
     label: "Create eBay fulfillment and message records";
     providerObjects: readonly [{
        kind: "ebayShippingFulfillment";
        label: "eBay Shipping Fulfillment";
      }, {
        kind: "ebayMessage";
        label: "eBay Message";
      }, {
        kind: "ebayRefund";
        label: "eBay Refund";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "send";
     description: "Sends supported Commerce Message API messages to eBay conversations selected by the SDK user's workflow.";
     exposesSensitiveData: true;
     label: "Send eBay marketplace messages";
     providerObjects: readonly [{
        kind: "ebayMessage";
        label: "eBay Message";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.notification-signature";
     description: "Decodes X-EBAY-SIGNATURE, retrieves or accepts the SDK-user-cached public key, and verifies ECDSA/SHA1 payload signatures before parsing.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate eBay notification signatures";
     providerObjects: readonly [{
        kind: "ebaySignedNotification";
        label: "eBay Signed Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.digital-signature";
     changesWorkflow: true;
     description: "Adds Content-Digest, Signature, Signature-Input, and X-EBAY-SIGNATURE-KEY headers to issueRefund when EU/UK seller policy requires eBay HTTP Message Signatures.";
     extension: true;
     label: "Sign regulated eBay refund requests";
     providerObjects: readonly [{
        kind: "ebaySignedRequest";
        label: "eBay Signed Request";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.notification-challenge";
     description: "Computes the SHA-256 challengeResponse from challenge code, verification token, and endpoint URL for eBay destination setup.";
     extension: true;
     label: "Answer eBay notification challenges";
     providerObjects: readonly [{
        kind: "ebayNotificationChallenge";
        label: "eBay Notification Challenge";
     }];
     requiresCredential: true;
  }];
  category: "marketplace";
  channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "eBay Sell Fulfillment API";
        url: "https://developer.ebay.com/develop/api/sell/fulfillment_api";
      }, {
        label: "eBay Digital Signatures for APIs";
        url: "https://developer.ebay.com/develop/guides/digital-signatures-for-apis";
      }, {
        label: "eBay Key Management API";
        url: "https://developer.ebay.com/api-docs/developer/key-management/resources/methods";
      }, {
        label: "eBay Commerce Notification API resources";
        url: "https://developer.ebay.com/api-docs/commerce/notification/resources/methods";
      }, {
        label: "eBay Commerce Notification API overview";
        url: "https://developer.ebay.com/api-docs/commerce/notification/overview.html";
      }, {
        label: "eBay Notification getPublicKey";
        url: "https://developer.ebay.com/api-docs/commerce/notification/resources/public_key/methods/getPublicKey";
      }, {
        label: "eBay OAuth client credentials grant flow";
        url: "https://developer.ebay.com/develop/guides-v2/authorization#the-client-credentials-grant-flow";
      }, {
        label: "eBay Commerce Message API";
        url: "https://developer.ebay.com/api-docs/commerce/message/resources/methods";
      }, {
        label: "eBay OpenAPI specifications";
        url: "https://developer.ebay.com/api-docs/static/gs_take-advantage-of-openapi.html";
      }, {
        label: "eBay Fulfillment OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json";
      }, {
        label: "eBay Commerce Message OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json";
      }, {
        label: "eBay Commerce Notification OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json";
      }, {
        label: "eBay Developer Key Management OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json";
      }, {
        label: "eBay Commerce Identity OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json";
     }];
     notes: readonly ["Coverage is limited to selected eBay marketplace support primitives: Sell Fulfillment order, shipping fulfillment, refund, and payment-dispute operations; Sell Commerce Message conversations; Commerce Notification destination/subscription/config/public-key operations; notification challenges; and signed notification parsing.", "The selected eBay OpenAPI slice documents the provider-client contract for every currently implemented Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, and Commerce Identity resource group operation, and this package ships a built-in REST adapter for those operations.", "The package does not implement full eBay API coverage for inventory/listing management, account policy breadth, marketing/promotions, analytics/reporting, taxonomy/metadata, media, translation, buy APIs, finances beyond supported fulfillment dispute routes, Negotiation/Leads/Charity/Media APIs, or older Trading/Browse/Finding surfaces.", "Runtime provider-data operations use the built-in typed eBay REST adapter when OAuth token/environment/baseUrl/fetch options are provided; host-injected providerClient remains available as an override and must implement the selected operation contract.", "Local helpers for eBay notification challenge/signature parsing and HTTP Message Signature header creation remain available for host clients and webhook handlers.", "The SDK user owns OAuth grant/scopes, marketplace selection, notification topic and filter policy, public-key cache freshness, refund/dispute authority, outbound messaging policy, consent, redaction, retention decisions, and optional provider-client override runtime."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     description: "Server-side OAuth user token with SDK-user-selected Sell, Commerce Message, Identity, and Notification scopes.";
     id: "ebay-oauth-access-token";
     label: "eBay OAuth user access token";
     metadata: {
        scopeKind: "provider-oauth-scopes";
     };
     required: true;
     scopes: readonly ["https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly", "https://api.ebay.com/oauth/api_scope/commerce.message", "https://api.ebay.com/oauth/api_scope/commerce.identity.readonly", "https://api.ebay.com/oauth/api_scope/commerce.notification.subscription"];
   }, {
     description: "Client-credentials OAuth token with https://api.ebay.com/oauth/api_scope for Notification public-key retrieval.";
     id: "ebay-application-access-token";
     label: "eBay application access token";
     metadata: {
        scopeKind: "provider-oauth-scopes";
     };
     required: true;
     scopes: readonly ["https://api.ebay.com/oauth/api_scope"];
   }, {
     description: "Application keyset client ID owned by the SDK user for OAuth and notification ownership metadata.";
     id: "ebay-client-id";
     label: "eBay application client ID";
     required: true;
   }, {
     description: "Application keyset client secret kept server-side by the SDK user for OAuth token lifecycle operations.";
     id: "ebay-client-secret";
     label: "eBay application client secret";
     required: true;
   }, {
     description: "SDK-user-selected marketplace such as EBAY_US or EBAY_DE, forwarded through X-EBAY-C-MARKETPLACE-ID where supported.";
     id: "ebay-marketplace-id";
     label: "eBay marketplace ID";
     required: true;
   }, {
     description: "Optional host-injected client implementing EbayMarketplaceProviderClient when the SDK user wants to override the built-in REST adapter.";
     id: "ebay-provider-client";
     label: "Optional eBay marketplace provider client override";
     required: false;
   }, {
     description: "Destination verification token used to answer eBay challenge_code requests for notification endpoints.";
     id: "ebay-notification-verification-token";
     label: "eBay notification verification token";
     required: true;
   }, {
     description: "Key Management API private key and public-key JWE required for issueRefund when EU/UK seller or SDK policy requires HTTP Message Signatures.";
     id: "ebay-digital-signature-key";
     label: "eBay digital signature keypair";
     required: false;
  }];
  directions: readonly ["receive-only", "send-only", "bidirectional"];
  id: "marketplace.ebay";
  limitations: readonly ["The SDK user chooses marketplaces, OAuth flows, scopes, notification topics, subscription filters, operator visibility, outbound messaging policy, refund/dispute rules, retention, consent, and redaction.", "Some eBay APIs are entitlement, marketplace, scope, topic, or sandbox limited; this package exposes a typed REST/provider-client contract and does not decide whether a seller is eligible for a specific action.", "Provider-data operations fail closed unless OAuth tokens are provided for the built-in typed REST adapter or an injected EbayMarketplaceProviderClient implements the selected operation.", "The local issueRefund signature helper is fail-closed when EU/UK seller or SDK policy requires digital signatures and no eBay signing key material is configured.", "Notification signature verification requires a valid eBay public key retrieved by key ID from the Notification API or a SDK-user-provided verifier/cache implementation."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     channelCoverage: {
        conversationBulkUpdate: "typed-update";
        conversations: "typed-read-search-update";
        digitalSignatures: "typed-sign";
        inventoryMarketingAnalyticsBuyApis: "provider-supported-not-typed";
        keyManagementSigningKeys: "typed-create-read-list";
        messages: "typed-send";
        notificationChallenge: "typed-response";
        notificationConfig: "typed-read-update";
        notificationDestinations: "typed-create-read-list-update-delete";
        notificationFilters: "typed-create-read-delete";
        notificationSignatures: "typed-verify";
        notificationSubscriptions: "typed-create-read-list-update-enable-disable-test-delete";
        notificationTopics: "typed-read-list";
        orders: "typed-read-search";
        paymentDisputeEvidence: "typed-read-upload-add-update";
        paymentDisputes: "typed-read-search-update";
        refunds: "typed-create";
        shippingFulfillments: "typed-create-read-list";
        userProfile: "typed-read";
     };
     docs: "https://developer.ebay.com/api-docs";
     fulfillmentDocs: "https://developer.ebay.com/api-docs/sell/fulfillment/overview.html";
     generatedProviderSliceVerification: {
        apiVersion: string;
        coverageArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json";
        documentedOperationCount: 45;
        documentedPathCount: 34;
        functionCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.functions.json";
        generatedFunctionCount: 45;
        implementedOperationCount: 45;
        operationCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json";
        provider: "ebay-provider-rest-adapter";
        unimplementedOperationCount: 0;
        verifiedAt: "2026-06-18";
     };
     implementation: {
        checkedAt: "2026-06-18";
        communityRestPackagesChecked: readonly [{
           decision: "community-wrapper-rejected-not-provider-owned";
           modifiedAt: "2026-05-11T08:17:20.577Z";
           package: "ebay-api";
           repository: "https://github.com/hendt/ebay-api";
           version: "9.5.2";
         }, {
           decision: "community-wrapper-rejected-not-provider-owned";
           modifiedAt: "2026-03-13T20:45:46.135Z";
           package: "@tradebuddyhq/ebay-wrapper";
           repository: "https://github.com/tradebuddyhq/ebay-wrapper";
           version: "2.0.0";
        }];
        defaultHttpClient: "providerJsonRequest-for-selected-rest-operations";
        officialUtilityPackagesChecked: readonly [{
           decision: "provider-owned-runtime-used-for-default-digital-signature-headers";
           modifiedAt: "2023-07-31T23:11:34.276Z";
           package: "digital-signature-nodejs-sdk";
           repository: "https://github.com/eBay/digital-signature-nodejs-sdk";
           runtimeUse: "generateDigestHeader, generateSignatureInput, and generateSignature are imported and used for default eBay digital signature header creation.";
           version: "3.0.1";
         }, {
           decision: "provider-owned-runtime-used-for-endpoint-challenge";
           modifiedAt: "2023-06-15T21:52:53.428Z";
           package: "event-notification-nodejs-sdk";
           repository: "https://github.com/eBay/event-notification-nodejs-sdk";
           runtimeUse: "validateEndpoint is imported and used for notification endpoint challenge responses; webhook payload parsing and public-key verification remain typed local code because the SDK process() helper owns a broader processor/OAuth flow than this adapter exposes.";
           version: "1.0.3";
         }, {
           decision: "provider-owned-oauth-helper-not-selected-rest-runtime";
           modifiedAt: "2023-06-15T21:52:53.428Z";
           package: "ebay-oauth-nodejs-client";
           reason: "OAuth helper only; it does not expose the selected Sell Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, or Commerce Identity operations.";
           repository: "https://github.com/eBay/ebay-oauth-nodejs-client";
           version: "1.2.2";
        }];
        providerClientOverride: true;
        sdkAuditCheckedAt: "2026-06-25";
        sdkDecision: "provider-owned-utility-sdks-used-no-provider-owned-general-rest-sdk";
        sdkDecisionReason: "eBay's provider-owned Node.js packages cover digital signatures, event notifications, and OAuth helpers rather than a general backend REST client for this selected Sell/Commerce/Developer support slice. This package uses the provider-owned utility SDKs at runtime where they fit, keeps a typed selected REST adapter for API operations, and rejects community REST wrappers as package defaults because they are not eBay/provider-owned.";
        selectedApiCount: 5;
        strategy: "provider-owned-utility-sdks-plus-selected-rest-adapter";
     };
     notificationDocs: "https://developer.ebay.com/api-docs/commerce/notification/overview.html";
     providerClient: {
        defaultClientPolicy: "built-in-rest-with-oauth-tokens-fail-closed";
        failClosedPolicy: "credential-missing-without-token-or-host-client";
        importPolicy: "optional-host-override";
        interface: "EbayMarketplaceProviderClient";
        package: "host-provided";
        transportPolicy: "package-owned-typed-provider-rest-adapter";
     };
     supportSlice: {
        allowlist: {
           alias: `ebay.${string}`;
           api:   | "sell.fulfillment"
              | "commerce.message"
              | "commerce.notification"
              | "developer.key-management"
              | "commerce.identity";
           method: "GET" | "POST" | "PUT" | "DELETE";
           operationId: string;
           path: string;
        }[];
        source: "official-ebay-openapi-selected-provider-contracts";
        specs: {
           api:   | "sell.fulfillment"
              | "commerce.message"
              | "commerce.notification"
              | "developer.key-management"
              | "commerce.identity";
           operationCount: 15 | 5 | 21 | 3 | 1;
           pathCount: 14 | 5 | 12 | 2 | 1;
           specUrl:   | "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json";
           version: "v1.20.7" | "1.0.0" | "v1.6.7" | "v1.0.0" | "v2.0.0";
        }[];
        verifiedAt: "2026-06-18";
     };
  };
  name: "eBay Marketplace";
  operations: {
     alias: `ebay.${string}`;
     capability: string;
     changesWorkflow: boolean;
     description: string;
     exposesSensitiveData: boolean;
     extension: boolean;
     label: keyof EbayMarketplaceProviderClient;
     metadata: {
        api:   | "sell.fulfillment"
           | "commerce.message"
           | "commerce.notification"
           | "developer.key-management"
           | "commerce.identity";
        method: "GET" | "POST" | "PUT" | "DELETE";
        operationId: string;
        path: string;
        specUrl: string;
     };
     providerObject: string;
     providerOperation: string;
     requiresCredential: boolean;
     sideEffect: boolean;
  }[];
  packageName: "@cognidesk/integration-marketplace-ebay";
  privacyNotes: readonly ["eBay orders, buyer/seller conversations, shipping fulfillments, disputes, refunds, notifications, and account profile records can contain customer data, addresses, item details, and internal support context.", "OAuth tokens, keyset secrets, notification verification tokens, public-key caches, and gateway shared secrets stay server-side; Studio receives only readiness and capability metadata."];
  provider: "ebay";
  trustLevel: "official";
};

Type Declaration

Name	Type
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"; }
coverage.evidence	{ label: string; url?: string; }[]
coverage.notes	string[]
coverage.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"

Type Declaration

Name	Type
capabilities	readonly [{ audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "receive"; description: "Validates eBay notification endpoint challenges and parses signed Notification API events for SDK-user-owned marketplace workflows."; exposesSensitiveData: true; label: "Receive eBay notifications"; providerObjects: readonly [{ kind: "ebayNotification"; label: "eBay Notification"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "read-provider-object"; description: "Reads eBay seller orders, shipping fulfillments, payment disputes, message conversations, account profile details, and notification destinations/subscriptions."; exposesSensitiveData: true; label: "Read eBay marketplace records"; providerObjects: readonly [{ kind: "ebayOrder"; label: "eBay Order"; }, { kind: "ebayShippingFulfillment"; label: "eBay Shipping Fulfillment"; }, { kind: "ebayPaymentDispute"; label: "eBay Payment Dispute"; }, { kind: "ebayConversation"; label: "eBay Conversation"; }, { kind: "ebayUser"; label: "eBay User"; }, { kind: "ebayNotificationDestination"; label: "eBay Notification Destination"; }, { kind: "ebayNotificationSubscription"; label: "eBay Notification Subscription"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "search-provider-object"; description: "Searches orders, payment disputes, and message conversations with SDK-user-supplied eBay filters and pagination."; exposesSensitiveData: true; label: "Search eBay marketplace records"; providerObjects: readonly [{ kind: "ebayOrder"; label: "eBay Order"; }, { kind: "ebayPaymentDispute"; label: "eBay Payment Dispute"; }, { kind: "ebayConversation"; label: "eBay Conversation"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "update-provider-object"; changesWorkflow: true; description: "Updates eBay conversations, payment-dispute evidence or outcomes, and notification destination/subscription lifecycle when SDK-user policy permits marketplace mutations."; exposesSensitiveData: true; label: "Update eBay marketplace records"; providerObjects: readonly [{ kind: "ebayConversation"; label: "eBay Conversation"; }, { kind: "ebayPaymentDispute"; label: "eBay Payment Dispute"; }, { kind: "ebayNotificationDestination"; label: "eBay Notification Destination"; }, { kind: "ebayNotificationSubscription"; label: "eBay Notification Subscription"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "delete-provider-object"; changesWorkflow: true; description: "Deletes notification destinations, subscriptions, and filters only when the SDK user's marketplace policy allows lifecycle changes."; label: "Delete eBay marketplace resources"; providerObjects: readonly [{ kind: "ebayNotificationDestination"; label: "eBay Notification Destination"; }, { kind: "ebayNotificationSubscription"; label: "eBay Notification Subscription"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "create-provider-object"; changesWorkflow: true; description: "Creates shipping fulfillments, buyer/seller messages, refunds, and payment-dispute actions only when SDK-user policy allows."; exposesSensitiveData: true; label: "Create eBay fulfillment and message records"; providerObjects: readonly [{ kind: "ebayShippingFulfillment"; label: "eBay Shipping Fulfillment"; }, { kind: "ebayMessage"; label: "eBay Message"; }, { kind: "ebayRefund"; label: "eBay Refund"; }, { kind: "ebayNotificationDestination"; label: "eBay Notification Destination"; }, { kind: "ebayNotificationSubscription"; label: "eBay Notification Subscription"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "send"; description: "Sends supported Commerce Message API messages to eBay conversations selected by the SDK user's workflow."; exposesSensitiveData: true; label: "Send eBay marketplace messages"; providerObjects: readonly [{ kind: "ebayMessage"; label: "eBay Message"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support"]; capability: "marketplace.notification-signature"; description: "Decodes X-EBAY-SIGNATURE, retrieves or accepts the SDK-user-cached public key, and verifies ECDSA/SHA1 payload signatures before parsing."; exposesSensitiveData: true; extension: true; label: "Validate eBay notification signatures"; providerObjects: readonly [{ kind: "ebaySignedNotification"; label: "eBay Signed Notification"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support"]; capability: "marketplace.digital-signature"; changesWorkflow: true; description: "Adds Content-Digest, Signature, Signature-Input, and X-EBAY-SIGNATURE-KEY headers to issueRefund when EU/UK seller policy requires eBay HTTP Message Signatures."; extension: true; label: "Sign regulated eBay refund requests"; providerObjects: readonly [{ kind: "ebaySignedRequest"; label: "eBay Signed Request"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support"]; capability: "marketplace.notification-challenge"; description: "Computes the SHA-256 challengeResponse from challenge code, verification token, and endpoint URL for eBay destination setup."; extension: true; label: "Answer eBay notification challenges"; providerObjects: readonly [{ kind: "ebayNotificationChallenge"; label: "eBay Notification Challenge"; }]; requiresCredential: true; }]
category	"marketplace"
channelAudiences	readonly ["customer-facing", "internal-support", "mixed"]
coverage	{ evidence: readonly [{ label: "eBay Sell Fulfillment API"; url: "https://developer.ebay.com/develop/api/sell/fulfillment_api"; }, { label: "eBay Digital Signatures for APIs"; url: "https://developer.ebay.com/develop/guides/digital-signatures-for-apis"; }, { label: "eBay Key Management API"; url: "https://developer.ebay.com/api-docs/developer/key-management/resources/methods"; }, { label: "eBay Commerce Notification API resources"; url: "https://developer.ebay.com/api-docs/commerce/notification/resources/methods"; }, { label: "eBay Commerce Notification API overview"; url: "https://developer.ebay.com/api-docs/commerce/notification/overview.html"; }, { label: "eBay Notification getPublicKey"; url: "https://developer.ebay.com/api-docs/commerce/notification/resources/public_key/methods/getPublicKey"; }, { label: "eBay OAuth client credentials grant flow"; url: "https://developer.ebay.com/develop/guides-v2/authorization#the-client-credentials-grant-flow"; }, { label: "eBay Commerce Message API"; url: "https://developer.ebay.com/api-docs/commerce/message/resources/methods"; }, { label: "eBay OpenAPI specifications"; url: "https://developer.ebay.com/api-docs/static/gs_take-advantage-of-openapi.html"; }, { label: "eBay Fulfillment OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json"; }, { label: "eBay Commerce Message OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json"; }, { label: "eBay Commerce Notification OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json"; }, { label: "eBay Developer Key Management OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json"; }, { label: "eBay Commerce Identity OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json"; }]; notes: readonly ["Coverage is limited to selected eBay marketplace support primitives: Sell Fulfillment order, shipping fulfillment, refund, and payment-dispute operations; Sell Commerce Message conversations; Commerce Notification destination/subscription/config/public-key operations; notification challenges; and signed notification parsing.", "The selected eBay OpenAPI slice documents the provider-client contract for every currently implemented Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, and Commerce Identity resource group operation, and this package ships a built-in REST adapter for those operations.", "The package does not implement full eBay API coverage for inventory/listing management, account policy breadth, marketing/promotions, analytics/reporting, taxonomy/metadata, media, translation, buy APIs, finances beyond supported fulfillment dispute routes, Negotiation/Leads/Charity/Media APIs, or older Trading/Browse/Finding surfaces.", "Runtime provider-data operations use the built-in typed eBay REST adapter when OAuth token/environment/baseUrl/fetch options are provided; host-injected providerClient remains available as an override and must implement the selected operation contract.", "Local helpers for eBay notification challenge/signature parsing and HTTP Message Signature header creation remain available for host clients and webhook handlers.", "The SDK user owns OAuth grant/scopes, marketplace selection, notification topic and filter policy, public-key cache freshness, refund/dispute authority, outbound messaging policy, consent, redaction, retention decisions, and optional provider-client override runtime."]; scope: "support-workflow-subset"; }
coverage.evidence	readonly [{ label: "eBay Sell Fulfillment API"; url: "https://developer.ebay.com/develop/api/sell/fulfillment_api"; }, { label: "eBay Digital Signatures for APIs"; url: "https://developer.ebay.com/develop/guides/digital-signatures-for-apis"; }, { label: "eBay Key Management API"; url: "https://developer.ebay.com/api-docs/developer/key-management/resources/methods"; }, { label: "eBay Commerce Notification API resources"; url: "https://developer.ebay.com/api-docs/commerce/notification/resources/methods"; }, { label: "eBay Commerce Notification API overview"; url: "https://developer.ebay.com/api-docs/commerce/notification/overview.html"; }, { label: "eBay Notification getPublicKey"; url: "https://developer.ebay.com/api-docs/commerce/notification/resources/public_key/methods/getPublicKey"; }, { label: "eBay OAuth client credentials grant flow"; url: "https://developer.ebay.com/develop/guides-v2/authorization#the-client-credentials-grant-flow"; }, { label: "eBay Commerce Message API"; url: "https://developer.ebay.com/api-docs/commerce/message/resources/methods"; }, { label: "eBay OpenAPI specifications"; url: "https://developer.ebay.com/api-docs/static/gs_take-advantage-of-openapi.html"; }, { label: "eBay Fulfillment OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json"; }, { label: "eBay Commerce Message OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json"; }, { label: "eBay Commerce Notification OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json"; }, { label: "eBay Developer Key Management OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json"; }, { label: "eBay Commerce Identity OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json"; }]
coverage.notes	readonly ["Coverage is limited to selected eBay marketplace support primitives: Sell Fulfillment order, shipping fulfillment, refund, and payment-dispute operations; Sell Commerce Message conversations; Commerce Notification destination/subscription/config/public-key operations; notification challenges; and signed notification parsing.", "The selected eBay OpenAPI slice documents the provider-client contract for every currently implemented Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, and Commerce Identity resource group operation, and this package ships a built-in REST adapter for those operations.", "The package does not implement full eBay API coverage for inventory/listing management, account policy breadth, marketing/promotions, analytics/reporting, taxonomy/metadata, media, translation, buy APIs, finances beyond supported fulfillment dispute routes, Negotiation/Leads/Charity/Media APIs, or older Trading/Browse/Finding surfaces.", "Runtime provider-data operations use the built-in typed eBay REST adapter when OAuth token/environment/baseUrl/fetch options are provided; host-injected providerClient remains available as an override and must implement the selected operation contract.", "Local helpers for eBay notification challenge/signature parsing and HTTP Message Signature header creation remain available for host clients and webhook handlers.", "The SDK user owns OAuth grant/scopes, marketplace selection, notification topic and filter policy, public-key cache freshness, refund/dispute authority, outbound messaging policy, consent, redaction, retention decisions, and optional provider-client override runtime."]
coverage.scope	"support-workflow-subset"
credentialRequirements	readonly [{ description: "Server-side OAuth user token with SDK-user-selected Sell, Commerce Message, Identity, and Notification scopes."; id: "ebay-oauth-access-token"; label: "eBay OAuth user access token"; metadata: { scopeKind: "provider-oauth-scopes"; }; required: true; scopes: readonly ["https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly", "https://api.ebay.com/oauth/api_scope/commerce.message", "https://api.ebay.com/oauth/api_scope/commerce.identity.readonly", "https://api.ebay.com/oauth/api_scope/commerce.notification.subscription"]; }, { description: "Client-credentials OAuth token with https://api.ebay.com/oauth/api_scope for Notification public-key retrieval."; id: "ebay-application-access-token"; label: "eBay application access token"; metadata: { scopeKind: "provider-oauth-scopes"; }; required: true; scopes: readonly ["https://api.ebay.com/oauth/api_scope"]; }, { description: "Application keyset client ID owned by the SDK user for OAuth and notification ownership metadata."; id: "ebay-client-id"; label: "eBay application client ID"; required: true; }, { description: "Application keyset client secret kept server-side by the SDK user for OAuth token lifecycle operations."; id: "ebay-client-secret"; label: "eBay application client secret"; required: true; }, { description: "SDK-user-selected marketplace such as EBAY_US or EBAY_DE, forwarded through X-EBAY-C-MARKETPLACE-ID where supported."; id: "ebay-marketplace-id"; label: "eBay marketplace ID"; required: true; }, { description: "Optional host-injected client implementing EbayMarketplaceProviderClient when the SDK user wants to override the built-in REST adapter."; id: "ebay-provider-client"; label: "Optional eBay marketplace provider client override"; required: false; }, { description: "Destination verification token used to answer eBay challenge_code requests for notification endpoints."; id: "ebay-notification-verification-token"; label: "eBay notification verification token"; required: true; }, { description: "Key Management API private key and public-key JWE required for issueRefund when EU/UK seller or SDK policy requires HTTP Message Signatures."; id: "ebay-digital-signature-key"; label: "eBay digital signature keypair"; required: false; }]
directions	readonly ["receive-only", "send-only", "bidirectional"]
id	"marketplace.ebay"
limitations	readonly ["The SDK user chooses marketplaces, OAuth flows, scopes, notification topics, subscription filters, operator visibility, outbound messaging policy, refund/dispute rules, retention, consent, and redaction.", "Some eBay APIs are entitlement, marketplace, scope, topic, or sandbox limited; this package exposes a typed REST/provider-client contract and does not decide whether a seller is eligible for a specific action.", "Provider-data operations fail closed unless OAuth tokens are provided for the built-in typed REST adapter or an injected EbayMarketplaceProviderClient implements the selected operation.", "The local issueRefund signature helper is fail-closed when EU/UK seller or SDK policy requires digital signatures and no eBay signing key material is configured.", "Notification signature verification requires a valid eBay public key retrieved by key ID from the Notification API or a SDK-user-provided verifier/cache implementation."]
maintainers	readonly [{ name: "Cognidesk"; type: "official"; }]
metadata	{ channelCoverage: { conversationBulkUpdate: "typed-update"; conversations: "typed-read-search-update"; digitalSignatures: "typed-sign"; inventoryMarketingAnalyticsBuyApis: "provider-supported-not-typed"; keyManagementSigningKeys: "typed-create-read-list"; messages: "typed-send"; notificationChallenge: "typed-response"; notificationConfig: "typed-read-update"; notificationDestinations: "typed-create-read-list-update-delete"; notificationFilters: "typed-create-read-delete"; notificationSignatures: "typed-verify"; notificationSubscriptions: "typed-create-read-list-update-enable-disable-test-delete"; notificationTopics: "typed-read-list"; orders: "typed-read-search"; paymentDisputeEvidence: "typed-read-upload-add-update"; paymentDisputes: "typed-read-search-update"; refunds: "typed-create"; shippingFulfillments: "typed-create-read-list"; userProfile: "typed-read"; }; docs: "https://developer.ebay.com/api-docs"; fulfillmentDocs: "https://developer.ebay.com/api-docs/sell/fulfillment/overview.html"; generatedProviderSliceVerification: { apiVersion: string; coverageArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json"; documentedOperationCount: 45; documentedPathCount: 34; functionCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.functions.json"; generatedFunctionCount: 45; implementedOperationCount: 45; operationCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json"; provider: "ebay-provider-rest-adapter"; unimplementedOperationCount: 0; verifiedAt: "2026-06-18"; }; implementation: { checkedAt: "2026-06-18"; communityRestPackagesChecked: readonly [{ decision: "community-wrapper-rejected-not-provider-owned"; modifiedAt: "2026-05-11T08:17:20.577Z"; package: "ebay-api"; repository: "https://github.com/hendt/ebay-api"; version: "9.5.2"; }, { decision: "community-wrapper-rejected-not-provider-owned"; modifiedAt: "2026-03-13T20:45:46.135Z"; package: "@tradebuddyhq/ebay-wrapper"; repository: "https://github.com/tradebuddyhq/ebay-wrapper"; version: "2.0.0"; }]; defaultHttpClient: "providerJsonRequest-for-selected-rest-operations"; officialUtilityPackagesChecked: readonly [{ decision: "provider-owned-runtime-used-for-default-digital-signature-headers"; modifiedAt: "2023-07-31T23:11:34.276Z"; package: "digital-signature-nodejs-sdk"; repository: "https://github.com/eBay/digital-signature-nodejs-sdk"; runtimeUse: "generateDigestHeader, generateSignatureInput, and generateSignature are imported and used for default eBay digital signature header creation."; version: "3.0.1"; }, { decision: "provider-owned-runtime-used-for-endpoint-challenge"; modifiedAt: "2023-06-15T21:52:53.428Z"; package: "event-notification-nodejs-sdk"; repository: "https://github.com/eBay/event-notification-nodejs-sdk"; runtimeUse: "validateEndpoint is imported and used for notification endpoint challenge responses; webhook payload parsing and public-key verification remain typed local code because the SDK process() helper owns a broader processor/OAuth flow than this adapter exposes."; version: "1.0.3"; }, { decision: "provider-owned-oauth-helper-not-selected-rest-runtime"; modifiedAt: "2023-06-15T21:52:53.428Z"; package: "ebay-oauth-nodejs-client"; reason: "OAuth helper only; it does not expose the selected Sell Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, or Commerce Identity operations."; repository: "https://github.com/eBay/ebay-oauth-nodejs-client"; version: "1.2.2"; }]; providerClientOverride: true; sdkAuditCheckedAt: "2026-06-25"; sdkDecision: "provider-owned-utility-sdks-used-no-provider-owned-general-rest-sdk"; sdkDecisionReason: "eBay's provider-owned Node.js packages cover digital signatures, event notifications, and OAuth helpers rather than a general backend REST client for this selected Sell/Commerce/Developer support slice. This package uses the provider-owned utility SDKs at runtime where they fit, keeps a typed selected REST adapter for API operations, and rejects community REST wrappers as package defaults because they are not eBay/provider-owned."; selectedApiCount: 5; strategy: "provider-owned-utility-sdks-plus-selected-rest-adapter"; }; notificationDocs: "https://developer.ebay.com/api-docs/commerce/notification/overview.html"; providerClient: { defaultClientPolicy: "built-in-rest-with-oauth-tokens-fail-closed"; failClosedPolicy: "credential-missing-without-token-or-host-client"; importPolicy: "optional-host-override"; interface: "EbayMarketplaceProviderClient"; package: "host-provided"; transportPolicy: "package-owned-typed-provider-rest-adapter"; }; supportSlice: { allowlist: { alias: `ebay.${string}`; api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; method: "GET" | "POST" | "PUT" | "DELETE"; operationId: string; path: string; }[]; source: "official-ebay-openapi-selected-provider-contracts"; specs: { api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; operationCount: 15 | 5 | 21 | 3 | 1; pathCount: 14 | 5 | 12 | 2 | 1; specUrl: | "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json"; version: "v1.20.7" | "1.0.0" | "v1.6.7" | "v1.0.0" | "v2.0.0"; }[]; verifiedAt: "2026-06-18"; }; }
metadata.channelCoverage	{ conversationBulkUpdate: "typed-update"; conversations: "typed-read-search-update"; digitalSignatures: "typed-sign"; inventoryMarketingAnalyticsBuyApis: "provider-supported-not-typed"; keyManagementSigningKeys: "typed-create-read-list"; messages: "typed-send"; notificationChallenge: "typed-response"; notificationConfig: "typed-read-update"; notificationDestinations: "typed-create-read-list-update-delete"; notificationFilters: "typed-create-read-delete"; notificationSignatures: "typed-verify"; notificationSubscriptions: "typed-create-read-list-update-enable-disable-test-delete"; notificationTopics: "typed-read-list"; orders: "typed-read-search"; paymentDisputeEvidence: "typed-read-upload-add-update"; paymentDisputes: "typed-read-search-update"; refunds: "typed-create"; shippingFulfillments: "typed-create-read-list"; userProfile: "typed-read"; }
metadata.channelCoverage.conversationBulkUpdate	"typed-update"
metadata.channelCoverage.conversations	"typed-read-search-update"
metadata.channelCoverage.digitalSignatures	"typed-sign"
metadata.channelCoverage.inventoryMarketingAnalyticsBuyApis	"provider-supported-not-typed"
metadata.channelCoverage.keyManagementSigningKeys	"typed-create-read-list"
metadata.channelCoverage.messages	"typed-send"
metadata.channelCoverage.notificationChallenge	"typed-response"
metadata.channelCoverage.notificationConfig	"typed-read-update"
metadata.channelCoverage.notificationDestinations	"typed-create-read-list-update-delete"
metadata.channelCoverage.notificationFilters	"typed-create-read-delete"
metadata.channelCoverage.notificationSignatures	"typed-verify"
metadata.channelCoverage.notificationSubscriptions	"typed-create-read-list-update-enable-disable-test-delete"
metadata.channelCoverage.notificationTopics	"typed-read-list"
metadata.channelCoverage.orders	"typed-read-search"
metadata.channelCoverage.paymentDisputeEvidence	"typed-read-upload-add-update"
metadata.channelCoverage.paymentDisputes	"typed-read-search-update"
metadata.channelCoverage.refunds	"typed-create"
metadata.channelCoverage.shippingFulfillments	"typed-create-read-list"
metadata.channelCoverage.userProfile	"typed-read"
metadata.docs	"https://developer.ebay.com/api-docs"
metadata.fulfillmentDocs	"https://developer.ebay.com/api-docs/sell/fulfillment/overview.html"
metadata.generatedProviderSliceVerification	{ apiVersion: string; coverageArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json"; documentedOperationCount: 45; documentedPathCount: 34; functionCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.functions.json"; generatedFunctionCount: 45; implementedOperationCount: 45; operationCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json"; provider: "ebay-provider-rest-adapter"; unimplementedOperationCount: 0; verifiedAt: "2026-06-18"; }
metadata.generatedProviderSliceVerification.apiVersion	string
metadata.generatedProviderSliceVerification.coverageArtifact	"docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json"
metadata.generatedProviderSliceVerification.documentedOperationCount	45
metadata.generatedProviderSliceVerification.documentedPathCount	34
metadata.generatedProviderSliceVerification.functionCatalogArtifact	"docs/provider-coverage/ebay-selected-api-2026-06-18.functions.json"
metadata.generatedProviderSliceVerification.generatedFunctionCount	45
metadata.generatedProviderSliceVerification.implementedOperationCount	45
metadata.generatedProviderSliceVerification.operationCatalogArtifact	"docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json"
metadata.generatedProviderSliceVerification.provider	"ebay-provider-rest-adapter"
metadata.generatedProviderSliceVerification.unimplementedOperationCount	0
metadata.generatedProviderSliceVerification.verifiedAt	"2026-06-18"
metadata.implementation	{ checkedAt: "2026-06-18"; communityRestPackagesChecked: readonly [{ decision: "community-wrapper-rejected-not-provider-owned"; modifiedAt: "2026-05-11T08:17:20.577Z"; package: "ebay-api"; repository: "https://github.com/hendt/ebay-api"; version: "9.5.2"; }, { decision: "community-wrapper-rejected-not-provider-owned"; modifiedAt: "2026-03-13T20:45:46.135Z"; package: "@tradebuddyhq/ebay-wrapper"; repository: "https://github.com/tradebuddyhq/ebay-wrapper"; version: "2.0.0"; }]; defaultHttpClient: "providerJsonRequest-for-selected-rest-operations"; officialUtilityPackagesChecked: readonly [{ decision: "provider-owned-runtime-used-for-default-digital-signature-headers"; modifiedAt: "2023-07-31T23:11:34.276Z"; package: "digital-signature-nodejs-sdk"; repository: "https://github.com/eBay/digital-signature-nodejs-sdk"; runtimeUse: "generateDigestHeader, generateSignatureInput, and generateSignature are imported and used for default eBay digital signature header creation."; version: "3.0.1"; }, { decision: "provider-owned-runtime-used-for-endpoint-challenge"; modifiedAt: "2023-06-15T21:52:53.428Z"; package: "event-notification-nodejs-sdk"; repository: "https://github.com/eBay/event-notification-nodejs-sdk"; runtimeUse: "validateEndpoint is imported and used for notification endpoint challenge responses; webhook payload parsing and public-key verification remain typed local code because the SDK process() helper owns a broader processor/OAuth flow than this adapter exposes."; version: "1.0.3"; }, { decision: "provider-owned-oauth-helper-not-selected-rest-runtime"; modifiedAt: "2023-06-15T21:52:53.428Z"; package: "ebay-oauth-nodejs-client"; reason: "OAuth helper only; it does not expose the selected Sell Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, or Commerce Identity operations."; repository: "https://github.com/eBay/ebay-oauth-nodejs-client"; version: "1.2.2"; }]; providerClientOverride: true; sdkAuditCheckedAt: "2026-06-25"; sdkDecision: "provider-owned-utility-sdks-used-no-provider-owned-general-rest-sdk"; sdkDecisionReason: "eBay's provider-owned Node.js packages cover digital signatures, event notifications, and OAuth helpers rather than a general backend REST client for this selected Sell/Commerce/Developer support slice. This package uses the provider-owned utility SDKs at runtime where they fit, keeps a typed selected REST adapter for API operations, and rejects community REST wrappers as package defaults because they are not eBay/provider-owned."; selectedApiCount: 5; strategy: "provider-owned-utility-sdks-plus-selected-rest-adapter"; }
metadata.implementation.checkedAt	"2026-06-18"
metadata.implementation.communityRestPackagesChecked	readonly [{ decision: "community-wrapper-rejected-not-provider-owned"; modifiedAt: "2026-05-11T08:17:20.577Z"; package: "ebay-api"; repository: "https://github.com/hendt/ebay-api"; version: "9.5.2"; }, { decision: "community-wrapper-rejected-not-provider-owned"; modifiedAt: "2026-03-13T20:45:46.135Z"; package: "@tradebuddyhq/ebay-wrapper"; repository: "https://github.com/tradebuddyhq/ebay-wrapper"; version: "2.0.0"; }]
metadata.implementation.defaultHttpClient	"providerJsonRequest-for-selected-rest-operations"
metadata.implementation.officialUtilityPackagesChecked	readonly [{ decision: "provider-owned-runtime-used-for-default-digital-signature-headers"; modifiedAt: "2023-07-31T23:11:34.276Z"; package: "digital-signature-nodejs-sdk"; repository: "https://github.com/eBay/digital-signature-nodejs-sdk"; runtimeUse: "generateDigestHeader, generateSignatureInput, and generateSignature are imported and used for default eBay digital signature header creation."; version: "3.0.1"; }, { decision: "provider-owned-runtime-used-for-endpoint-challenge"; modifiedAt: "2023-06-15T21:52:53.428Z"; package: "event-notification-nodejs-sdk"; repository: "https://github.com/eBay/event-notification-nodejs-sdk"; runtimeUse: "validateEndpoint is imported and used for notification endpoint challenge responses; webhook payload parsing and public-key verification remain typed local code because the SDK process() helper owns a broader processor/OAuth flow than this adapter exposes."; version: "1.0.3"; }, { decision: "provider-owned-oauth-helper-not-selected-rest-runtime"; modifiedAt: "2023-06-15T21:52:53.428Z"; package: "ebay-oauth-nodejs-client"; reason: "OAuth helper only; it does not expose the selected Sell Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, or Commerce Identity operations."; repository: "https://github.com/eBay/ebay-oauth-nodejs-client"; version: "1.2.2"; }]
metadata.implementation.providerClientOverride	true
metadata.implementation.sdkAuditCheckedAt	"2026-06-25"
metadata.implementation.sdkDecision	"provider-owned-utility-sdks-used-no-provider-owned-general-rest-sdk"
metadata.implementation.sdkDecisionReason	"eBay's provider-owned Node.js packages cover digital signatures, event notifications, and OAuth helpers rather than a general backend REST client for this selected Sell/Commerce/Developer support slice. This package uses the provider-owned utility SDKs at runtime where they fit, keeps a typed selected REST adapter for API operations, and rejects community REST wrappers as package defaults because they are not eBay/provider-owned."
metadata.implementation.selectedApiCount	5
metadata.implementation.strategy	"provider-owned-utility-sdks-plus-selected-rest-adapter"
metadata.notificationDocs	"https://developer.ebay.com/api-docs/commerce/notification/overview.html"
metadata.providerClient	{ defaultClientPolicy: "built-in-rest-with-oauth-tokens-fail-closed"; failClosedPolicy: "credential-missing-without-token-or-host-client"; importPolicy: "optional-host-override"; interface: "EbayMarketplaceProviderClient"; package: "host-provided"; transportPolicy: "package-owned-typed-provider-rest-adapter"; }
metadata.providerClient.defaultClientPolicy	"built-in-rest-with-oauth-tokens-fail-closed"
metadata.providerClient.failClosedPolicy	"credential-missing-without-token-or-host-client"
metadata.providerClient.importPolicy	"optional-host-override"
metadata.providerClient.interface	"EbayMarketplaceProviderClient"
metadata.providerClient.package	"host-provided"
metadata.providerClient.transportPolicy	"package-owned-typed-provider-rest-adapter"
metadata.supportSlice	{ allowlist: { alias: `ebay.${string}`; api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; method: "GET" | "POST" | "PUT" | "DELETE"; operationId: string; path: string; }[]; source: "official-ebay-openapi-selected-provider-contracts"; specs: { api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; operationCount: 15 | 5 | 21 | 3 | 1; pathCount: 14 | 5 | 12 | 2 | 1; specUrl: | "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json"; version: "v1.20.7" | "1.0.0" | "v1.6.7" | "v1.0.0" | "v2.0.0"; }[]; verifiedAt: "2026-06-18"; }
metadata.supportSlice.allowlist	{ alias: `ebay.${string}`; api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; method: "GET" | "POST" | "PUT" | "DELETE"; operationId: string; path: string; }[]
metadata.supportSlice.source	"official-ebay-openapi-selected-provider-contracts"
metadata.supportSlice.specs	{ api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; operationCount: 15 | 5 | 21 | 3 | 1; pathCount: 14 | 5 | 12 | 2 | 1; specUrl: | "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json"; version: "v1.20.7" | "1.0.0" | "v1.6.7" | "v1.0.0" | "v2.0.0"; }[]
metadata.supportSlice.verifiedAt	"2026-06-18"
name	"eBay Marketplace"
operations	{ alias: `ebay.${string}`; capability: string; changesWorkflow: boolean; description: string; exposesSensitiveData: boolean; extension: boolean; label: keyof EbayMarketplaceProviderClient; metadata: { api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; method: "GET" | "POST" | "PUT" | "DELETE"; operationId: string; path: string; specUrl: string; }; providerObject: string; providerOperation: string; requiresCredential: boolean; sideEffect: boolean; }[]
packageName	"@cognidesk/integration-marketplace-ebay"
privacyNotes	readonly ["eBay orders, buyer/seller conversations, shipping fulfillments, disputes, refunds, notifications, and account profile records can contain customer data, addresses, item details, and internal support context.", "OAuth tokens, keyset secrets, notification verification tokens, public-key caches, and gateway shared secrets stay server-side; Studio receives only readiness and capability metadata."]
provider	"ebay"
trustLevel	"official"

---

ebaySelectedApiFunctionCatalog

const ebaySelectedApiFunctionCatalog: keyof EbayMarketplaceProviderClient[];

---

ebaySelectedApiOperationCatalog

const ebaySelectedApiOperationCatalog: readonly EbaySelectedApiOperation[];

---

ebaySelectedApiSpecs

const ebaySelectedApiSpecs: readonly [{
  api: "sell.fulfillment";
  docsUrl: "https://developer.ebay.com/develop/api/sell/fulfillment_api";
  operationCount: 15;
  pathCount: 14;
  specUrl: "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json";
  title: "Fulfillment API";
  version: "v1.20.7";
}, {
  api: "commerce.message";
  docsUrl: "https://developer.ebay.com/api-docs/commerce/message/resources/methods";
  operationCount: 5;
  pathCount: 5;
  specUrl: "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json";
  title: "Message API";
  version: "1.0.0";
}, {
  api: "commerce.notification";
  docsUrl: "https://developer.ebay.com/api-docs/commerce/notification/resources/methods";
  operationCount: 21;
  pathCount: 12;
  specUrl: "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json";
  title: "Notification API";
  version: "v1.6.7";
}, {
  api: "developer.key-management";
  docsUrl: "https://developer.ebay.com/api-docs/developer/key-management/resources/methods";
  operationCount: 3;
  pathCount: 2;
  specUrl: "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json";
  title: "Key Management API";
  version: "v1.0.0";
}, {
  api: "commerce.identity";
  docsUrl: "https://developer.ebay.com/api-docs/commerce/identity/resources/user/methods/getUser";
  operationCount: 1;
  pathCount: 1;
  specUrl: "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json";
  title: "Identity API";
  version: "v2.0.0";
}];

Functions

createEbayDigitalSignatureHeaders()

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

Parameters

Parameter	Type
input	EbaySignedRequestInput & EbayDigitalSignatureOptions

Returns

Record\<string, string>

---

createEbayMarketplaceClient()

function createEbayMarketplaceClient(options?): EbayMarketplaceClient;

Parameters

Parameter	Type
options?	EbayMarketplaceClientOptions

Returns

EbayMarketplaceClient

---

createEbayMarketplaceIntegration()

function createEbayMarketplaceIntegration(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: "Validates eBay notification endpoint challenges and parses signed Notification API events for SDK-user-owned marketplace workflows.";
     exposesSensitiveData: true;
     label: "Receive eBay notifications";
     providerObjects: readonly [{
        kind: "ebayNotification";
        label: "eBay Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Reads eBay seller orders, shipping fulfillments, payment disputes, message conversations, account profile details, and notification destinations/subscriptions.";
     exposesSensitiveData: true;
     label: "Read eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayOrder";
        label: "eBay Order";
      }, {
        kind: "ebayShippingFulfillment";
        label: "eBay Shipping Fulfillment";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayConversation";
        label: "eBay Conversation";
      }, {
        kind: "ebayUser";
        label: "eBay User";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "search-provider-object";
     description: "Searches orders, payment disputes, and message conversations with SDK-user-supplied eBay filters and pagination.";
     exposesSensitiveData: true;
     label: "Search eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayOrder";
        label: "eBay Order";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayConversation";
        label: "eBay Conversation";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "update-provider-object";
     changesWorkflow: true;
     description: "Updates eBay conversations, payment-dispute evidence or outcomes, and notification destination/subscription lifecycle when SDK-user policy permits marketplace mutations.";
     exposesSensitiveData: true;
     label: "Update eBay marketplace records";
     providerObjects: readonly [{
        kind: "ebayConversation";
        label: "eBay Conversation";
      }, {
        kind: "ebayPaymentDispute";
        label: "eBay Payment Dispute";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "delete-provider-object";
     changesWorkflow: true;
     description: "Deletes notification destinations, subscriptions, and filters only when the SDK user's marketplace policy allows lifecycle changes.";
     label: "Delete eBay marketplace resources";
     providerObjects: readonly [{
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     description: "Creates shipping fulfillments, buyer/seller messages, refunds, and payment-dispute actions only when SDK-user policy allows.";
     exposesSensitiveData: true;
     label: "Create eBay fulfillment and message records";
     providerObjects: readonly [{
        kind: "ebayShippingFulfillment";
        label: "eBay Shipping Fulfillment";
      }, {
        kind: "ebayMessage";
        label: "eBay Message";
      }, {
        kind: "ebayRefund";
        label: "eBay Refund";
      }, {
        kind: "ebayNotificationDestination";
        label: "eBay Notification Destination";
      }, {
        kind: "ebayNotificationSubscription";
        label: "eBay Notification Subscription";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "mixed"];
     capability: "send";
     description: "Sends supported Commerce Message API messages to eBay conversations selected by the SDK user's workflow.";
     exposesSensitiveData: true;
     label: "Send eBay marketplace messages";
     providerObjects: readonly [{
        kind: "ebayMessage";
        label: "eBay Message";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.notification-signature";
     description: "Decodes X-EBAY-SIGNATURE, retrieves or accepts the SDK-user-cached public key, and verifies ECDSA/SHA1 payload signatures before parsing.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate eBay notification signatures";
     providerObjects: readonly [{
        kind: "ebaySignedNotification";
        label: "eBay Signed Notification";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.digital-signature";
     changesWorkflow: true;
     description: "Adds Content-Digest, Signature, Signature-Input, and X-EBAY-SIGNATURE-KEY headers to issueRefund when EU/UK seller policy requires eBay HTTP Message Signatures.";
     extension: true;
     label: "Sign regulated eBay refund requests";
     providerObjects: readonly [{
        kind: "ebaySignedRequest";
        label: "eBay Signed Request";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "marketplace.notification-challenge";
     description: "Computes the SHA-256 challengeResponse from challenge code, verification token, and endpoint URL for eBay destination setup.";
     extension: true;
     label: "Answer eBay notification challenges";
     providerObjects: readonly [{
        kind: "ebayNotificationChallenge";
        label: "eBay Notification Challenge";
     }];
     requiresCredential: true;
  }];
  category: "marketplace";
  channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "eBay Sell Fulfillment API";
        url: "https://developer.ebay.com/develop/api/sell/fulfillment_api";
      }, {
        label: "eBay Digital Signatures for APIs";
        url: "https://developer.ebay.com/develop/guides/digital-signatures-for-apis";
      }, {
        label: "eBay Key Management API";
        url: "https://developer.ebay.com/api-docs/developer/key-management/resources/methods";
      }, {
        label: "eBay Commerce Notification API resources";
        url: "https://developer.ebay.com/api-docs/commerce/notification/resources/methods";
      }, {
        label: "eBay Commerce Notification API overview";
        url: "https://developer.ebay.com/api-docs/commerce/notification/overview.html";
      }, {
        label: "eBay Notification getPublicKey";
        url: "https://developer.ebay.com/api-docs/commerce/notification/resources/public_key/methods/getPublicKey";
      }, {
        label: "eBay OAuth client credentials grant flow";
        url: "https://developer.ebay.com/develop/guides-v2/authorization#the-client-credentials-grant-flow";
      }, {
        label: "eBay Commerce Message API";
        url: "https://developer.ebay.com/api-docs/commerce/message/resources/methods";
      }, {
        label: "eBay OpenAPI specifications";
        url: "https://developer.ebay.com/api-docs/static/gs_take-advantage-of-openapi.html";
      }, {
        label: "eBay Fulfillment OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json";
      }, {
        label: "eBay Commerce Message OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json";
      }, {
        label: "eBay Commerce Notification OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json";
      }, {
        label: "eBay Developer Key Management OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json";
      }, {
        label: "eBay Commerce Identity OpenAPI 3 JSON";
        url: "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json";
     }];
     notes: readonly ["Coverage is limited to selected eBay marketplace support primitives: Sell Fulfillment order, shipping fulfillment, refund, and payment-dispute operations; Sell Commerce Message conversations; Commerce Notification destination/subscription/config/public-key operations; notification challenges; and signed notification parsing.", "The selected eBay OpenAPI slice documents the provider-client contract for every currently implemented Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, and Commerce Identity resource group operation, and this package ships a built-in REST adapter for those operations.", "The package does not implement full eBay API coverage for inventory/listing management, account policy breadth, marketing/promotions, analytics/reporting, taxonomy/metadata, media, translation, buy APIs, finances beyond supported fulfillment dispute routes, Negotiation/Leads/Charity/Media APIs, or older Trading/Browse/Finding surfaces.", "Runtime provider-data operations use the built-in typed eBay REST adapter when OAuth token/environment/baseUrl/fetch options are provided; host-injected providerClient remains available as an override and must implement the selected operation contract.", "Local helpers for eBay notification challenge/signature parsing and HTTP Message Signature header creation remain available for host clients and webhook handlers.", "The SDK user owns OAuth grant/scopes, marketplace selection, notification topic and filter policy, public-key cache freshness, refund/dispute authority, outbound messaging policy, consent, redaction, retention decisions, and optional provider-client override runtime."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     description: "Server-side OAuth user token with SDK-user-selected Sell, Commerce Message, Identity, and Notification scopes.";
     id: "ebay-oauth-access-token";
     label: "eBay OAuth user access token";
     metadata: {
        scopeKind: "provider-oauth-scopes";
     };
     required: true;
     scopes: readonly ["https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly", "https://api.ebay.com/oauth/api_scope/commerce.message", "https://api.ebay.com/oauth/api_scope/commerce.identity.readonly", "https://api.ebay.com/oauth/api_scope/commerce.notification.subscription"];
   }, {
     description: "Client-credentials OAuth token with https://api.ebay.com/oauth/api_scope for Notification public-key retrieval.";
     id: "ebay-application-access-token";
     label: "eBay application access token";
     metadata: {
        scopeKind: "provider-oauth-scopes";
     };
     required: true;
     scopes: readonly ["https://api.ebay.com/oauth/api_scope"];
   }, {
     description: "Application keyset client ID owned by the SDK user for OAuth and notification ownership metadata.";
     id: "ebay-client-id";
     label: "eBay application client ID";
     required: true;
   }, {
     description: "Application keyset client secret kept server-side by the SDK user for OAuth token lifecycle operations.";
     id: "ebay-client-secret";
     label: "eBay application client secret";
     required: true;
   }, {
     description: "SDK-user-selected marketplace such as EBAY_US or EBAY_DE, forwarded through X-EBAY-C-MARKETPLACE-ID where supported.";
     id: "ebay-marketplace-id";
     label: "eBay marketplace ID";
     required: true;
   }, {
     description: "Optional host-injected client implementing EbayMarketplaceProviderClient when the SDK user wants to override the built-in REST adapter.";
     id: "ebay-provider-client";
     label: "Optional eBay marketplace provider client override";
     required: false;
   }, {
     description: "Destination verification token used to answer eBay challenge_code requests for notification endpoints.";
     id: "ebay-notification-verification-token";
     label: "eBay notification verification token";
     required: true;
   }, {
     description: "Key Management API private key and public-key JWE required for issueRefund when EU/UK seller or SDK policy requires HTTP Message Signatures.";
     id: "ebay-digital-signature-key";
     label: "eBay digital signature keypair";
     required: false;
  }];
  directions: readonly ["receive-only", "send-only", "bidirectional"];
  id: "marketplace.ebay";
  limitations: readonly ["The SDK user chooses marketplaces, OAuth flows, scopes, notification topics, subscription filters, operator visibility, outbound messaging policy, refund/dispute rules, retention, consent, and redaction.", "Some eBay APIs are entitlement, marketplace, scope, topic, or sandbox limited; this package exposes a typed REST/provider-client contract and does not decide whether a seller is eligible for a specific action.", "Provider-data operations fail closed unless OAuth tokens are provided for the built-in typed REST adapter or an injected EbayMarketplaceProviderClient implements the selected operation.", "The local issueRefund signature helper is fail-closed when EU/UK seller or SDK policy requires digital signatures and no eBay signing key material is configured.", "Notification signature verification requires a valid eBay public key retrieved by key ID from the Notification API or a SDK-user-provided verifier/cache implementation."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     channelCoverage: {
        conversationBulkUpdate: "typed-update";
        conversations: "typed-read-search-update";
        digitalSignatures: "typed-sign";
        inventoryMarketingAnalyticsBuyApis: "provider-supported-not-typed";
        keyManagementSigningKeys: "typed-create-read-list";
        messages: "typed-send";
        notificationChallenge: "typed-response";
        notificationConfig: "typed-read-update";
        notificationDestinations: "typed-create-read-list-update-delete";
        notificationFilters: "typed-create-read-delete";
        notificationSignatures: "typed-verify";
        notificationSubscriptions: "typed-create-read-list-update-enable-disable-test-delete";
        notificationTopics: "typed-read-list";
        orders: "typed-read-search";
        paymentDisputeEvidence: "typed-read-upload-add-update";
        paymentDisputes: "typed-read-search-update";
        refunds: "typed-create";
        shippingFulfillments: "typed-create-read-list";
        userProfile: "typed-read";
     };
     docs: "https://developer.ebay.com/api-docs";
     fulfillmentDocs: "https://developer.ebay.com/api-docs/sell/fulfillment/overview.html";
     generatedProviderSliceVerification: {
        apiVersion: string;
        coverageArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json";
        documentedOperationCount: 45;
        documentedPathCount: 34;
        functionCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.functions.json";
        generatedFunctionCount: 45;
        implementedOperationCount: 45;
        operationCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json";
        provider: "ebay-provider-rest-adapter";
        unimplementedOperationCount: 0;
        verifiedAt: "2026-06-18";
     };
     implementation: {
        checkedAt: "2026-06-18";
        communityRestPackagesChecked: readonly [{
           decision: "community-wrapper-rejected-not-provider-owned";
           modifiedAt: "2026-05-11T08:17:20.577Z";
           package: "ebay-api";
           repository: "https://github.com/hendt/ebay-api";
           version: "9.5.2";
         }, {
           decision: "community-wrapper-rejected-not-provider-owned";
           modifiedAt: "2026-03-13T20:45:46.135Z";
           package: "@tradebuddyhq/ebay-wrapper";
           repository: "https://github.com/tradebuddyhq/ebay-wrapper";
           version: "2.0.0";
        }];
        defaultHttpClient: "providerJsonRequest-for-selected-rest-operations";
        officialUtilityPackagesChecked: readonly [{
           decision: "provider-owned-runtime-used-for-default-digital-signature-headers";
           modifiedAt: "2023-07-31T23:11:34.276Z";
           package: "digital-signature-nodejs-sdk";
           repository: "https://github.com/eBay/digital-signature-nodejs-sdk";
           runtimeUse: "generateDigestHeader, generateSignatureInput, and generateSignature are imported and used for default eBay digital signature header creation.";
           version: "3.0.1";
         }, {
           decision: "provider-owned-runtime-used-for-endpoint-challenge";
           modifiedAt: "2023-06-15T21:52:53.428Z";
           package: "event-notification-nodejs-sdk";
           repository: "https://github.com/eBay/event-notification-nodejs-sdk";
           runtimeUse: "validateEndpoint is imported and used for notification endpoint challenge responses; webhook payload parsing and public-key verification remain typed local code because the SDK process() helper owns a broader processor/OAuth flow than this adapter exposes.";
           version: "1.0.3";
         }, {
           decision: "provider-owned-oauth-helper-not-selected-rest-runtime";
           modifiedAt: "2023-06-15T21:52:53.428Z";
           package: "ebay-oauth-nodejs-client";
           reason: "OAuth helper only; it does not expose the selected Sell Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, or Commerce Identity operations.";
           repository: "https://github.com/eBay/ebay-oauth-nodejs-client";
           version: "1.2.2";
        }];
        providerClientOverride: true;
        sdkAuditCheckedAt: "2026-06-25";
        sdkDecision: "provider-owned-utility-sdks-used-no-provider-owned-general-rest-sdk";
        sdkDecisionReason: "eBay's provider-owned Node.js packages cover digital signatures, event notifications, and OAuth helpers rather than a general backend REST client for this selected Sell/Commerce/Developer support slice. This package uses the provider-owned utility SDKs at runtime where they fit, keeps a typed selected REST adapter for API operations, and rejects community REST wrappers as package defaults because they are not eBay/provider-owned.";
        selectedApiCount: 5;
        strategy: "provider-owned-utility-sdks-plus-selected-rest-adapter";
     };
     notificationDocs: "https://developer.ebay.com/api-docs/commerce/notification/overview.html";
     providerClient: {
        defaultClientPolicy: "built-in-rest-with-oauth-tokens-fail-closed";
        failClosedPolicy: "credential-missing-without-token-or-host-client";
        importPolicy: "optional-host-override";
        interface: "EbayMarketplaceProviderClient";
        package: "host-provided";
        transportPolicy: "package-owned-typed-provider-rest-adapter";
     };
     supportSlice: {
        allowlist: {
           alias: `ebay.${string}`;
           api:   | "sell.fulfillment"
              | "commerce.message"
              | "commerce.notification"
              | "developer.key-management"
              | "commerce.identity";
           method: "GET" | "POST" | "PUT" | "DELETE";
           operationId: string;
           path: string;
        }[];
        source: "official-ebay-openapi-selected-provider-contracts";
        specs: {
           api:   | "sell.fulfillment"
              | "commerce.message"
              | "commerce.notification"
              | "developer.key-management"
              | "commerce.identity";
           operationCount: 1 | 3 | 5 | 15 | 21;
           pathCount: 1 | 2 | 5 | 12 | 14;
           specUrl:   | "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json"
              | "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json";
           version: "v1.20.7" | "1.0.0" | "v1.6.7" | "v1.0.0" | "v2.0.0";
        }[];
        verifiedAt: "2026-06-18";
     };
  };
  name: "eBay Marketplace";
  operations: {
     alias: `ebay.${string}`;
     capability: string;
     changesWorkflow: boolean;
     description: string;
     exposesSensitiveData: boolean;
     extension: boolean;
     label: keyof EbayMarketplaceProviderClient;
     metadata: {
        api:   | "sell.fulfillment"
           | "commerce.message"
           | "commerce.notification"
           | "developer.key-management"
           | "commerce.identity";
        method: "GET" | "POST" | "PUT" | "DELETE";
        operationId: string;
        path: string;
        specUrl: string;
     };
     providerObject: string;
     providerOperation: string;
     requiresCredential: boolean;
     sideEffect: boolean;
  }[];
  packageName: "@cognidesk/integration-marketplace-ebay";
  privacyNotes: readonly ["eBay orders, buyer/seller conversations, shipping fulfillments, disputes, refunds, notifications, and account profile records can contain customer data, addresses, item details, and internal support context.", "OAuth tokens, keyset secrets, notification verification tokens, public-key caches, and gateway shared secrets stay server-side; Studio receives only readiness and capability metadata."];
  provider: "ebay";
  trustLevel: "official";
}, EbayMarketplaceIntegrationOptions, EbayMarketplaceOperations>;

Parameters

Parameter	Type
options?	EbayMarketplaceIntegrationOptions

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: "Validates eBay notification endpoint challenges and parses signed Notification API events for SDK-user-owned marketplace workflows."; exposesSensitiveData: true; label: "Receive eBay notifications"; providerObjects: readonly [{ kind: "ebayNotification"; label: "eBay Notification"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "read-provider-object"; description: "Reads eBay seller orders, shipping fulfillments, payment disputes, message conversations, account profile details, and notification destinations/subscriptions."; exposesSensitiveData: true; label: "Read eBay marketplace records"; providerObjects: readonly [{ kind: "ebayOrder"; label: "eBay Order"; }, { kind: "ebayShippingFulfillment"; label: "eBay Shipping Fulfillment"; }, { kind: "ebayPaymentDispute"; label: "eBay Payment Dispute"; }, { kind: "ebayConversation"; label: "eBay Conversation"; }, { kind: "ebayUser"; label: "eBay User"; }, { kind: "ebayNotificationDestination"; label: "eBay Notification Destination"; }, { kind: "ebayNotificationSubscription"; label: "eBay Notification Subscription"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "search-provider-object"; description: "Searches orders, payment disputes, and message conversations with SDK-user-supplied eBay filters and pagination."; exposesSensitiveData: true; label: "Search eBay marketplace records"; providerObjects: readonly [{ kind: "ebayOrder"; label: "eBay Order"; }, { kind: "ebayPaymentDispute"; label: "eBay Payment Dispute"; }, { kind: "ebayConversation"; label: "eBay Conversation"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "update-provider-object"; changesWorkflow: true; description: "Updates eBay conversations, payment-dispute evidence or outcomes, and notification destination/subscription lifecycle when SDK-user policy permits marketplace mutations."; exposesSensitiveData: true; label: "Update eBay marketplace records"; providerObjects: readonly [{ kind: "ebayConversation"; label: "eBay Conversation"; }, { kind: "ebayPaymentDispute"; label: "eBay Payment Dispute"; }, { kind: "ebayNotificationDestination"; label: "eBay Notification Destination"; }, { kind: "ebayNotificationSubscription"; label: "eBay Notification Subscription"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "delete-provider-object"; changesWorkflow: true; description: "Deletes notification destinations, subscriptions, and filters only when the SDK user's marketplace policy allows lifecycle changes."; label: "Delete eBay marketplace resources"; providerObjects: readonly [{ kind: "ebayNotificationDestination"; label: "eBay Notification Destination"; }, { kind: "ebayNotificationSubscription"; label: "eBay Notification Subscription"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "create-provider-object"; changesWorkflow: true; description: "Creates shipping fulfillments, buyer/seller messages, refunds, and payment-dispute actions only when SDK-user policy allows."; exposesSensitiveData: true; label: "Create eBay fulfillment and message records"; providerObjects: readonly [{ kind: "ebayShippingFulfillment"; label: "eBay Shipping Fulfillment"; }, { kind: "ebayMessage"; label: "eBay Message"; }, { kind: "ebayRefund"; label: "eBay Refund"; }, { kind: "ebayNotificationDestination"; label: "eBay Notification Destination"; }, { kind: "ebayNotificationSubscription"; label: "eBay Notification Subscription"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["customer-facing", "mixed"]; capability: "send"; description: "Sends supported Commerce Message API messages to eBay conversations selected by the SDK user's workflow."; exposesSensitiveData: true; label: "Send eBay marketplace messages"; providerObjects: readonly [{ kind: "ebayMessage"; label: "eBay Message"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support"]; capability: "marketplace.notification-signature"; description: "Decodes X-EBAY-SIGNATURE, retrieves or accepts the SDK-user-cached public key, and verifies ECDSA/SHA1 payload signatures before parsing."; exposesSensitiveData: true; extension: true; label: "Validate eBay notification signatures"; providerObjects: readonly [{ kind: "ebaySignedNotification"; label: "eBay Signed Notification"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support"]; capability: "marketplace.digital-signature"; changesWorkflow: true; description: "Adds Content-Digest, Signature, Signature-Input, and X-EBAY-SIGNATURE-KEY headers to issueRefund when EU/UK seller policy requires eBay HTTP Message Signatures."; extension: true; label: "Sign regulated eBay refund requests"; providerObjects: readonly [{ kind: "ebaySignedRequest"; label: "eBay Signed Request"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["internal-support"]; capability: "marketplace.notification-challenge"; description: "Computes the SHA-256 challengeResponse from challenge code, verification token, and endpoint URL for eBay destination setup."; extension: true; label: "Answer eBay notification challenges"; providerObjects: readonly [{ kind: "ebayNotificationChallenge"; label: "eBay Notification Challenge"; }]; requiresCredential: true; }]; category: "marketplace"; channelAudiences: readonly ["customer-facing", "internal-support", "mixed"]; coverage: { evidence: readonly [{ label: "eBay Sell Fulfillment API"; url: "https://developer.ebay.com/develop/api/sell/fulfillment_api"; }, { label: "eBay Digital Signatures for APIs"; url: "https://developer.ebay.com/develop/guides/digital-signatures-for-apis"; }, { label: "eBay Key Management API"; url: "https://developer.ebay.com/api-docs/developer/key-management/resources/methods"; }, { label: "eBay Commerce Notification API resources"; url: "https://developer.ebay.com/api-docs/commerce/notification/resources/methods"; }, { label: "eBay Commerce Notification API overview"; url: "https://developer.ebay.com/api-docs/commerce/notification/overview.html"; }, { label: "eBay Notification getPublicKey"; url: "https://developer.ebay.com/api-docs/commerce/notification/resources/public_key/methods/getPublicKey"; }, { label: "eBay OAuth client credentials grant flow"; url: "https://developer.ebay.com/develop/guides-v2/authorization#the-client-credentials-grant-flow"; }, { label: "eBay Commerce Message API"; url: "https://developer.ebay.com/api-docs/commerce/message/resources/methods"; }, { label: "eBay OpenAPI specifications"; url: "https://developer.ebay.com/api-docs/static/gs_take-advantage-of-openapi.html"; }, { label: "eBay Fulfillment OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json"; }, { label: "eBay Commerce Message OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json"; }, { label: "eBay Commerce Notification OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json"; }, { label: "eBay Developer Key Management OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json"; }, { label: "eBay Commerce Identity OpenAPI 3 JSON"; url: "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json"; }]; notes: readonly ["Coverage is limited to selected eBay marketplace support primitives: Sell Fulfillment order, shipping fulfillment, refund, and payment-dispute operations; Sell Commerce Message conversations; Commerce Notification destination/subscription/config/public-key operations; notification challenges; and signed notification parsing.", "The selected eBay OpenAPI slice documents the provider-client contract for every currently implemented Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, and Commerce Identity resource group operation, and this package ships a built-in REST adapter for those operations.", "The package does not implement full eBay API coverage for inventory/listing management, account policy breadth, marketing/promotions, analytics/reporting, taxonomy/metadata, media, translation, buy APIs, finances beyond supported fulfillment dispute routes, Negotiation/Leads/Charity/Media APIs, or older Trading/Browse/Finding surfaces.", "Runtime provider-data operations use the built-in typed eBay REST adapter when OAuth token/environment/baseUrl/fetch options are provided; host-injected providerClient remains available as an override and must implement the selected operation contract.", "Local helpers for eBay notification challenge/signature parsing and HTTP Message Signature header creation remain available for host clients and webhook handlers.", "The SDK user owns OAuth grant/scopes, marketplace selection, notification topic and filter policy, public-key cache freshness, refund/dispute authority, outbound messaging policy, consent, redaction, retention decisions, and optional provider-client override runtime."]; scope: "support-workflow-subset"; }; credentialRequirements: readonly [{ description: "Server-side OAuth user token with SDK-user-selected Sell, Commerce Message, Identity, and Notification scopes."; id: "ebay-oauth-access-token"; label: "eBay OAuth user access token"; metadata: { scopeKind: "provider-oauth-scopes"; }; required: true; scopes: readonly ["https://api.ebay.com/oauth/api_scope/sell.fulfillment", "https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly", "https://api.ebay.com/oauth/api_scope/commerce.message", "https://api.ebay.com/oauth/api_scope/commerce.identity.readonly", "https://api.ebay.com/oauth/api_scope/commerce.notification.subscription"]; }, { description: "Client-credentials OAuth token with https://api.ebay.com/oauth/api_scope for Notification public-key retrieval."; id: "ebay-application-access-token"; label: "eBay application access token"; metadata: { scopeKind: "provider-oauth-scopes"; }; required: true; scopes: readonly ["https://api.ebay.com/oauth/api_scope"]; }, { description: "Application keyset client ID owned by the SDK user for OAuth and notification ownership metadata."; id: "ebay-client-id"; label: "eBay application client ID"; required: true; }, { description: "Application keyset client secret kept server-side by the SDK user for OAuth token lifecycle operations."; id: "ebay-client-secret"; label: "eBay application client secret"; required: true; }, { description: "SDK-user-selected marketplace such as EBAY_US or EBAY_DE, forwarded through X-EBAY-C-MARKETPLACE-ID where supported."; id: "ebay-marketplace-id"; label: "eBay marketplace ID"; required: true; }, { description: "Optional host-injected client implementing EbayMarketplaceProviderClient when the SDK user wants to override the built-in REST adapter."; id: "ebay-provider-client"; label: "Optional eBay marketplace provider client override"; required: false; }, { description: "Destination verification token used to answer eBay challenge_code requests for notification endpoints."; id: "ebay-notification-verification-token"; label: "eBay notification verification token"; required: true; }, { description: "Key Management API private key and public-key JWE required for issueRefund when EU/UK seller or SDK policy requires HTTP Message Signatures."; id: "ebay-digital-signature-key"; label: "eBay digital signature keypair"; required: false; }]; directions: readonly ["receive-only", "send-only", "bidirectional"]; id: "marketplace.ebay"; limitations: readonly ["The SDK user chooses marketplaces, OAuth flows, scopes, notification topics, subscription filters, operator visibility, outbound messaging policy, refund/dispute rules, retention, consent, and redaction.", "Some eBay APIs are entitlement, marketplace, scope, topic, or sandbox limited; this package exposes a typed REST/provider-client contract and does not decide whether a seller is eligible for a specific action.", "Provider-data operations fail closed unless OAuth tokens are provided for the built-in typed REST adapter or an injected EbayMarketplaceProviderClient implements the selected operation.", "The local issueRefund signature helper is fail-closed when EU/UK seller or SDK policy requires digital signatures and no eBay signing key material is configured.", "Notification signature verification requires a valid eBay public key retrieved by key ID from the Notification API or a SDK-user-provided verifier/cache implementation."]; maintainers: readonly [{ name: "Cognidesk"; type: "official"; }]; metadata: { channelCoverage: { conversationBulkUpdate: "typed-update"; conversations: "typed-read-search-update"; digitalSignatures: "typed-sign"; inventoryMarketingAnalyticsBuyApis: "provider-supported-not-typed"; keyManagementSigningKeys: "typed-create-read-list"; messages: "typed-send"; notificationChallenge: "typed-response"; notificationConfig: "typed-read-update"; notificationDestinations: "typed-create-read-list-update-delete"; notificationFilters: "typed-create-read-delete"; notificationSignatures: "typed-verify"; notificationSubscriptions: "typed-create-read-list-update-enable-disable-test-delete"; notificationTopics: "typed-read-list"; orders: "typed-read-search"; paymentDisputeEvidence: "typed-read-upload-add-update"; paymentDisputes: "typed-read-search-update"; refunds: "typed-create"; shippingFulfillments: "typed-create-read-list"; userProfile: "typed-read"; }; docs: "https://developer.ebay.com/api-docs"; fulfillmentDocs: "https://developer.ebay.com/api-docs/sell/fulfillment/overview.html"; generatedProviderSliceVerification: { apiVersion: string; coverageArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json"; documentedOperationCount: 45; documentedPathCount: 34; functionCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.functions.json"; generatedFunctionCount: 45; implementedOperationCount: 45; operationCatalogArtifact: "docs/provider-coverage/ebay-selected-api-2026-06-18.operations.json"; provider: "ebay-provider-rest-adapter"; unimplementedOperationCount: 0; verifiedAt: "2026-06-18"; }; implementation: { checkedAt: "2026-06-18"; communityRestPackagesChecked: readonly [{ decision: "community-wrapper-rejected-not-provider-owned"; modifiedAt: "2026-05-11T08:17:20.577Z"; package: "ebay-api"; repository: "https://github.com/hendt/ebay-api"; version: "9.5.2"; }, { decision: "community-wrapper-rejected-not-provider-owned"; modifiedAt: "2026-03-13T20:45:46.135Z"; package: "@tradebuddyhq/ebay-wrapper"; repository: "https://github.com/tradebuddyhq/ebay-wrapper"; version: "2.0.0"; }]; defaultHttpClient: "providerJsonRequest-for-selected-rest-operations"; officialUtilityPackagesChecked: readonly [{ decision: "provider-owned-runtime-used-for-default-digital-signature-headers"; modifiedAt: "2023-07-31T23:11:34.276Z"; package: "digital-signature-nodejs-sdk"; repository: "https://github.com/eBay/digital-signature-nodejs-sdk"; runtimeUse: "generateDigestHeader, generateSignatureInput, and generateSignature are imported and used for default eBay digital signature header creation."; version: "3.0.1"; }, { decision: "provider-owned-runtime-used-for-endpoint-challenge"; modifiedAt: "2023-06-15T21:52:53.428Z"; package: "event-notification-nodejs-sdk"; repository: "https://github.com/eBay/event-notification-nodejs-sdk"; runtimeUse: "validateEndpoint is imported and used for notification endpoint challenge responses; webhook payload parsing and public-key verification remain typed local code because the SDK process() helper owns a broader processor/OAuth flow than this adapter exposes."; version: "1.0.3"; }, { decision: "provider-owned-oauth-helper-not-selected-rest-runtime"; modifiedAt: "2023-06-15T21:52:53.428Z"; package: "ebay-oauth-nodejs-client"; reason: "OAuth helper only; it does not expose the selected Sell Fulfillment, Commerce Message, Commerce Notification, Developer Key Management, or Commerce Identity operations."; repository: "https://github.com/eBay/ebay-oauth-nodejs-client"; version: "1.2.2"; }]; providerClientOverride: true; sdkAuditCheckedAt: "2026-06-25"; sdkDecision: "provider-owned-utility-sdks-used-no-provider-owned-general-rest-sdk"; sdkDecisionReason: "eBay's provider-owned Node.js packages cover digital signatures, event notifications, and OAuth helpers rather than a general backend REST client for this selected Sell/Commerce/Developer support slice. This package uses the provider-owned utility SDKs at runtime where they fit, keeps a typed selected REST adapter for API operations, and rejects community REST wrappers as package defaults because they are not eBay/provider-owned."; selectedApiCount: 5; strategy: "provider-owned-utility-sdks-plus-selected-rest-adapter"; }; notificationDocs: "https://developer.ebay.com/api-docs/commerce/notification/overview.html"; providerClient: { defaultClientPolicy: "built-in-rest-with-oauth-tokens-fail-closed"; failClosedPolicy: "credential-missing-without-token-or-host-client"; importPolicy: "optional-host-override"; interface: "EbayMarketplaceProviderClient"; package: "host-provided"; transportPolicy: "package-owned-typed-provider-rest-adapter"; }; supportSlice: { allowlist: { alias: `ebay.${string}`; api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; method: "GET" | "POST" | "PUT" | "DELETE"; operationId: string; path: string; }[]; source: "official-ebay-openapi-selected-provider-contracts"; specs: { api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; operationCount: 1 | 3 | 5 | 15 | 21; pathCount: 1 | 2 | 5 | 12 | 14; specUrl: | "https://developer.ebay.com/api-docs/master/sell/fulfillment/openapi/3/sell_fulfillment_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/message/openapi/3/commerce_message_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/notification/openapi/3/commerce_notification_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/developer/key-management/openapi/3/developer_key_management_v1_oas3.json" | "https://developer.ebay.com/api-docs/master/commerce/identity/openapi/3/commerce_identity_v1_oas3.json"; version: "v1.20.7" | "1.0.0" | "v1.6.7" | "v1.0.0" | "v2.0.0"; }[]; verifiedAt: "2026-06-18"; }; }; name: "eBay Marketplace"; operations: { alias: `ebay.${string}`; capability: string; changesWorkflow: boolean; description: string; exposesSensitiveData: boolean; extension: boolean; label: keyof EbayMarketplaceProviderClient; metadata: { api: | "sell.fulfillment" | "commerce.message" | "commerce.notification" | "developer.key-management" | "commerce.identity"; method: "GET" | "POST" | "PUT" | "DELETE"; operationId: string; path: string; specUrl: string; }; providerObject: string; providerOperation: string; requiresCredential: boolean; sideEffect: boolean; }[]; packageName: "@cognidesk/integration-marketplace-ebay"; privacyNotes: readonly ["eBay orders, buyer/seller conversations, shipping fulfillments, disputes, refunds, notifications, and account profile records can contain customer data, addresses, item details, and internal support context.", "OAuth tokens, keyset secrets, notification verification tokens, public-key caches, and gateway shared secrets stay server-side; Studio receives only readiness and capability metadata."]; provider: "ebay"; trustLevel: "official"; }, EbayMarketplaceIntegrationOptions, EbayMarketplaceOperations>

---

createEbayMarketplaceIntegrationOperationHandlers()

function createEbayMarketplaceIntegrationOperationHandlers(options?): EbayMarketplaceOperations;

Parameters

Parameter	Type
options?	EbayMarketplaceIntegrationOptions

Returns

EbayMarketplaceOperations

---

createEbayMarketplaceLiveChecks()

function createEbayMarketplaceLiveChecks(options): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        marketplaceId: string;
        userId: string;
     };
  }>;
}[];

Parameters

Parameter	Type
options	EbayLiveCheckOptions

Returns

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

---

createEbayNotificationChallengeResponse()

function createEbayNotificationChallengeResponse(input): {
  challengeResponse: string;
};

Parameters

Parameter	Type
input	{ challengeCode: string; endpoint: string; verificationToken: string; }
input.challengeCode	string
input.endpoint	string
input.verificationToken	string

Returns

{
  challengeResponse: string;
}

Name	Type
challengeResponse	string

---

createEbayRestMarketplaceProviderClient()

function createEbayRestMarketplaceProviderClient(options?): EbayMarketplaceProviderClient;

Parameters

Parameter	Type
options?	Omit\<EbayMarketplaceClientOptions, "providerClient">

Returns

EbayMarketplaceProviderClient

---

createUnconfiguredEbayMarketplaceProviderClient()

function createUnconfiguredEbayMarketplaceProviderClient(): EbayMarketplaceProviderClient;

Returns

EbayMarketplaceProviderClient

---

ebayMarketplaceCredentialStatuses()

function ebayMarketplaceCredentialStatuses(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	EbayCredentialStatusInput

Returns

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

---

ebayMarketplaceOperationAlias()

function ebayMarketplaceOperationAlias(functionName): `ebay.${string}`;

Parameters

Parameter	Type
functionName	string

Returns

`ebay.${string}`

---

parseEbayNotificationSignatureHeader()

function parseEbayNotificationSignatureHeader(header): EbayNotificationSignatureHeader;

Parameters

Parameter	Type
header	string

Returns

EbayNotificationSignatureHeader

---

parseEbayNotificationWebhook()

function parseEbayNotificationWebhook(request, options?): Promise<EbayNotificationWebhook>;

Parameters

Parameter	Type
request	Request
options?	ParseEbayNotificationWebhookOptions

Returns

Promise\<EbayNotificationWebhook>

---

verifyEbayNotificationSignature()

function verifyEbayNotificationSignature(input): boolean;

Parameters

Parameter	Type
input	{ publicKey: string; rawBody: string | Buffer\<ArrayBufferLike>; signatureHeader: | string | EbayNotificationSignatureHeader; }
input.publicKey	string
input.rawBody	string | Buffer\<ArrayBufferLike>
input.signatureHeader	| string | EbayNotificationSignatureHeader

Returns

boolean