Overview
Configuration is provided for establishing connections with eBay service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we will show how to read data from the eBay service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the eBay service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://api.ebay.com
.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The authentication has the following user-defined parameters:
- scope: Required. Specify scope, you can find official documentation here - https://developer.ebay.com/api-docs/static/oauth-scopes.html
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.ebay.com/api-docs/static/oauth-tokens.html.
Based on resource template Analytic.
- [Read] action
-
Endpoint URL address:
/customer_service_metric/{{=parameters.customer_service_metric_type}}/{{=parameters.evaluation_type}}
.
The result is extracted from:{{=response.dimensionMetrics}}
.The action has the following user-defined parameters:
- evaluation_marketplace_id: Required. For help, refer to eBay API documentation at https://developer.ebay.com/devzone/rest/api-ref/analytics/types/MarketplaceIdEnum.html
- customer_service_metric_type: Required. Supported types are: ITEM_NOT_AS_DESCRIBED | ITEM_NOT_RECEIVED
- evaluation_type: Required. CURRENT; A monthly evaluation that occurs on the 20th of every month. PROJECTED; A daily evaluation.
Documentation: https://developer.ebay.com/api-docs/sell/analytics/resources/customer_service_metric/methods/getCustomerServiceMetric.
- dimension
Field components:
-
Uses template:
ShortText
. - Contains the following components: dimensionKey, name, value.
-
Uses template:
- metrics
Field components:
- An array.
- Contains the following components: benchmark, distributions, metricKey, value.
Based on resource template Analytic.
- [Read] action
-
Endpoint URL address:
/seller_standards_profile
.
The result is extracted from:{{=Ebay.getSellerProfileMetrics(profiles.standardsProfiles)}}
.Documentation: https://developer.ebay.com/api-docs/sell/analytics/resources/seller_standards_profile/methods/findSellerStandardsProfiles.
- [Read Single] action
-
Endpoint URL address:
/seller_standards_profile/{{=parameters.program}}/{{=parameters.cycle}}
.
The result is extracted from:{{=Ebay.getSellerProfileMetrics([response])}}
.The action has the following user-defined parameters:
- cycle: Required. CURRENT: reflects eBay's most recent monthly standards evaluation and PROJECTED: monthly evaluation.
- program: Required. Values: PROGRAM_DE, PROGRAM_UK, PROGRAM_US, or PROGRAM_GLOBAL.
Documentation: https://developer.ebay.com/api-docs/sell/analytics/resources/seller_standards_profile/methods/getSellerStandardsProfile.
- defaultProgram
Data type: DT_BOOL
- evaluationReason
Template: ShortText.
- program
Template: ShortText.
- standardsLevel
Template: ShortText.
- cycle
Field components:
-
Uses template:
ShortText
. - Contains the following components: cycleType, evaluationDate, evaluationMonth.
-
Uses template:
- [External]
-
The external fields URL address:
/seller_standards_profile
. The external fields list is extracted from:{{=_.flatten(_.pluck(response.standardsProfiles, 'metrics'))}}
.- {{=external.metricKey}}
Template: {{=Ebay.getFieldTemplate(external.type)}}.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/traffic_report
.
The result is extracted from:{{=Ebay.getReportData(response)}}
.The action has the following user-defined parameters:
- dimension: Required. Valid values: DAY or LISTING
- filter: Required. Refines the information returned in the traffic report. Documentation: https://developer.ebay.com/api-docs/sell/analytics/resources/traffic_report/methods/getTrafficReport
- metric: Required. Specifies the metrics you want covered in the report. Documentation: https://developer.ebay.com/api-docs/sell/analytics/resources/traffic_report/methods/getTrafficReport
- sort: Optional. Sorts the report on the specified metric. Documentation: https://developer.ebay.com/api-docs/sell/analytics/resources/traffic_report/methods/getTrafficReport
Documentation: https://developer.ebay.com/api-docs/sell/analytics/resources/traffic_report/methods/getTrafficReport.
- [External]
-
The external fields URL address:
/traffic_report
. The external fields list is extracted from:{{=Ebay.getReportFields(response)}}
.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/ad
.
The result is extracted from:{{=response.ads}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/getAds.
- [Read Single] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/ad/{{=parameters.ad_id}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
- ad_id: Required. This path parameter specifies the unique identifier of the ad being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/getAd.
- [Create] action
-
Endpoint URL address:
/ad_campaign/{{=item.campaignId}}/ad
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/createAdByListingId.
- [Delete] action
-
Endpoint URL address:
/ad_campaign/{{=item.campaignId}}/ad/{{=item.adId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/deleteAd.
The resource includes the fields from the Ad template.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: updateBid.
-
Uses template:
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/get_ads_by_inventory_reference
.
The result is extracted from:{{=response.Ads}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
- inventory_reference_type: Required. This query parameter specifies the type of the item the inventory_reference_id references.
- inventory_reference_id: Required. This query parameter specifies the unique identifier of a single-item listing or a multi-variation listing.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/getAdsByInventoryReference.
- [Create] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/bulk_create_ads_by_inventory_reference
.
The result is extracted from:{{=Ebay.getAdInBatchError(resource, response.responses || [])}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
The following request parameters will be automatically processed:
-
application/json:
{{={ requests: batch } }}
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkCreateAdsByInventoryReference.
- [Update] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/bulk_update_ads_bid_by_inventory_reference
.
The result is extracted from:{{=Ebay.getAdInBatchError(resource, response.responses || [])}}
.
The action uses POST method.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
The following request parameters will be automatically processed:
-
application/json:
{{={ requests: batch } }}
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkUpdateAdsBidByInventoryReference.
- [Delete] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/bulk_delete_ads_by_inventory_reference
.
The result is extracted from:{{=Ebay.getAdInBatchError(resource, response.responses || [])}}
.
The action uses POST method.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
The following request parameters will be automatically processed:
-
application/json:
{{={ requests: batch } }}
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad/methods/bulkDeleteAdsByInventoryReference..
The resource includes the fields from the Ad template.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/ad_group
.
The result is extracted from:{{=response.adGroups}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/getAdGroups.
- [Read Single] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/ad_group/{{=parameters.ad_group_id}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
- ad_group_id: Required. This path parameter specifies the unique identifier of the ad group being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/getAdGroup.
- [Create] action
-
Endpoint URL address:
/ad_campaign/{{=item.campaignId}}/ad_group
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/createAdGroup.
- [Update] action
-
Endpoint URL address:
/ad_campaign/{{=item.campaignId}}/ad_group/{{=item.adGroupId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/updateAdGroup.
- adGroupId
A key field. Template: ShortText.
- adGroupStatus
Template: ShortText. A read-only field.
- defaultBid
Template: Amount.
- name
Template: ShortText.
- campaignId
Template: Id.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/ad_group/{{=parameters.ad_group_id}}/suggest_bids
.
The result is extracted from:{{=response.suggestedBids}}
.
The action uses POST method.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
- keywords: Required. Specify in JSON format (e.g) {"keywords":[{"matchType":"EXACT","keywordText":"apple"}]}
- ad_group_id: Required. A comma-separated list of ad group IDs. The results will be filtered to only include active ads for these ad groups.
The following request parameters will be automatically processed:
-
application/json:
{{=JSON.parse(parameters.keywords)}}
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/suggestBids.
- keywordText
Template: ShortText.
- matchType
Template: ShortText.
- proposedBid
Field components:
-
Uses template:
ShortText
. - Contains the following components: currency, rangeEnd, rangeStart, value.
-
Uses template:
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/ad_group/{{=parameters.ad_group_id}}/suggest_keywords
.
The result is extracted from:{{=response.suggestedKeywords}}
.
The action uses POST method.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
- suggest_keywords: Required. An JSON for which keywords will be required. It has to be in the exact format shown in the documentation - https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/suggestKeywords
- ad_group_id: Required. A comma-separated list of ad group IDs. The results will be filtered to only include active ads for these ad groups.
The following request parameters will be automatically processed:
-
application/json:
{{=JSON.parse(parameters.suggest_keywords)}}
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_group/methods/suggestKeywords.
- additionalInfo
Field components:
- An array.
-
Uses template:
AdditionalInfo
.
- keywordText
Template: ShortText.
- matchType
Template: ShortText.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/keyword
.
The result is extracted from:{{=response.keywords}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
- keyword_status: A comma-separated list of keyword statuses.
- ad_group_ids: A comma-separated list of ad group IDs.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/getKeywords.
- [Read Single] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}/keyword/{{=parameters.keyword_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
- keyword_id: Required. This path parameter specifies the unique identifier for the keyword being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/getKeyword.
- [Create] action
-
Endpoint URL address:
/ad_campaign/{{=item.campaignId}}/keyword
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/createKeyword.
- [Update] action
-
Endpoint URL address:
/ad_campaign/{{=item.campaignId}}/keyword/{{=item.keywordId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/keyword/methods/updateKeyword.
- keywordId
A key field. Template: Id.
- adGroupId
Template: ShortText.
- bid
Template: Amount.
- keywordStatus
Template: ShortText. A read-only field.
- keywordText
Template: ShortText.
- matchType
Template: ShortText.
- campaignId
Template: Id.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/negative_keyword
.
The result is extracted from:{{=response.negativeKeywords}}
.The action has the following user-defined parameters:
- negative_keyword_status: A comma-separated list of keyword statuses.
- campaign_ids: This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the negative keywords being retrieved.
- ad_group_ids: Required. A comma-separated list of ad group IDs.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/getNegativeKeywords.
- [Read Single] action
-
Endpoint URL address:
/negative_keyword/{{=parameters.negative_keyword_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- negative_keyword_id: Required. This path parameter specifies the unique identifier for the negative keyword being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/getNegativeKeyword.
- [Create] action
-
Endpoint URL address:
/negative_keyword
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/createNegativeKeyword.
- [Update] action
-
Endpoint URL address:
/negative_keyword/{{=item.negativeKeywordId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/negative_keyword/methods/updateNegativeKeyword.
- negativeKeywordId
A key field. Template: Id.
- adGroupId
Template: Id.
- campaignId
Template: Id.
- negativeKeywordMatchType
Template: ShortText.
- negativeKeywordStatus
Template: ShortText.
- negativeKeywordText
Template: ShortText.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/ad_campaign
.
The result is extracted from:{{=response.campaigns}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaigns.
- [Read Single] action
-
Endpoint URL address:
/ad_campaign/{{=Ebay.UI.CampaignEditor.getValue(parameters)}}
.The action has the following user-defined parameters:
- campaign_id: Required. This path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the ads being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign.
- [Read name] action
-
Endpoint URL address:
/ad_campaign/get_campaign_by_name
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- campaign_name: Required. Specify to retrieve the campaign by name.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/getCampaignByName.
- [Read ad reference] action
-
Endpoint URL address:
/ad_campaign/find_campaign_by_ad_reference
.
The result is extracted from:{{=response.campaigns}}
.The action has the following user-defined parameters:
- listing_id: This query parameter specifies the unique identifier of the eBay listing associated with the ad being used to retrieve the campaign.
- inventory_reference_id: This query parameter specifies the unique identifier of a single-item listing or a multi-variation listing associated with the campaign being retrieved.
- inventory_reference_type: This query parameter specifies the type of the seller's inventory reference ID, which is a listing or group of items.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/findCampaignByAdReference.
- [Create] action
-
Endpoint URL address:
/ad_campaign
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/createCampaign.
- [Delete] action
-
Endpoint URL address:
/ad_campaign/{{=item.campaignId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/campaign/methods/deleteCampaign.
- campaignId
A key field. Template: Id.
- budget
Field components:
- Contains the following components: daily.
- campaignCriterion
Field components:
-
Uses template:
ShortText
. - Contains the following components: autoSelectFutureInventory, criterionType, selectionRules.
-
Uses template:
- campaignName
Template: ShortText.
- campaignStatus
Template: ShortText. A read-only field.
- channels
Template: LongText. A composite field.
- endDate
Template: DateTime.
- fundingStrategy
Template: FundingStrategy.
- marketplaceId
Template: ShortText.
- startDate
Template: DateTime.
- alerts
Field components:
- An array.
-
Uses template:
Alert
.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: clone, quickSetup, end, launch, pause, resume, updateAdRateStrategy, updateBiddingStrategy, updateCampaignBudget, updateCampaignIdentification.
-
Uses template:
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/inventory_item
.
The result is extracted from:{{=response.inventoryItems}}
.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item/methods/getInventoryItems.
- [Read Single] action
-
Endpoint URL address:
/inventory_item/{{=parameters.sku}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- sku: Required. This path parameter specifies the seller-defined SKU value of the product whose inventory item record you wish to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item/methods/getInventoryItem.
- [Upsert] action
-
Endpoint URL address:
/inventory_item/{{=item.sku}}
.
The action uses PUT method.The action has the following user-defined parameters:
- Content-Language: Required. This header sets the natural language that will be used in the field values of the request payload.
The following request parameters will be automatically processed:
-
Content-Language:
{{=parameters.get('Content-Language')}}
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item/methods/createOrReplaceInventoryItem.
- [Delete] action
-
Endpoint URL address:
/inventory_item/{{=item.sku}}
.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item/methods/deleteInventoryItem.
The resource includes the fields from the InventoryItem template.
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/inventory_item/{{=parameters.sku}}/product_compatibility
.
The result is extracted from:{{=response.compatibleProducts}}
.
The result is paginated.The action has the following user-defined parameters:
- sku: Required. Product sku.
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item/product_compatibility/methods/getProductCompatibility.
- [Upsert] action
-
Endpoint URL address:
/inventory_item/{{=item.sku}}/product_compatibility
.
The action uses PUT method.The action has the following user-defined parameters:
- Content-Language: Required. This header sets the natural language that will be used in the field values of the request payload.
The following request parameters will be automatically processed:
-
application/json:
{{={ compatibleProducts: [item] } }}
-
Content-Language:
{{=parameters.get('Content-Language')}}
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item/product_compatibility/methods/createOrReplaceProductCompatibility.
- [Delete] action
-
Endpoint URL address:
/inventory_item/{{=item.sku}}/product_compatibility
.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item/product_compatibility/methods/deleteProductCompatibility.
- sku
A key field. Template: ShortText.
- compatibilityProperties
Field components:
- An array.
-
Uses template:
NameValueList
.
- notes
Template: ShortText.
- productFamilyProperties
Field components:
-
Uses template:
ShortText
. - Contains the following components: engine, make, model, trim, year.
-
Uses template:
- productIdentifier
Field components:
-
Uses template:
ShortText
. - Contains the following components: epid, gtin, ktype.
-
Uses template:
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/inventory_item_group/{{=parameters.inventoryItemGroupKey}}
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- inventoryItemGroupKey: Required. This path parameter specifies the unique identifier of the inventory item group being retrieved. This value is assigned by the seller when an inventory item group is created.
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item_group/methods/getInventoryItemGroup.
- [Upsert] action
-
Endpoint URL address:
/inventory_item_group/{{=item.inventoryItemGroupKey}}
.
The action uses PUT method.The action has the following user-defined parameters:
- Content-Language: Required. This header sets the natural language that will be used in the field values of the request payload.
The following request parameters will be automatically processed:
-
Content-Language:
{{=parameters.get('Content-Language')}}
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item_group/methods/createOrReplaceInventoryItemGroup.
- [Delete] action
-
Endpoint URL address:
/inventory_item_group/{{=item.inventoryItemGroupKey}}
.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/inventory_item_group/methods/deleteInventoryItemGroup.
- inventoryItemGroupKey
A key field. Template: ShortText.
- aspects
Field components:
- An array.
-
Uses template:
AspectBuy
.
- description
Template: LongText.
- imageUrls
Template: LongText. A composite field.
- subtitle
Template: ShortText.
- title
Template: ShortText.
- variantSKUs
Template: LongText. A composite field.
- variesBy
Field components:
-
Uses template:
LongText
. - Contains the following components: aspectsImageVariesBy, specifications.
-
Uses template:
- videoIds
Template: LongText. A composite field.
Based on resource template Inventory.
- [Create] action
-
Endpoint URL address:
/bulk_migrate_listing
.
The result is extracted from:{{=undefined}}
.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ requests: batch } }}
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/listing/methods/bulkMigrateListing.
-
application/json:
- listingId
Template: ShortText.
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/offer
.
The result is extracted from:{{=response.offers}}
.The action has the following user-defined parameters:
- sku: Required. Specify the seller-defined SKU value.
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/offer/methods/getOffers.
- [Read Single] action
-
Endpoint URL address:
/offer/{{=parameters.offerId}}
.The action has the following user-defined parameters:
- offerId: Required. Specify the offer identifier.
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/offer/methods/getOffer.
- [Create] action
-
Endpoint URL address:
/offer
.The action has the following user-defined parameters:
- Content-Language: Required. This header sets the natural language that will be used in the field values of the request payload.
The following request parameters will be automatically processed:
-
Content-Language:
{{=parameters.get('Content-Language')}}
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/offer/methods/createOffer.
- [Update] action
-
Endpoint URL address:
/offer/{{=item.offerId}}
.The action has the following user-defined parameters:
- Content-Language: Required. This header sets the natural language that will be used in the field values of the request payload.
The following request parameters will be automatically processed:
-
Content-Language:
{{=parameters.get('Content-Language')}}
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/offer/methods/updateOffer.
- [Delete] action
-
Endpoint URL address:
/offer/{{=item.offerId}}
.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/offer/methods/deleteOffer.
- offerId
A key field. Template: ShortText.
- availableQuantity
Data type: DT_I4
- categoryId
Template: ShortText.
- charity
Field components:
-
Uses template:
ShortText
. - Contains the following components: charityId, donationPercentage.
-
Uses template:
- extendedProducerResponsibility
Field components:
-
Uses template:
Amount
. - Contains the following components: ecoParticipationFee, producerProductId, productDocumentationId, productPackageId, shipmentPackageId.
-
Uses template:
- format
Template: ShortText.
- hideBuyerDetails
Data type: DT_BOOL
- includeCatalogProductDetails
Data type: DT_BOOL
- listingDescription
Template: LongText.
- listingDuration
Template: ShortText.
- listingPolicies
Field components:
-
Uses template:
ShortText
. - Contains the following components: bestOfferTerms, eBayPlusIfEligible, fulfillmentPolicyId, paymentPolicyId, productCompliancePolicyIds, regionalProductCompliancePolicies, regionalTakeBackPolicies, returnPolicyId, shippingCostOverrides, takeBackPolicyId.
-
Uses template:
- listingStartDate
Template: DateTime.
- lotSize
Data type: DT_I4
- marketplaceId
Template: ShortText.
- merchantLocationKey
Template: ShortText.
- pricingSummary
Field components:
-
Uses template:
Amount
. - Contains the following components: auctionReservePrice, auctionStartPrice, minimumAdvertisedPrice, originallySoldForRetailPriceOn, originalRetailPrice, price, pricingVisibility.
-
Uses template:
- quantityLimitPerBuyer
Data type: DT_I4
- regulatory
Field components:
- Contains the following components: energyEfficiencyLabel, hazmat, repairScore.
- secondaryCategoryId
Template: ShortText.
- sku
Template: ShortText.
- storeCategoryNames
Template: LongText. A composite field.
- tax
Template: Tax.
- listing
Field components:
-
Uses template:
ShortText
. - Contains the following components: listingId, listingStatus, soldQuantity.
-
Uses template:
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: publishOffer, withdrawOffer, publishOfferByInventoiryGroup, withdrawOfferByInventoiryGroup.
-
Uses template:
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/location
.
The result is extracted from:{{=response.locations}}
.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/location/methods/getInventoryLocations.
- [Read Single] action
-
Endpoint URL address:
/location/{{=parameters.merchantLocationKey}}
.The action has the following user-defined parameters:
- merchantLocationKey: Required. This path parameter specifies the unique merchant-defined key (ID) for an inventory location that is being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/location/methods/getInventoryLocation.
- [Create] action
-
Endpoint URL address:
/location/{{=item.merchantLocationKey}}
.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/location/methods/createInventoryLocation.
- [Update] action
-
Endpoint URL address:
/location/{{=item.merchantLocationKey}}/update_location_details
.
The action uses POST method.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/location/methods/updateInventoryLocation.
- [Delete] action
-
Endpoint URL address:
/location/{{=item.merchantLocationKey}}
.Documentation: https://developer.ebay.com/api-docs/sell/inventory/resources/location/methods/deleteInventoryLocation.
- merchantLocationKey
A key field. Template: ShortText.
- location
Template: Location.
- locationAdditionalInformation
Template: ShortText.
- locationInstructions
Template: ShortText.
- locationTypes
Template: LongText. A composite field.
- locationWebUrl
Template: ShortText.
- merchantLocationStatus
Template: ShortText.
- name
Template: ShortText.
- operatingHours
Field components:
- An array.
- Contains the following components: dayOfWeekEnum, intervals.
- phone
Template: ShortText.
- specialHours
Field components:
- An array.
- Contains the following components: date, intervals.
- action
Field components:
-
Uses template:
ActionT
. - Contains the following components: enable, disable.
-
Uses template:
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/ad_report_task
.
The result is extracted from:{{=response.reportTasks}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_report_task/methods/getReportTasks.
- [Read Single] action
-
Endpoint URL address:
/ad_report_task/{{=parameters.report_task_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- report_task_id: Required. This path parameter specifies the unique identifier of the report task being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_report_task/methods/getReportTask.
- [Create] action
-
Endpoint URL address:
/ad_report_task
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_report_task/methods/createReportTask.
- [Delete] action
-
Endpoint URL address:
/ad_report_task/{{=item.report_task_id}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/ad_report_task/methods/deleteReportTask.
- report_task_id
A key field. Template: ShortText.
- additionalRecords
Template: LongText.
- campaignIds
Template: LongText. A composite field.
- channels
Template: LongText. A composite field.
- dateFrom
Template: DateTime.
- dateTo
Template: DateTime.
- fundingModels
Template: LongText. A composite field.
- inventoryReferences
Field components:
- An array.
- Contains the following components: inventoryReferenceId, inventoryReferenceType.
- listingIds
Template: LongText. A composite field.
- marketplaceId
Template: ShortText.
- metricKeys
Template: LongText. A composite field.
- reportExpirationDate
Template: ShortText. A read-only field.
- reportFormat
Template: ShortText.
- reportHref
Template: ShortText.
- reportId
Template: ShortText.
- reportName
Template: ShortText.
- reportTaskCompletionDate
Template: DateTime.
- reportTaskCreationDate
Template: DateTime.
- reportTaskExpectedCompletionDate
Template: DateTime.
- reportTaskId
Template: ShortText.
- reportTaskStatus
Template: ShortText.
- reportTaskStatusMessage
Template: ShortText.
- reportType
Template: ShortText.
- dimensions
Field components:
- An array.
-
Uses template:
Dimension
.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/item_price_markdown/{{=parameters.promotion_id}}
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- promotion_id: Required. This path parameter takes a concatenation of the ID of the promotion you want to retrieve plus the marketplace ID on which the promotion is hosted. Concatenate the two values by separating them with an "at sign" (@).
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/item_price_markdown/methods/getItemPriceMarkdownPromotion.
- [Create] action
-
Endpoint URL address:
/item_price_markdown
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/item_price_markdown/methods/createItemPriceMarkdownPromotion.
- [Update] action
-
Endpoint URL address:
/item_price_markdown/{{=item.promotion_id}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/item_price_markdown/methods/updateItemPriceMarkdownPromotion.
- [Delete] action
-
Endpoint URL address:
/item_price_markdown/{{=item.promotion_id}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/item_price_markdown/methods/deleteItemPriceMarkdownPromotion.
- promotion_id
A key field. Template: ShortText.
- applyFreeShipping
Data type: DT_BOOL
- autoSelectFutureInventory
Data type: DT_BOOL
- blockPriceIncreaseInItemRevision
Data type: DT_BOOL
- description
Template: LongText.
- endDate
Template: DateTime.
- marketplaceId
Template: ShortText.
- name
Template: ShortText.
- priority
Template: ShortText.
- promotionImageUrl
Template: LongText.
- promotionStatus
Template: ShortText.
- startDate
Template: DateTime.
- selectedInventoryDiscounts
Field components:
- An array.
- Contains the following components: discountBenefit, discountId, inventoryCriterion, ruleOrder.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/item_promotion/{{=parameters.promotion_id}}
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- promotion_id: Required. This path parameter takes a concatenation of the ID of the promotion you want to retrieve plus the marketplace ID on which the promotion is hosted. Concatenate the two values by separating them with an "at sign" (@).
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/item_promotion/methods/getItemPromotion.
- [Create] action
-
Endpoint URL address:
/item_promotion
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/item_promotion/methods/createItemPromotion.
- [Update] action
-
Endpoint URL address:
/item_promotion{{=item.promotionId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/item_promotion/methods/updateItemPromotion.
- [Delete] action
-
Endpoint URL address:
/item_promotion{{=item.promotionId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/item_promotion/methods/deleteItemPromotion.
- promotionId
A key field. Template: ShortText.
- applyDiscountToSingleItemOnly
Data type: DT_BOOL
- budget
Template: Amount.
- couponConfiguration
Field components:
-
Uses template:
ShortText
. - Contains the following components: couponCode, couponType, maxCouponRedemptionPerUser.
-
Uses template:
- description
Template: LongText.
- discountRules
Field components:
- An array.
- Contains the following components: discountBenefit, discountSpecification, maxDiscountAmount, ruleOrder.
- endDate
Template: DateTime.
- inventoryCriterion
Template: InventoryCriterion.
- marketplaceId
Template: ShortText.
- name
Template: ShortText.
- priority
Template: ShortText.
- promotionImageUrl
Template: LongText.
- promotionStatus
Template: ShortText.
- promotionType
Template: ShortText.
- startDate
Template: DateTime.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/promotion
.
The result is extracted from:{{=response.promotions}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This parameter specifies eBay marketplace ID of the site where the promotion is hosted.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/promotion/methods/getPromotions.
- promotionId
A key field. Template: ShortText.
- lastUpdated
Template: ShortText.
- averageItemDiscount
Template: Amount.
- averageItemRevenue
Template: Amount.
- averageOrderDiscount
Template: Amount.
- averageOrderRevenue
Template: Amount.
- averageOrderSize
Template: ShortText.
- baseSale
Template: Amount.
- itemsSoldQuantity
Data type: DT_I4
- numberOfOrdersSold
Data type: DT_I4
- percentageSalesLift
Template: ShortText.
- promotionReportId
Template: ShortText.
- promotionSale
Template: Amount.
- totalDiscount
Template: Amount.
- totalSale
Template: Amount.
- couponCode
Template: ShortText.
- description
Template: ShortText.
- endDate
Template: DateTime.
- marketplaceId
Template: ShortText.
- name
Template: ShortText.
- priority
Template: ShortText.
- promotionHref
Template: ShortText.
- promotionImageUrl
Template: ShortText.
- promotionStatus
Template: ShortText.
- promotionType
Template: ShortText.
- startDate
Template: DateTime.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/promotion/{{=parameters.promotion_id}}/get_listing_set
.
The result is extracted from:{{=response.listings}}
.The action has the following user-defined parameters:
- promotion_id: Required. This path parameter takes a concatenation of the ID of the promotion associated with the listing set plus the marketplace ID on which the promotion is hosted. Concatenate the two values by separating them with an "at sign" (@).
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/promotion/methods/getListingSet.
- listingId
A key field. Template: ShortText.
- currentPrice
Template: Amount.
- freeShipping
Data type: DT_BOOL
- inventoryReferenceId
Template: ShortText.
- inventoryReferenceType
Template: ShortText.
- listingCategoryId
Template: ShortText.
- listingCondition
Template: ShortText.
- listingConditionId
Template: ShortText.
- listingPromotionStatuses
Field components:
- An array.
- Contains the following components: listingMarkdownStatus, statusChangedDate, statusMessage.
- quantity
Data type: DT_I4
- storeCategoryId
Template: ShortText.
- title
Template: ShortText.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/promotion_report
.
The result is extracted from:{{=response.promotionReports}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This parameter specifies eBay marketplace ID of the site where the promotion is hosted.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/promotion_report/methods/getPromotionReports.
- promotionReportId
A key field. Template: ShortText.
- averageItemDiscount
Template: Amount.
- averageItemRevenue
Template: Amount.
- averageOrderDiscount
Template: Amount.
- averageOrderRevenue
Template: Amount.
- averageOrderSize
Template: ShortText.
- baseSale
Template: Amount.
- itemsSoldQuantity
Data type: DT_I4
- numberOfOrdersSold
Data type: DT_I4
- percentageSalesLift
Template: ShortText.
- promotionSale
Template: Amount.
- totalDiscount
Template: Amount.
- totalSale
Template: Amount.
- promotionHref
Template: ShortText.
- promotionId
A key field. Template: ShortText.
- promotionImageUrl
Template: ShortText.
- promotionStatus
Template: ShortText.
- promotionType
Template: ShortText.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/promotion_summary_report
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- marketplace_id: Required. This parameter specifies eBay marketplace ID of the site where the promotion is hosted.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/promotion_summary_report/methods/getPromotionSummaryReport.
- lastUpdated
Template: DateTime. A read-only field.
- baseSale
Template: Amount.
- promotionSale
Template: Amount.
- totalSale
Template: Amount.
- endDate
Template: DateTime. A read-only field.
- startDate
Template: DateTime. A read-only field.
- saleLift
Template: Number.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/email_campaign
.
The result is extracted from:{{=response.campaigns}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/email_campaign/methods/getEmailCampaigns.
- [Read Single] action
-
Endpoint URL address:
/email_campaign/{{=parameters.email_campaign_id}}
.The action has the following user-defined parameters:
- email_campaign_id: Required. This query parameter specifies the id of the campaign being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/email_campaign/methods/getEmailCampaign.
- [Create] action
-
Endpoint URL address:
/email_campaign
.The following request parameters will be automatically processed:
-
X-EBAY-C-MARKETPLACE-ID:
{{=item.marketplaceId}}
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/email_campaign/methods/createEmailCampaign.
-
X-EBAY-C-MARKETPLACE-ID:
- [Update] action
-
Endpoint URL address:
/email_campaign/{{=item.emailCampaignId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/email_campaign/methods/updateEmailCampaign.
- [Delete] action
-
Endpoint URL address:
/email_campaign/{{=item.emailCampaignId}}
.Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/email_campaign/methods/deleteEmailCampaign.
- emailCampaignId
A key field. Template: ShortText.
- emailCampaignStatus
Template: ShortText.
- emailCampaignType
Template: ShortText.
- marketplaceId
Template: ShortText.
- categoryId
Template: ShortText.
- categoryType
Template: ShortText.
- itemIds
Template: LongText. A composite field.
- modificationDate
Template: DateTime.
- itemSelectMode
Template: ShortText.
- personalizedMessage
Template: LongText.
- creationDate
Template: DateTime. A read-only field.
- scheduleDate
Template: DateTime.
- scheduleDateType
Template: ShortText.
- sentDate
Template: DateTime. A read-only field.
- subject
Template: LongText.
- audienceType
Template: ShortText.
- promotionId
Template: ShortText.
- sort
Template: ShortText.
- promotionSelectMode
Template: ShortText.
- PriceRange
Field components:
-
Uses template:
ShortText
. - Contains the following components: currency, gte, lte.
-
Uses template:
- audiences
Field components:
- An array.
- Contains the following components: audienceType, code, name.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/email_campaign/audience
.
The result is extracted from:{{=response.audiences}}
.The action has the following user-defined parameters:
- emailCampaignType: Required. Specify the email campaign type to search against.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/email_campaign/methods/getAudiences.
- audienceType
Template: ShortText.
- code
Template: ShortText.
- name
Template: ShortText.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/email_campaign/report
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- startDate: Required. Specify the start date for the report, given in UTC format. The maximum date range for a report retrieved by this method is one year.
- endDate: Required. Specify the end date for the report, given in UTC format. The maximum date range for a report retrieved by this method is one year.
Documentation: https://developer.ebay.com/api-docs/sell/marketing/resources/email_campaign/methods/getEmailReport.
- totalSales
Template: Amount.
- clickCount
Data type: DT_I4
- openCount
Data type: DT_I4
Based on resource template Compliance.
- [Read] action
-
Endpoint URL address:
/listing_violation
.
The result is extracted from:{{=response.listingViolations}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header identifies the seller's eBay marketplace.
- compliance_type: Required. This query parameter specifies the compliance type(s) of the listing violation counts being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/compliance/resources/listing_violation/methods/getListingViolations.
- listingId
A key field. Template: ShortText.
- complianceType
Template: ShortText.
- marketplaceId
Template: ShortText.
- listingCount
Data type: DT_I4
- sku
Template: ShortText.
- offerId
Template: ShortText.
- violations
Field components:
- An array.
- Contains the following components: reasonCode, message, variation, violationData, correctiveRecommendations, complianceState.
Based on resource template Compliance.
- [Read] action
-
Endpoint URL address:
/listing_violation_summary
.
The result is extracted from:{{=response.violationSummaries}}
.
The result is paginated.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header identifies the seller's eBay marketplace.
Documentation: https://developer.ebay.com/api-docs/sell/compliance/resources/listing_violation_summary/methods/getListingViolationsSummary.
- complianceType
Template: ShortText.
- marketplaceId
Template: ShortText.
- listingCount
Data type: DT_I4
Based on resource template Finance.
- [Read] action
-
Endpoint URL address:
/payout
.
The result is extracted from:{{=response.payouts}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header identifies the seller's eBay marketplace.
Documentation: https://developer.ebay.com/api-docs/sell/finances/resources/payout/methods/getPayouts.
- [Read Single] action
-
Endpoint URL address:
/payout/{{=parameters.payout_Id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header identifies the seller's eBay marketplace.
- payout_Id: Required. This path parameter is used to specify the unique identifier of the payout being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/finances/resources/payout/methods/getPayout.
- payoutId
A key field. Template: ShortText.
- payoutInstrument
Field components:
-
Uses template:
ShortText
. - Contains the following components: accountLastFourDigits, instrumentType, nickname, payoutPercentage.
-
Uses template:
- payoutStatus
Template: ShortText.
- payoutReference
Template: ShortText.
- payoutDate
Template: DateTime. A read-only field.
- lastAttemptedPayoutDate
Template: DateTime. A read-only field.
- transactionCount
Data type: DT_I4
- bankReference
Template: ShortText.
- payoutMemo
Template: LongText.
- totalFee
Template: Amount.
- feeJurisdiction
Template: FeeJurisdiction.
- totalAmount
Template: PayoutAmount.
- totalFeeDetails
Field components:
- An array.
- Contains the following components: feeType, amount.
- amount
Template: PayoutAmount.
Based on resource template Finance.
- [Read] action
-
Endpoint URL address:
/payout_summary
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header identifies the seller's eBay marketplace.
Documentation: https://developer.ebay.com/api-docs/sell/finances/resources/payout/methods/getPayoutSummary.
- payoutCount
Data type: DT_I4
- transactionCount
Data type: DT_I4
- amount
Template: PayoutAmount.
Based on resource template Finance.
- [Read] action
-
Endpoint URL address:
/transaction
.
The result is extracted from:{{=response.transactions}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header identifies the seller's eBay marketplace.
Documentation: https://developer.ebay.com/api-docs/sell/finances/resources/transaction/methods/getTransactions.
- transactionId
A key field. Template: ShortText.
- amount
Template: Amount.
- bookingEntry
Template: ShortText.
- payoutId
Template: ShortText.
- buyer
Template: Buyer.
- orderId
Template: ShortText.
- paymentsEntity
Template: ShortText.
- salesRecordReference
Template: ShortText.
- totalFeeAmount
Template: Amount.
- totalFeeBasisAmount
Template: Amount.
- transactionDate
Template: DateTime.
- transactionStatus
Template: ShortText.
- transactionType
Template: ShortText.
- orderLineItems
Field components:
- An array.
- Contains the following components: donations, feeBasisAmount, lineItemId, marketplaceFees.
Based on resource template Finance.
- [Read] action
-
Endpoint URL address:
/transaction_summary
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header identifies the seller's eBay marketplace.
- filter: Required. Numerous filters are available for the getTransactions method. One or more of these filter types can be used. The transactionStatus filter must be used.
Documentation: https://developer.ebay.com/api-docs/sell/finances/resources/transaction/methods/getTransactionSummary.
- creditCount
Data type: DT_I4
- refundCount
Data type: DT_I4
- onHoldCount
Data type: DT_I4
- purchaseCount
Data type: DT_I4
- loanRepaymentCount
Data type: DT_I4
- withdrawCount
Data type: DT_I4
- disputeCount
Data type: DT_I4
- shippingLabelCount
Data type: DT_I4
- transferCount
Data type: DT_I4
- creditAmount
Template: Amount.
- shippingLabelAmount
Template: Amount.
- shippingLabelBookingEntry
Template: ShortText.
- creditBookingEntry
Template: ShortText.
Based on resource template Finance.
- [Read] action
-
Endpoint URL address:
/seller_funds_summary
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header identifies the seller's eBay marketplace.
Documentation: https://developer.ebay.com/api-docs/sell/finances/resources/transaction/methods/getTransactionSummary.
- availableFunds
Template: PayoutAmount.
- fundsOnHold
Template: PayoutAmount.
- processingFunds
Template: PayoutAmount.
- totalFunds
Template: PayoutAmount.
Based on resource template Order.
- [Read] action
-
Endpoint URL address:
/order
.
The result is extracted from:{{=response.orders}}
.Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrders.
- [Read Single] action
-
Endpoint URL address:
/order/{{=parameters.orderId}}
.The action has the following user-defined parameters:
- orderId: Required. This path parameter is used to specify the unique identifier of the order being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrder.
- orderId
A key field. Template: ShortText.
- buyer
Template: Buyer.
- buyerCheckoutNotes
Template: ShortText.
- cancelStatus
Field components:
-
Uses template:
DateTime
. - Contains the following components: cancelledDate, cancelRequests, cancelState.
-
Uses template:
- creationDate
Template: DateTime. A read-only field.
- ebayCollectAndRemitTax
Template: ShortText.
- fulfillmentHrefs
Template: LongText. A composite field.
- fulfillmentStartInstructions
Field components:
- An array.
- Contains the following components: destinationTimeZone, ebaySupportedFulfillment, finalDestinationAddress, fulfillmentInstructionsType, maxEstimatedDeliveryDate, minEstimatedDeliveryDate, pickupStep, shippingStep.
- lastModifiedDate
Template: DateTime. A read-only field.
- legacyOrderId
Template: ShortText.
- lineItems
Field components:
- An array.
- Contains the following components: deliveryCost, discountedLineItemCost, ebayCollectedCharges, giftDetails, itemLocation, legacyItemId, legacyVariationId, lineItemCost, lineItemFulfillmentInstructions, lineItemFulfillmentStatus, lineItemId, listingMarketplaceId, properties, purchaseMarketplaceId, quantity, sku, soldFormat, title, total, ebayCollectAndRemitTaxes, variationAspects, appliedPromotions, taxes, refunds, linkedOrderLineItems.
- orderFulfillmentStatus
Template: ShortText.
- orderPaymentStatus
Template: ShortText.
- paymentSummary
Field components:
-
Uses template:
PayoutAmount
. - Contains the following components: payments, refunds, totalDueSeller.
-
Uses template:
- pricingSummary
Field components:
-
Uses template:
PayoutAmount
. - Contains the following components: adjustment, deliveryCost, deliveryDiscount, fee, priceDiscount, priceSubtotal, tax, total.
-
Uses template:
- program
Field components:
- Contains the following components: authenticityVerification, ebayShipping, ebayVault, ebayInternationalShipping, fulfillmentProgram.
- salesRecordReference
Template: ShortText.
- sellerId
Template: ShortText.
- totalFeeBasisAmount
Template: PayoutAmount.
- totalMarketplaceFee
Template: PayoutAmount.
Based on resource template Order.
- [Create] action
-
Endpoint URL address:
/order/{{=item.orderId}}/issue_refund
.Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/issueRefund.
- orderId
A key field. Template: ShortText.
- reasonForRefund
Template: LongText.
- comment
Template: LongText.
- refundItems
Field components:
- An array.
- Contains the following components: refundAmount, lineItemId, legacyReference.
- orderLevelRefundAmount
Template: Amount.
Based on resource template Order.
- [Read] action
-
Endpoint URL address:
/order/{{=parameters.orderId}}/shipping_fulfillment
.
The result is extracted from:{{=response.fulfillments}}
.The action has the following user-defined parameters:
- orderId: Required. This path parameter is used to specify the unique identifier of the order being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/shipping_fulfillment/methods/getShippingFulfillments.
- [Read Single] action
-
Endpoint URL address:
/order/{{=parameters.orderId}}/shipping_fulfillment/{{=parameters.fulfillmentId}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- orderId: Required. This path parameter is used to specify the unique identifier of the order being retrieved.
- fulfillmentId: Required. This path parameter is used to specify the unique identifier of the shipping fulfillment being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/shipping_fulfillment/methods/getShippingFulfillment.
- [Create] action
-
Endpoint URL address:
/order/{{=parameters.orderId}}/shipping_fulfillment
.The action has the following user-defined parameters:
- orderId: Required. This path parameter is used to specify the unique identifier of the order being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/shipping_fulfillment/methods/createShippingFulfillment.
- fulfillmentId
A key field. Template: ShortText.
- lineItems
Field components:
- An array.
- Contains the following components: lineItemId, quantity.
- shipmentTrackingNumber
Template: ShortText.
- shippedDate
Template: DateTime.
- shippingCarrierCode
Template: ShortText.
Based on resource template Payment.
- [Read] action
-
Endpoint URL address:
/payment_dispute/{{=parameters.payment_dispute_id}}
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- payment_dispute_id: Required. This parameter is used to specify the unique identifier of the payment dispute being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/payment_dispute/methods/getPaymentDispute.
- paymentDisputeId
A key field. Template: ShortText.
- amount
Template: Amount.
- availableChoices
Template: LongText. A composite field.
- buyerProvided
Field components:
-
Uses template:
LongText
. - Contains the following components: contentOnHold, note, returnShipmentTracking.
-
Uses template:
- buyerUsername
Template: ShortText.
- closedDate
Template: DateTime. A read-only field.
- evidence
Field components:
- An array.
- Contains the following components: evidenceId, evidenceType, files, lineItems, providedDate, requestDate, respondByDate, shipmentTracking.
- evidenceRequests
Field components:
- An array.
- Contains the following components: evidenceId, evidenceType, lineItems, requestDate, respondByDate.
- lineItems
Field components:
- An array.
-
Uses template:
OrderLineItem
.
- monetaryTransactions
Field components:
- An array.
- Contains the following components: date, type, reason, amount.
- note
Template: LongText.
- openDate
Template: DateTime. A read-only field.
- orderId
Template: ShortText.
- paymentDisputeStatus
Template: ShortText.
- reason
Template: ShortText. A read-only field.
- resolution
Field components:
-
Uses template:
Amount
. - Contains the following components: fees, protectedAmount, protectionStatus, reasonForClosure, recoupAmount, totalFeeCredit.
-
Uses template:
- respondByDate
Template: DateTime.
- returnAddress
Field components:
-
Uses template:
ShortText
. - Contains the following components: addressLine1, addressLine2, city, country, county, fullName, postalCode, primaryPhone, stateOrProvince.
-
Uses template:
- revision
Data type: DT_I4
- sellerResponse
Template: ShortText.
- activity
A read-only field. The value is gathered from
{{=/payment_dispute/{{=item.paymentDisputeId}}/activity}}
address. The gathered value is processed with{{=response.activity}}
expression. Field components:- An array.
- Contains the following components: activityDate, activityType, actor.
Based on resource template Payment.
- [Read] action
-
Endpoint URL address:
/payment_dispute_summary
.
The result is extracted from:{{=response.paymentDisputeSummaries}}
.Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/payment_dispute/methods/getPaymentDisputeSummaries.
- paymentDisputeId
A key field. Template: ShortText.
- paymentDisputeStatus
Template: ShortText.
- reason
Template: LongText.
- orderId
Template: ShortText.
- openDate
Template: DateTime. A read-only field.
- buyerUsername
Template: ShortText.
- amount
Field components:
-
Uses template:
ShortText
. - Contains the following components: value, currency.
-
Uses template:
Based on resource template Payment.
- [Read] action
-
Endpoint URL address:
/payment_dispute/{{=parameters.payment_dispute_id}}/fetch_evidence_content
.
The result is extracted from:{{={ evidenceContent: response } }}
.
The result is paginated.The action has the following user-defined parameters:
- payment_dispute_id: Required. This parameter is used to specify the unique identifier of the payment dispute being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/payment_dispute/methods/getPaymentDispute.
- [Create] action
-
Endpoint URL address:
/payment_dispute/{{=parameters.payment_dispute_id}}/add_evidence
.The action has the following user-defined parameters:
- payment_dispute_id: Required. This parameter is used to specify the unique identifier of the payment dispute being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/payment_dispute/methods/addEvidence.
- [Update] action
-
Endpoint URL address:
/payment_dispute/{{=parameters.payment_dispute_id}}/update_evidence
.The action has the following user-defined parameters:
- payment_dispute_id: Required. This parameter is used to specify the unique identifier of the payment dispute being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/payment_dispute/methods/updateEvidence.
- evidenceContent
Data type: DT_IMAGE
- evidenceType
Template: ShortText.
- evidenceId
Template: ShortText.
- files
Field components:
- An array.
- lineItems
Field components:
- An array.
- Contains the following components: itemId, lineItemId.
Based on resource template Payment.
- [Create] action
-
Endpoint URL address:
/payment_dispute/{{=parameters.payment_dispute_id}}/upload_evidence_file
.The action has the following user-defined parameters:
- payment_dispute_id: Required. This parameter is used to specify the unique identifier of the payment dispute being retrieved.
The following request parameters will be automatically processed:
-
file:
{{=item.content}}
Documentation: https://developer.ebay.com/api-docs/sell/fulfillment/resources/payment_dispute/methods/addEvidence.
- filename
Template: ShortText.
- content
Data type: DT_IMAGE
Based on resource template Marketplace.
- [Read] action
-
Endpoint URL address:
/{{=parameters.marketplace_id}}/get_automotive_parts_compatibility_policies
.
The result is extracted from:{{=response.automotivePartsCompatibilityPolicies}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter is used to specify the unique identifier of the payout being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/metadata/resources/marketplace/methods/getAutomotivePartsCompatibilityPolicies.
- categoryTreeId
Template: ShortText.
- categoryId
Template: ShortText.
- compatibilityBasedOn
Template: ShortText.
- maxNumberOfCompatibleVehicles
Data type: DT_I4
- compatibleVehicleTypes
Template: LongText. A composite field.
Based on resource template Marketplace.
- [Read] action
-
Endpoint URL address:
/{{=parameters.marketplace_id}}/get_extended_producer_responsibility_policies
.
The result is extracted from:{{=response.extendedProducerResponsibilities}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter is used to specify the unique identifier of the payout being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/metadata/resources/marketplace/methods/getExtendedProducerResponsibilityPolicies.
- categoryTreeId
Template: ShortText.
- categoryId
Template: ShortText.
- supportedAttributes
Field components:
- An array.
- Contains the following components: name, usage, enabledForVariations.
Based on resource template Marketplace.
- [Read] action
-
Endpoint URL address:
/{{=parameters.marketplace_id}}/get_hazardous_materials_labels
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter is used to specify the unique identifier of the payout being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/metadata/resources/marketplace/methods/getHazardousMaterialsLabels.
- signalWords
Field components:
- An array.
- Contains the following components: signalWordId, signalWordDescription.
- statements
Field components:
- An array.
-
Uses template:
HazardStatement
.
- pictograms
Field components:
- An array.
- Contains the following components: pictogramId, pictogramDescription, pictogramUrl.
Based on resource template Marketplace.
- [Read] action
-
Endpoint URL address:
/{{=parameters.marketplace_id}}/get_listing_structure_policies
.
The result is extracted from:{{=response.listingStructurePolicies}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter is used to specify the unique identifier of the payout being retrieved.
- filter: This query parameter limits the response by returning policy information for only the selected sections of the category tree.
Documentation: https://developer.ebay.com/api-docs/sell/metadata/resources/marketplace/methods/getListingStructurePolicies.
- categoryTreeId
Template: ShortText.
- categoryId
Template: ShortText.
- variationsSupported
Template: ShortText.
Based on resource template Marketplace.
- [Read] action
-
Endpoint URL address:
/{{=parameters.marketplace_id}}/get_item_condition_policies
.
The result is extracted from:{{=response.itemConditionPolicies}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter is used to specify the unique identifier of the payout being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/metadata/resources/marketplace/methods/getListingStructurePolicies.
- categoryTreeId
Data type: DT_I4
- categoryId
Data type: DT_I4
- itemConditionRequired
Template: ShortText.
- itemConditions
Field components:
- An array.
- Contains the following components: conditionDescription, conditionDescriptors, conditionHelpText, conditionId, usage.
Based on resource template Marketplace.
- [Read] action
-
Endpoint URL address:
/{{=parameters.marketplace_id}}/get_negotiated_price_policies
.
The result is extracted from:{{=response.negotiatedPricePolicies}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter is used to specify the unique identifier of the payout being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/metadata/resources/marketplace/methods/getNegotiatedPricePolicies.
- bestOfferAutoAcceptEnabled
Template: ShortText.
- bestOfferAutoDeclineEnabled
Template: ShortText.
- bestOfferCounterEnabled
Template: ShortText.
- categoryTreeId
Data type: DT_I4
- categoryId
Data type: DT_I4
Based on resource template Marketplace.
- [Read] action
-
Endpoint URL address:
/{{=parameters.marketplace_id}}/get_return_policies
.
The result is extracted from:{{=response.returnPolicies}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter is used to specify the unique identifier of the payout being retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies.
- categoryTreeId
Data type: DT_I4
- categoryId
Data type: DT_I4
- domestic
Template: ReturnPolicy.
- international
Template: ReturnPolicy.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sell/negotiation/v1/find_eligible_items
.
The result is extracted from:{{=response.eligibleItems}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. The eBay marketplace on which you want to search for eligible listings.
Documentation: https://developer.ebay.com/api-docs/sell/negotiation/resources/offer/methods/findEligibleItems.
- listingId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sell/recommendation/v1/find
.
The result is extracted from:{{=response.listingRecommendations}}
.
The action uses POST method.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This header specifies the eBay marketplace where you list the items for which you want to get recommendations.
- listings: A comma-separated list of listing IDs for which you want Promoted Listings ad configuration information.
- filter: This query parameter limits the response by returning policy information for only the selected sections of the category tree.
The following request parameters will be automatically processed:
-
limit:
{{=parameters.batchSize}}
-
offset:
{{=parameters.iterator}}
-
filter:
{{=parameters.get('filter')}}
-
application/json:
{{=parameters.get('listings') && { listingIds: [parameters.listings] } }}
Documentation: https://developer.ebay.com/api-docs/sell/recommendation/resources/listing_recommendation/methods/findListingRecommendations.
- listingId
Template: ShortText.
- marketing
Field components:
-
Uses template:
Ad
. - Contains the following components: ad, message.
-
Uses template:
Based on resource template Browse.
- [Read] action
-
Endpoint URL address:
/item/
.
The result is extracted from:{{=response.items}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.
- X-EBAY-C-ENDUSERCTX: This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.
The following request parameters will be automatically processed:
-
X-EBAY-C-ENDUSERCTX:
{{=parameters.get('X-EBAY-C-ENDUSERCTX')}}
Documentation: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItems.
- [Read Single] action
-
Endpoint URL address:
/item/{{=parameters.item_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.
- item_id: Required. This path parameter specifies the unique RESTful identifier of the item being retrieved.
- X-EBAY-C-ENDUSERCTX: This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.
The following request parameters will be automatically processed:
-
X-EBAY-C-ENDUSERCTX:
{{=parameters.get('X-EBAY-C-ENDUSERCTX')}}
Documentation: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItem.
- [Read legacy Id] action
-
Endpoint URL address:
/item/get_item_by_legacy_id
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.
- legacy_item_id: Required. This query parameter is the unique identifier that specifies the item being retrieved.
- X-EBAY-C-ENDUSERCTX: This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.
The following request parameters will be automatically processed:
-
X-EBAY-C-ENDUSERCTX:
{{=parameters.get('X-EBAY-C-ENDUSERCTX')}}
Documentation: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItemByLegacyId.
- [Read group] action
-
Endpoint URL address:
/item/get_items_by_item_group
.
The result is extracted from:{{=response.items}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.
- item_group_id: Required. This query parameter specifies the unique identifier of an item group for which information is to be returned. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
- fieldgroups: A comma-separated list of values that controls what is returned in the response.
- X-EBAY-C-ENDUSERCTX: This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.
The following request parameters will be automatically processed:
-
X-EBAY-C-ENDUSERCTX:
{{=parameters.get('X-EBAY-C-ENDUSERCTX')}}
Documentation: https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItemsByItemGroup.
- itemId
A key field. Template: ShortText.
- sellerItemRevision
Template: ShortText.
- title
Template: ShortText.
- shortDescription
Template: ShortText.
- price
Template: Amount.
- categoryPath
Template: ShortText.
- categoryIdPath
Template: ShortText.
- condition
Template: ShortText.
- conditionId
Data type: DT_I4
- itemLocation
Template: Address.
- image
Template: Image.
- brand
Template: ShortText.
- seller
Field components:
-
Uses template:
ShortText
. - Contains the following components: feedbackPercentage, feedbackScore, sellerAccountType, sellerLegalInfo, userId, username.
-
Uses template:
- sellerCustomPolicies
Field components:
- An array.
- Contains the following components: description, label, type.
- mpn
Template: ShortText.
- estimatedAvailabilities
Field components:
- An array.
- Contains the following components: availabilityThreshold, availabilityThresholdType, deliveryOptions, estimatedAvailabilityStatus, estimatedAvailableQuantity, estimatedSoldQuantity.
- shippingOptions
Field components:
- An array.
- Contains the following components: additionalShippingCostPerUnit, cutOffDateUsedForEstimate, fulfilledThrough, guaranteedDelivery, importCharges, maxEstimatedDeliveryDate, minEstimatedDeliveryDate, quantityUsedForEstimate, shippingCarrierCode, shippingCost, shippingCostType, shippingServiceCode, shipToLocationUsedForEstimate, trademarkSymbol, type.
- shipToLocations
Template: ShipToLocation.
- returnTerms
Field components:
-
Uses template:
ShortText
. - Contains the following components: extendedHolidayReturnsOffered, refundMethod, restockingFeePercentage, returnInstructions, returnMethod, returnPeriod, returnsAccepted, returnShippingCostPayer.
-
Uses template:
- taxes
Field components:
- An array.
-
Uses template:
TaxItem
.
- localizedAspects
Field components:
- An array.
- Contains the following components: name, type, value.
- product
Field components:
-
Uses template:
ShortText
. - Contains the following components: aspectGroups, title, description, image, gtins, brand, mpns, additionalProductIdentities.
-
Uses template:
- primaryProductReviewRating
Field components:
-
Uses template:
ShortText
. - Contains the following components: averageRating, ratingHistograms, reviewCount.
-
Uses template:
- priorityListing
Data type: DT_BOOL
- topRatedBuyingExperience
Data type: DT_BOOL
- buyingOptions
Template: LongText. A composite field.
- primaryItemGroup
Field components:
-
Uses template:
ShortText
. - Contains the following components: itemGroupAdditionalImages, itemGroupHref, itemGroupId, itemGroupImage, itemGroupTitle, itemGroupType.
-
Uses template:
- itemWebUrl
Template: ShortText.
- description
Template: ShortText.
- paymentMethods
Field components:
- An array.
- Contains the following components: paymentMethodType, paymentMethodBrands, paymentInstructions, sellerInstructions.
- enabledForGuestCheckout
Data type: DT_BOOL
- eligibleForInlineCheckout
Data type: DT_BOOL
- lotSize
Data type: DT_I4
- legacyItemId
Template: ShortText.
- adultOnly
Data type: DT_BOOL
- categoryId
Template: ShortText.
Based on resource template Browse.
- [Read] action
-
Endpoint URL address:
/item_summary/search
.
The result is extracted from:{{=response.itemSummaries}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: This header identifies the seller's eBay marketplace. It is required for all marketplaces outside of the US.
- q: A string consisting of one or more keywords used to search for items on eBay.
- category_ids: The category ID is used to limit the results that are returned.
- X-EBAY-C-ENDUSERCTX: This header is required to support revenue sharing for eBay Partner Network and to improve the accuracy of shipping and delivery time estimations.
The following request parameters will be automatically processed:
-
X-EBAY-C-ENDUSERCTX:
{{=parameters.get('X-EBAY-C-ENDUSERCTX')}}
Documentation: https://developer.ebay.com/api-docs/sell/analytics/resources/seller_standards_profile/methods/getSellerStandardsProfile.
- itemId
A key field. Template: ShortText.
- title
Template: ShortText.
- leafCategoryIds
Template: LongText. A composite field.
- categories
Field components:
- An array.
- Contains the following components: categoryId, categoryName.
- image
Template: Image.
- price
Template: Amount.
- itemHref
Template: ShortText.
- seller
Field components:
-
Uses template:
ShortText
. - Contains the following components: username, feedbackPercentage, feedbackScore.
-
Uses template:
- marketingPrice
Field components:
-
Uses template:
Amount
. - Contains the following components: originalPrice, discountPercentage, discountAmount, priceTreatment.
-
Uses template:
- condition
Template: ShortText.
- conditionId
Data type: DT_I4
- thumbnailImages
Field components:
- An array.
-
Uses template:
Image
.
- shippingOptions
Field components:
- An array.
- Contains the following components: shippingCostType, shippingCost.
- buyingOptions
Template: LongText. A composite field.
- itemAffiliateWebUrl
Template: ShortText.
- itemWebUrl
Template: ShortText.
- itemLocation
Field components:
-
Uses template:
ShortText
. - Contains the following components: country.
-
Uses template:
- additionalImages
Field components:
- An array.
-
Uses template:
Image
.
- adultOnly
Data type: DT_BOOL
- legacyItemId
Template: ShortText.
- availableCoupons
Data type: DT_BOOL
- itemCreationDate
Template: ShortText.
- topRatedBuyingExperience
Data type: DT_BOOL
- priorityListing
Data type: DT_BOOL
- listingMarketplaceId
Template: ShortText.
- currentBidPrice
Template: Amount.
- epid
Template: ShortText.
- shortDescription
Template: ShortText.
- itemGroupHref
Template: ShortText.
- itemGroupType
Template: ShortText.
- compatibilityProperties
Field components:
- An array.
- Contains the following components: name, localizedName, value.
- compatibilityMatch
Template: ShortText.
- priceDisplayCondition
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buy/marketing/v1_beta/merchandised_product
.
The result is extracted from:{{=response.merchandisedProducts}}
.The action has the following user-defined parameters:
- metric_name: Required. This value filters the result set by the specified metric. Only products in this metric are returned.
- category_id: Required. This query parameter limits the products returned to a specific eBay category.
Documentation: https://developer.ebay.com/api-docs/buy/marketing/resources/merchandised_product/methods/getMerchandisedProducts.
- averageRating
Template: ShortText.
- epid
Template: ShortText.
- image
Template: Image.
- marketPriceDetails
Field components:
- An array.
- Contains the following components: conditionGroup, conditionIds, estimatedStartPrice.
- ratingAspects
Field components:
- An array.
- Contains the following components: count, description, name, ratingAspectDistributions.
- ratingCount
Data type: DT_I4
- reviewCount
Data type: DT_I4
- title
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/commerce/catalog/v1_beta/product/{{=parameters.epid}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: This method also uses the X-EBAY-C-MARKETPLACE-ID header to identify the seller's eBay marketplace.
- epid: Required. The eBay product identifier (ePID) of the product being requested.
Documentation: https://developer.ebay.com/api-docs/commerce/catalog/resources/product/methods/getProduct.
- epid
A key field. Template: ShortText.
- aspects
Field components:
- An array.
-
Uses template:
AspectBuy
.
- title
Template: ShortText.
- description
Template: LongText.
- image
Template: Image.
- gtin
Template: LongText. A composite field.
- mpn
Template: LongText. A composite field.
- ean
Template: LongText. A composite field.
- upc
Template: LongText. A composite field.
- brand
Template: ShortText.
- productWebUrl
Template: ShortText.
- primaryCategoryId
Template: ShortText.
- otherApplicableCategoryIds
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/commerce/catalog/v1_beta/product_summary/search
.
The result is extracted from:{{=response.productSummaries}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: This method also uses the X-EBAY-C-MARKETPLACE-ID header to identify the seller's eBay marketplace.
- q: A string consisting of one or more keywords to use to search for products in the eBay catalog.
- category_ids: The category ID is used to limit the results that are returned.
Documentation: https://developer.ebay.com/api-docs/commerce/catalog/resources/product_summary/methods/search.
- epid
A key field. Template: ShortText.
- additionalImages
Field components:
- An array.
-
Uses template:
Image
.
- aspects
Field components:
- An array.
-
Uses template:
AspectBuy
.
- brand
Template: ShortText.
- ean
Template: LongText. A composite field.
- gtin
Template: LongText. A composite field.
- image
Template: Image.
- mpn
Template: LongText. A composite field.
- otherApplicableCategoryIds
Template: LongText. A composite field.
- primaryCategoryId
Template: ShortText.
- productWebUrl
Template: ShortText.
- title
Template: LongText.
- upc
Template: LongText. A composite field.
- productHref
Template: ShortText.
Based on resource template Notification.
- [Read] action
-
Endpoint URL address:
/topic
.
The result is extracted from:{{=response.topics}}
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/topic/methods/getTopics.
- [Read Single] action
-
Endpoint URL address:
/topic/{{=parameters.topic_id}}
.The action has the following user-defined parameters:
- topic_id: Required. The unique identifier of the notification topic for which the details are retrieved.
Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/topic/methods/getTopic.
- topicId
A key field. Template: ShortText.
- description
Template: ShortText.
- status
Template: ShortText.
- context
Template: ShortText.
- scope
Template: ShortText.
- supportedPayloads
Field components:
- An array.
-
Uses template:
SubscriptionPayloadDetail
.
- filterable
Data type: DT_BOOL
Based on resource template Notification.
- [Read] action
-
Endpoint URL address:
/subscription
.
The result is extracted from:{{=response.subscriptions}}
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/subscription/methods/getSubscriptions.
- [Read Single] action
-
Endpoint URL address:
/subscription/{{=parameters.subscription_id}}
.The action has the following user-defined parameters:
- subscription_id: Required. The unique identifier of the subscription to retrieve. Use getSubscriptions to retrieve subscription IDs.
Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/subscription/methods/getSubscription.
- [Create] action
-
Endpoint URL address:
/subscription
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/subscription/methods/createSubscription.
- [Update] action
-
Endpoint URL address:
/subscription/{{=item.subscriptionId}}
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/subscription/methods/updateSubscription.
- [Delete] action
-
Endpoint URL address:
/subscription/{{=item.subscriptionId}}
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/subscription/methods/deleteSubscription.
- subscriptionId
A key field. Template: ShortText.
- creationDate
Template: ShortText.
- filterId
Template: ShortText.
- topicId
Template: ShortText.
- payload
Template: SubscriptionPayloadDetail.
- destinationId
Template: ShortText.
- notificationId
Template: ShortText.
- filterSchema
Template: LongText. A composite field.
- filterStatus
Template: ShortText.
- status
Template: ShortText.
Based on resource template Notification.
- [Read] action
-
Endpoint URL address:
/subscription/{{=parameters.subscription_id}}/filter/{{=parameters.filter_id}}
.
The result is extracted from:{{=[response]}}
.
The result is paginated.The action has the following user-defined parameters:
- subscription_id: Required. The unique identifier of the subscription to retrieve. Use getSubscriptions to retrieve subscription IDs.
- filter_id: Required. The unique identifier of the subscription filter.
Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/subscription/methods/getSubscriptionFilter.
- [Create] action
-
Endpoint URL address:
/subscription/{{=parameters.subscription_id}}/filter
.The action has the following user-defined parameters:
- subscription_id: Required. The unique identifier of the subscription to retrieve. Use getSubscriptions to retrieve subscription IDs.
Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/subscription/methods/createSubscription.
- [Delete] action
-
Endpoint URL address:
/subscription/{{=parameters.subscription_id}}/filter/{{=item.filterId}}
.The action has the following user-defined parameters:
- subscription_id: Required. The unique identifier of the subscription to retrieve. Use getSubscriptions to retrieve subscription IDs.
Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/subscription/methods/deleteSubscriptionFilter.
- filterId
A key field. Template: ShortText.
- subscriptionId
Template: ShortText.
- creationDate
Template: DateTime. A read-only field.
- filterSchema
Field components:
-
Uses template:
ShortText
. - Contains the following components: type, properties.
-
Uses template:
- filterStatus
Template: ShortText.
Based on resource template Notification.
- [Read] action
-
Endpoint URL address:
/destination
.
The result is extracted from:{{=response.destinations}}
.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=undefined}}
-
continuation_token:
{{=parameters.iterator}}
Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/destination/methods/getDestinations.
-
offset:
- [Read Single] action
-
Endpoint URL address:
/destination/{{=parameters.destination_id}}
.The action has the following user-defined parameters:
- destination_id: Required. The unique identifier of the destination to retrieve.
Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/destination/methods/getDestination.
- [Create] action
-
Endpoint URL address:
/destination
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/destination/methods/createDestination.
- [Update] action
-
Endpoint URL address:
/destination/{{item.destination_id}}
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/destination/methods/updateDestination.
- [Delete] action
-
Endpoint URL address:
/destination/{{item.destination_id}}
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/destination/methods/deleteDestination.
- destinationId
A key field. Template: ShortText.
- name
Template: ShortText.
- status
Template: ShortText.
- deliveryConfig
Field components:
-
Uses template:
ShortText
. - Contains the following components: endpoint, verificationToken.
-
Uses template:
Based on resource template Notification.
- [Read] action
-
Endpoint URL address:
/config
.
The result is extracted from:{{=[response]}}
.
The result is paginated.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/config/methods/getConfig.
- [Update] action
-
Endpoint URL address:
/config
.Documentation: https://developer.ebay.com/api-docs/commerce/notification/resources/config/methods/updateConfig.
- alertEmail
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/charity_org
.
The result is extracted from:{{=response.charityOrgs}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This method also uses the X-EBAY-C-MARKETPLACE-ID header to identify charity marketplace.
- q: A query string that matches the keywords in name, mission statement, or description.
- registration_ids: A comma-separated list of charitable organization registration IDs.
Documentation: https://developer.ebay.com/api-docs/commerce/charity/resources/charity_org/methods/getCharityOrgs.
- [Read Single] action
-
Endpoint URL address:
/charity_org/{{=parameters.charity_org_id}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. This method also uses the X-EBAY-C-MARKETPLACE-ID header to identify charity marketplace.
- charity_org_id: Required. Specify the charity_org identifier.
Documentation: https://developer.ebay.com/api-docs/commerce/charity/resources/charity_org/methods/getCharityOrg.
- charityOrgId
A key field. Template: ShortText.
- description
Template: LongText.
- location
Template: Location.
- logoImage
Template: Image.
- missionStatement
Template: LongText.
- name
Template: ShortText.
- registrationId
Template: ShortText.
- website
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
{{=Ebay.getApizUrl()}}/commerce/identity/v1/user/
.
The result is extracted from:{{=[response]}}
.Documentation: https://developer.ebay.com/api-docs/commerce/identity/resources/user/methods/getUser.
- userId
A key field. Template: ShortText.
- accountType
Template: ShortText.
- businessAccount
Field components:
-
Uses template:
Address
. - Contains the following components: address, doingBusinessAs, email, name, primaryContact, primaryPhone, secondaryPhone, website.
-
Uses template:
- individualAccount
Field components:
-
Uses template:
ShortText
. - Contains the following components: email, firstName, lastName, primaryPhone, registrationAddress, secondaryPhone.
-
Uses template:
- registrationMarketplaceId
Template: ShortText.
- status
Template: ShortText.
- username
Template: ShortText.
- address
Template: Address.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/commerce/translation/v1_beta/translate
.
The result is extracted from:{{=[response]}}
.
The action uses POST method.The action has the following user-defined parameters:
- From language: Required. The language of the input text to be translated.
- To language: Required. The target language for the translation of the input text.
- Text: Required. The input text to translate split by "/;". (Currently only 1 string supported by Ebay)
- Translation context: Required. Input the listing entity to be translated.
The following request parameters will be automatically processed:
-
application/json:
{{={ from: parameters['From language'], to: parameters['To language'], text: parameters.Text.split('/;'), translationContext: parameters['Translation context'] } }}
Documentation: https://developer.ebay.com/api-docs/commerce/translation/resources/language/methods/translate.
- from
Template: ShortText.
- to
Template: ShortText.
- translations
An array field. Field components:
-
Uses template:
ShortText
. - Contains the following components: originalText, translatedText.
-
Uses template:
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/rate_limit/
.
The result is extracted from:{{=response.rateLimits}}
.The action has the following user-defined parameters:
- api_name: This optional query parameter filters the result to include only the APIs specified.
- api_context: This optional query parameter filters the result to include only the specified API context.
Documentation: https://developer.ebay.com/api-docs/developer/analytics/resources/rate_limit/methods/getRateLimits.
- [Read user] action
-
Endpoint URL address:
/user_rate_limit/
.
The result is extracted from:{{=response.rateLimits}}
.The action has the following user-defined parameters:
- api_name: This optional query parameter filters the result to include only the APIs specified.
- api_context: This optional query parameter filters the result to include only the specified API context.
Documentation: https://developer.ebay.com/api-docs/developer/analytics/resources/user_rate_limit/methods/getUserRateLimits.
- apiContext
Template: ShortText.
- apiName
Template: ShortText.
- apiVersion
Template: ShortText.
- resources
An array field. Field components:
-
Uses template:
ShortText
. - Contains the following components: name, rates.
-
Uses template:
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/signing_key
.
The result is extracted from:{{=response.signingKeys}}
.Documentation: https://developer.ebay.com/api-docs/developer/key-management/resources/signing_key/methods/getSigningKeys.
- [Read Single] action
-
Endpoint URL address:
/signing_key/{{=parameters.signing_key_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- signing_key_id: Required. The system-generated eBay ID of the keypairs being requested.
Documentation: https://developer.ebay.com/api-docs/developer/key-management/resources/signing_key/methods/getSigningKey.
- [Create] action
-
Endpoint URL address:
/signing_key
.
The result is extracted from:{{=alert('Private key: ' + response.privateKey)}}
.Documentation: https://developer.ebay.com/api-docs/developer/key-management/resources/signing_key/methods/createSigningKey.
- creationTime
Data type: DT_I4
- expirationTime
Data type: DT_I4
- jwe
Template: ShortText.
- privateKey
Template: ShortText.
- publicKey
Template: ShortText.
- signingKeyCipher
Template: ShortText.
- signingKeyId
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
{{=new Uri(connection.serverHost).authority().replace('api.', 'tppz.')}}/developer/registration/v1/client/register
.Documentation: https://developer.ebay.com/api-docs/developer/client-registration/resources/register/methods/registerClient.
- client_name
Template: ShortText.
- contacts
Template: LongText. A composite field.
- policy_uri
Template: ShortText.
- redirect_uris
Template: LongText. A composite field.
- software_id
Template: ShortText.
- software_statement
Template: ShortText.
Based on resource template Account.
- [Read] action
-
Endpoint URL address:
/custom_policy/
.
The result is extracted from:{{=response.customPolicies}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicies.
- [Read Single] action
-
Endpoint URL address:
/custom_policy/{{=parameters.custom_policy_id}}
.The action has the following user-defined parameters:
- custom_policy_id: Required. This path parameter is the unique identifier of the custom policy to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy.
- [Create] action
-
Endpoint URL address:
/custom_policy/
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/custom_policy/methods/createCustomPolicy.
- [Update] action
-
Endpoint URL address:
/custom_policy/{{=item.customPolicyId}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/custom_policy/methods/updateCustomPolicy.
- customPolicyId
A key field. Template: ShortText.
- description
Template: ShortText.
- label
Template: ShortText.
- name
Template: ShortText.
- policyType
Template: ShortText.
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/fulfillment_policy
.
The result is extracted from:{{=response.fulfillmentPolicies}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This query parameter specifies the eBay marketplace of the policies you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies.
- [Read Single] action
-
Endpoint URL address:
/fulfillment_policy/{{=parameters.fulfillmentPolicyId}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- fulfillmentPolicyId: fulfillmentPolicyId. This path parameter specifies the ID of the fulfillment policy you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicy.
- [Read name] action
-
Endpoint URL address:
/fulfillment_policy/get_by_policy_name
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This query parameter specifies the eBay marketplace of the policies you want to retrieve.
- name: Required. This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicyByName.
- [Create] action
-
Endpoint URL address:
/fulfillment_policy/
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/custom_policy/methods/createCustomPolicy.
- [Update] action
-
Endpoint URL address:
/fulfillment_policy/{{=item.fulfillmentPolicyId}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/custom_policy/methods/updateCustomPolicy.
- [Delete] action
-
Endpoint URL address:
/fulfillment_policy/{{=item.fulfillmentPolicyId}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/fulfillment_policy/methods/deleteFulfillmentPolicy.
- fulfillmentPolicyId
A key field. Template: ShortText.
- categoryTypes
Field components:
- An array.
-
Uses template:
CategoryType
.
- description
Template: LongText.
- freightShipping
Data type: DT_BOOL
- globalShipping
Data type: DT_BOOL
- handlingTime
Template: TimeDuration.
- localPickup
Data type: DT_BOOL
- marketplaceId
Template: ShortText.
- name
Template: ShortText.
- pickupDropOff
Data type: DT_BOOL
- shippingOptions
Field components:
- An array.
- Contains the following components: costType, insuranceFee, insuranceOffered, optionType, packageHandlingCost, rateTableId, shippingDiscountProfileId, shippingPromotionOffered, shippingServices.
- shipToLocations
Template: ShipToLocation.
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/payment_policy
.
The result is extracted from:{{=response.paymentPolicies}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This query parameter specifies the eBay marketplace of the policies you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies.
- [Read Single] action
-
Endpoint URL address:
/payment_policy{{=parameters.payment_policy_id}}
.The action has the following user-defined parameters:
- payment_policy_id: Required. This path parameter specifies the ID of the payment policy you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicy.
- [Read name] action
-
Endpoint URL address:
/payment_policy/get_by_policy_name
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This query parameter specifies the eBay marketplace of the policies you want to retrieve.
- name: Required. This query parameter specifies the seller-defined name of the payment policy you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicyByName.
- [Create] action
-
Endpoint URL address:
/payment_policy
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/createPaymentPolicy.
- [Update] action
-
Endpoint URL address:
/payment_policy/{{=item.paymentPolicyId}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/updatePaymentPolicy.
- [Delete] action
-
Endpoint URL address:
/payment_policy/{{=item.paymentPolicyId}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/payment_policy/methods/deletePaymentPolicy.
- paymentPolicyId
A key field. Template: ShortText.
- deposit
Field components:
-
Uses template:
Amount
. - Contains the following components: amount, dueIn, paymentMethods.
-
Uses template:
- description
Template: LongText.
- fullPaymentDueIn
Template: TimeDuration.
- immediatePay
Data type: DT_BOOL
- marketplaceId
Template: ShortText.
- name
Template: ShortText.
- paymentInstructions
Template: LongText.
- paymentMethods
Field components:
- An array.
- Contains the following components: brands, paymentMethodType, recipientAccountReference.
- categoryTypes
Field components:
- An array.
-
Uses template:
CategoryType
.
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/payments_program/{{=parameters.marketplace_id}}/{{=parameters.payments_program_type}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.
- payments_program_type: Required. This path parameter specifies the payments program whose status is returned by the call.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/payments_program/methods/getPaymentsProgram.
- marketplaceId
Template: ShortText.
- paymentsProgramType
Template: ShortText.
- status
Template: ShortText.
- wasPreviouslyOptedIn
Data type: DT_BOOL
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/payments_program/{{=parameters.marketplace_id}}/{{=parameters.payments_program_type}}/onboarding
.
The result is extracted from:{{=response.steps}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.
- payments_program_type: Required. This path parameter specifies the payments program whose status is returned by the call.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/payments_program/onboarding/methods/getPaymentsProgramOnboarding.
- onboardingStatus
Template: ShortText.
- steps
Field components:
- An array.
- Contains the following components: name, status.
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/privilege
.
The result is extracted from:{{=[response]}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/privilege/methods/getPrivileges.
- sellerRegistrationCompleted
Data type: DT_BOOL
- sellingLimit
Field components:
-
Uses template:
Amount
. - Contains the following components: amount, quantity.
-
Uses template:
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/rate_table
.
The result is extracted from:{{=response.rateTables}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/rate_table/methods/getRateTables.
- countryCode
Template: ShortText.
- locality
Template: ShortText.
- name
Template: ShortText.
- rateTableId
Template: ShortText.
- additionalCost
Template: Amount.
- rate_table_id
Template: ShortText.
- rateId
Template: ShortText.
- shippingCategory
Template: ShortText.
- shippingCost
Template: Amount.
- shippingRegionNames
Template: LongText. A composite field.
- shippingServiceCode
Template: ShortText.
- rates
An array field. Field components:
-
Uses template:
Amount
. - Contains the following components: additionalCost, rateId, shippingCost.
-
Uses template:
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/return_policy
.
The result is extracted from:{{=response.returnPolicies}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This query parameter specifies the eBay marketplace of the policies you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies.
- [Read Single] action
-
Endpoint URL address:
/return_policy{{=parameters.return_policy_id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- return_policy_id: Required. This path parameter specifies the unique identifier of the return policy you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/return_policy/methods/getReturnPolicy.
- [Read name] action
-
Endpoint URL address:
/return_policy/get_by_policy_name
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- marketplace_id: Required. This query parameter specifies the eBay marketplace of the policies you want to retrieve.
- name: Required. This query parameter specifies the seller-defined name of the return policy you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/return_policy/methods/getReturnPolicyByName.
- [Create] action
-
Endpoint URL address:
/return_policy
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/return_policy/methods/createReturnPolicy.
- [Update] action
-
Endpoint URL address:
/return_policy/{{=item.returnPolicyId}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/return_policy/methods/updateReturnPolicy.
- [Delete] action
-
Endpoint URL address:
/return_policy/{{=item.returnPolicyId}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/return_policy/methods/deleteReturnPolicy.
- returnPolicyId
A key field. Template: ShortText.
- categoryTypes
Field components:
- An array.
-
Uses template:
CategoryType
.
- description
Template: LongText.
- extendedHolidayReturnsOffered
Data type: DT_BOOL
- internationalOverride
Field components:
-
Uses template:
ShortText
. - Contains the following components: returnMethod, returnPeriod, returnsAccepted, returnShippingCostPayer.
-
Uses template:
- marketplaceId
Template: ShortText.
- name
Template: ShortText.
- refundMethod
Template: ShortText.
- restockingFeePercentage
Template: ShortText.
- returnInstructions
Template: ShortText.
- returnMethod
Template: ShortText.
- returnPeriod
Template: TimeDuration.
- returnsAccepted
Data type: DT_BOOL
- returnShippingCostPayer
Template: ShortText.
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/sales_tax
.
The result is extracted from:{{=response.salesTaxes}}
.The action has the following user-defined parameters:
- country_code: Required. This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table you want to retrieve.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/sales_tax/methods/getSalesTaxes.
- [Read Single] action
-
Endpoint URL address:
/sales_tax/{{=parameters.countryCode}}/{{=parameters.jurisdictionId}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- countryCode: Required. This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table you want to retrieve.
- jurisdictionId : Required. This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry to be retrieved.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/sales_tax/methods/getSalesTax.
- [Upsert] action
-
Endpoint URL address:
/sales_tax/{{=item.countryCode}}/{{=item.jurisdictionId}}
.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/sales_tax/methods/createOrReplaceSalesTax.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sales_tax/{{=item.countryCode}}/{{=item.jurisdictionId}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/sales_tax/methods/deleteSalesTax.
- jurisdictionId
Template: ShortText.
- countryCode
Template: ShortText.
- salesTaxJurisdictionId
Template: ShortText.
- salesTaxPercentage
Template: Number.
- shippingAndHandlingTaxed
Data type: DT_BOOL
Based on resource template Account.
- [Read] action
-
Endpoint URL address:
/subscription
.
The result is extracted from:{{=response.subscriptions}}
.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=undefined}}
-
continuation_token:
{{=parameters.iterator}}
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/subscription/methods/getSubscription.
-
offset:
- marketplaceId
Template: ShortText.
- subscriptionId
Template: ShortText.
- subscriptionLevel
Template: ShortText.
- subscriptionType
Template: ShortText.
- term
Template: TimeDuration.
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/kyc
.
The result is extracted from:{{=response.kycChecks}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/resources/kyc/methods/getKYC.
- dataRequired
Template: ShortText.
- dueDate
Template: DateTime.
- remedyUrl
Template: LongText.
- alert
Template: ShortText.
- detailMessage
Template: LongText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/sell/account/v2/payout_settings
.
The result is extracted from:{{=response.payoutInstruments}}
.Documentation: https://developer.ebay.com/api-docs/sell/account/v2/resources/payout_settings/methods/getPayoutSettings.
- [Update] action
-
Endpoint URL address:
/sell/account/v2/payout_settings/update_percentage
.
The action uses POST method.Documentation: https://developer.ebay.com/api-docs/sell/account/v2/resources/payout_settings/methods/updatePayoutPercentage.
- accountLastFourDigits
Data type: DT_I4
- instrumentId
Template: ShortText.
- instrumentStatus
Template: ShortText.
- instrumentType
Template: ShortText.
- nickname
Template: ShortText.
- payoutPercentage
Template: Number.
- payoutInstruments
Field components:
- An array.
- Contains the following components: instrumentId, payoutPercentage.
Based on resource template AccountNoPagination.
- [Read] action
-
Endpoint URL address:
/advertising_eligibility
.
The result is extracted from:{{=response.advertisingEligibility}}
.The action has the following user-defined parameters:
- X-EBAY-C-MARKETPLACE-ID: Required. The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked.
Documentation: https://developer.ebay.com/api-docs/sell/account/resources/advertising_eligibility/methods/getAdvertisingEligibility.
- programType
Template: ShortText.
- reason
Template: ShortText.
- status
Template: ShortText.
- [Read] action
-
The following request parameters will be automatically processed:
-
X-EBAY-C-MARKETPLACE-ID:
{{=parameters.get('X-EBAY-C-MARKETPLACE-ID')}}
-
_includeUserParameters:
{{=parameters}}
-
X-EBAY-C-MARKETPLACE-ID:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Upsert] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
Based on resource template NoPagination.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}}
-
limit:
{{=parameters.batchSize}}
-
offset:
- [Read Single] action
-
The result is extracted from:{{=[response]}}
.
The result is paginated.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
-
limit:
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template NoPagination.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Account.
- [Read] action
-
The result is paginated.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Boolean
Data type: DT_BOOL
- Number
Data type: DT_R8
- Id
Data type: DT_UI8
- Decimal
Data type: DT_DECIMAL
- Rate
Field components:
- Contains the following components: value, numerator, denominator.
- Amount
Field components:
-
Uses template:
ShortText
. - Contains the following components: currency, value.
-
Uses template:
- PayoutAmount
Field components:
-
Uses template:
ShortText
. - Contains the following components: currency, value, exchangeRate, convertedToValue, convertedToCurrency, convertedFromCurrency, convertedFromValue.
-
Uses template:
- TimeDuration
Field components:
-
Uses template:
ShortText
. - Contains the following components: unit, value.
-
Uses template:
- AdditionalInfo
Field components:
-
Uses template:
ShortText
. - Contains the following components: infoType, metrics.
-
Uses template:
- Dimension
Field components:
-
Uses template:
ShortText
. - Contains the following components: dimensionKey, name, value.
-
Uses template:
- InventoryItem
Field components:
-
Uses template:
ShortText
. - Contains the following components: sku, availability, condition, conditionDescription, conditionDescriptors, packageWeightAndSize, product, locale.
-
Uses template:
- NameValueList
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, value.
-
Uses template:
- Tax
Field components:
-
Uses template:
ShortText
. - Contains the following components: applyTax, thirdPartyTaxCategory, vatPercentage.
-
Uses template:
- CountryPolicy
Field components:
-
Uses template:
ShortText
. - Contains the following components: country, policyIds.
-
Uses template:
- Address
Field components:
-
Uses template:
ShortText
. - Contains the following components: addressLine1, addressLine2, city, country, county, postalCode, stateOrProvince.
-
Uses template:
- Interval
Field components:
- An array.
- Contains the following components: close, open.
- Location
Field components:
-
Uses template:
Address
. - Contains the following components: address, geoCoordinates, locationId.
-
Uses template:
- Alert
Field components:
-
Uses template:
ShortText
. - Contains the following components: alertType, details.
-
Uses template:
- Ad
Field components:
-
Uses template:
ShortText
. - Contains the following components: adId, campaignId, adGroupId, adStatus, bidPercentage, inventoryReferenceId, inventoryReferenceType, listingId, alerts.
-
Uses template:
- BudgetRequest
Field components:
-
Uses template:
Amount
. - Contains the following components: amount.
-
Uses template:
- SelectionRule
Field components:
- An array.
- Contains the following components: brands, categoryIds, categoryScope, listingConditionIds, maxPrice, minPrice.
- DynamicAdRatePreference
Field components:
-
Uses template:
ShortText
. - Contains the following components: adRateAdjustmentPercent, adRateCapPercent.
-
Uses template:
- FundingStrategy
Field components:
-
Uses template:
ShortText
. - Contains the following components: adRateStrategy, biddingStrategy, bidPercentage, dynamicAdRatePreferences, fundingModel.
-
Uses template:
- InventoryCriterion
Field components:
-
Uses template:
ShortText
. - Contains the following components: inventoryCriterionType, inventoryItems, listingIds, ruleCriteria.
-
Uses template:
- DiscountBenefit
Field components:
-
Uses template:
Amount
. - Contains the following components: amountOffItem, amountOffOrder, percentageOffItem, percentageOffOrder.
-
Uses template:
- Phone
Field components:
-
Uses template:
ShortText
. - Contains the following components: countryCode, number, phoneType.
-
Uses template:
- RegAddress
Field components:
-
Uses template:
ShortText
. - Contains the following components: companyName, contactAddress, email, fullName, primaryPhone.
-
Uses template:
- Buyer
Field components:
-
Uses template:
RegAddress
. - Contains the following components: buyerRegistrationAddress, taxAddress, taxIdentifier, username.
-
Uses template:
- FeeJurisdiction
Field components:
-
Uses template:
ShortText
. - Contains the following components: regionName, regionType.
-
Uses template:
- TrackingInfo
Field components:
-
Uses template:
ShortText
. - Contains the following components: shipmentTrackingNumber, shippingCarrierCode.
-
Uses template:
- NameValuePair
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, value.
-
Uses template:
- OrderLineItem
Field components:
-
Uses template:
ShortText
. - Contains the following components: itemId, lineItemId.
-
Uses template:
- HazardStatement
Field components:
-
Uses template:
ShortText
. - Contains the following components: statementId, statementDescription.
-
Uses template:
- Definition
Field components:
-
Uses template:
ShortText
. - Contains the following components: dataType, key, localizedName.
-
Uses template:
- Image
Field components:
-
Uses template:
ShortText
. - Contains the following components: height, imageUrl, width.
-
Uses template:
- ShippingLocation
Field components:
-
Uses template:
ShortText
. - Contains the following components: country, postalCode.
-
Uses template:
- Region
Field components:
-
Uses template:
ShortText
. - Contains the following components: regionId, regionName, regionType.
-
Uses template:
- ShipToLocation
Field components:
- Contains the following components: regionExcluded, regionIncluded.
- TaxItem
Field components:
-
Uses template:
ShortText
. - Contains the following components: ebayCollectAndRemitTax, includedInPrice, shippingAndHandlingTaxed, taxJurisdiction, taxPercentage, taxType.
-
Uses template:
- AspectBuy
Field components:
-
Uses template:
ShortText
. - Contains the following components: localizedName, localizedValues.
-
Uses template:
- SubscriptionPayloadDetail
Field components:
-
Uses template:
ShortText
. - Contains the following components: format, schemaVersion, deliveryProtocol.
-
Uses template:
- CategoryType
Field components:
-
Uses template:
ShortText
. - Contains the following components: default, name.
-
Uses template:
- RecipientAccountReference
Field components:
-
Uses template:
ShortText
. - Contains the following components: referenceId, referenceType.
-
Uses template:
- TransactionDonMark
Field components:
-
Uses template:
PayoutAmount
. - Contains the following components: amount, feeJurisdiction, feeMemo, feeType.
-
Uses template:
- ReturnPolicy
Field components:
-
Uses template:
LongText
. - Contains the following components: returnsAcceptanceEnabled, policyDescriptionEnabled, returnShippingCostPayers, refundMethods, returnMethods, returnPeriods.
-
Uses template:
- ActionT
Knowledge Base
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.