eBay (v1) | Stitch Documentation

eBay is in beta
eBay is currently in beta. The info in this guide is subject to change.

eBay is supported by the Singer community
This integration is powered by Singer's eBay tap. For support, visit the GitHub repo or join the Singer Slack.

eBay integration summary

Stitch’s eBay integration replicates data using the eBay Fulfillment API. Refer to the Schema section for a list of objects available for replication.

eBay feature snapshot

A high-level look at Stitch's eBay (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status	Beta	Supported by	Singer Community
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-ebay
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting eBay

eBay setup requirements

To set up eBay in Stitch, you need:

An eBay seller account. This account owns the sales data.

Step 1: Add eBay as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the eBay icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

For example, the name “Stitch eBay” would create a schema called stitch_ebay in the destination. Note: Schema names cannot be changed after you save the integration.

Step 2: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your eBay integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond eBay’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Note: To retrieve data from the orders table, the Start Date must not exceed 90 days from the current date, whether you’re initially creating the integration or resetting this parameter. If this exceeds 90 days, you’ll encounter errors during Extraction.

Step 3: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

eBay integrations support the following replication scheduling methods:

Replication Frequency
Anchor Scheduling
Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 4: Authorize Stitch to access eBay

Next, you’ll be prompted to sign into your eBay account.
Follow the prompts to complete the authorization process.
After the authorization process is successfully completed, you’ll be directed back to Stitch.
Click All Done.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements for selection and replication.

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For eBay integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’s Tables to Replicate tab, locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
Repeat this process for all the tables and columns you want to replicate.
When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Important: Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections. Refer to the Select All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click the Tables to Replicate tab.
In the list of tables, click the box next to the Table Names column.
In the menu that displays, click Track all Tables and Fields:
Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up eBay, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

eBay table reference

Schemas and versioning

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for version 1 of this integration.

This is the latest version of the eBay integration.

Table and column names in your destination

Depending on your destination, table and column names may not appear as they are outlined below.

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

orders

The orders table contains details about all orders in your eBay seller account.

Note: The integration’s Start Date must be within 90 days of the current date, if initially creating or resetting the integration. Exceeding 90 days will result in an eBay 30830 API error.

Replication Method

Full Table

Primary Key

orderId

Useful links

orders schema on GitHub

eBay API method

orders table schema

buyer

OBJECT

Click to expand buyer

username

STRING

buyerCheckoutNotes

STRING

cancelStatus

OBJECT

Click to expand cancelStatus

cancelRequests

ARRAY

Click to expand cancelRequests

cancelCompletedDate

STRING

cancelInitiator

STRING

cancelReason

STRING

cancelRequestId

STRING

cancelRequestState

STRING

cancelRequestedDate

STRING

cancelState

STRING

cancelledDate

STRING

creationDate

STRING

ebayCollectAndRemitTax

BOOLEAN

fulfillmentHrefs

ARRAY

fulfillmentStartInstructions

ARRAY

Click to expand fulfillmentStartInstructions

ebaySupportedFulfillment

BOOLEAN

finalDestinationAddress

OBJECT

Click to expand finalDestinationAddress

addressLine1

STRING

addressLine2

STRING

city

STRING

countryCode

STRING

county

STRING

postalCode

STRING

stateOrProvince

STRING

fulfillmentInstructionsType

STRING

maxEstimatedDeliveryDate

STRING

minEstimatedDeliveryDate

STRING

pickupStep

OBJECT

Click to expand pickupStep

merchantLocationKey

STRING

shippingStep

OBJECT

Click to expand shippingStep

shipTo

OBJECT

Click to expand shipTo

companyName

STRING

contactAddress

OBJECT

Click to expand contactAddress

addressLine1

STRING

addressLine2

STRING

city

STRING

countryCode

STRING

county

STRING

postalCode

STRING

stateOrProvince

STRING

email

STRING

fullName

STRING

primaryPhone

OBJECT

Click to expand primaryPhone

phoneNumber

STRING

shipToReferenceId

STRING

shippingCarrierCode

STRING

shippingServiceCode

STRING

lastModifiedDate

STRING

legacyOrderId

STRING

lineItems

ARRAY

Click to expand lineItems

appliedPromotions

ARRAY

Click to expand appliedPromotions

description

STRING

discountAmount

OBJECT

Click to expand discountAmount

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

promotionId

STRING

deliveryCost

OBJECT

Click to expand deliveryCost

importCharges

OBJECT

Click to expand importCharges

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

shippingCost

OBJECT

Click to expand shippingCost

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

shippingIntermediationFee

OBJECT

Click to expand shippingIntermediationFee

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

discountedLineItemCost

OBJECT

Click to expand discountedLineItemCost

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

ebayCollectAndRemitTaxes

ARRAY

Click to expand ebayCollectAndRemitTaxes

amount

OBJECT

Click to expand amount

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

taxType

STRING

giftDetails

OBJECT

Click to expand giftDetails

message

STRING

recipientEmail

STRING

senderName

STRING

legacyItemId

STRING

legacyVariationId

STRING

lineItemCost

OBJECT

Click to expand lineItemCost

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

lineItemFulfillmentInstructions

OBJECT

Click to expand lineItemFulfillmentInstructions

guaranteedDelivery

BOOLEAN

maxEstimatedDeliveryDate

STRING

minEstimatedDeliveryDate

STRING

shipByDate

STRING

lineItemFulfillmentStatus

STRING

lineItemId

STRING

listingMarketplaceId

STRING

properties

OBJECT

Click to expand properties

buyerProtection

BOOLEAN

fromBestOffer

BOOLEAN

soldViaAdCampaign

BOOLEAN

purchaseMarketplaceId

STRING

quantity

INTEGER

refunds

ARRAY

Click to expand refunds

amount

OBJECT

Click to expand amount

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

refundDate

STRING

refundReferenceId

STRING

sku

STRING

soldFormat

STRING

taxes

ARRAY

Click to expand taxes

amount

OBJECT

Click to expand amount

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

title

STRING

total

OBJECT

Click to expand total

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

orderFulfillmentStatus

STRING

orderId

STRING

orderPaymentStatus

STRING

paymentSummary

OBJECT

Click to expand paymentSummary

payments

ARRAY

Click to expand payments

amount

OBJECT

Click to expand amount

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

paymentDate

STRING

paymentHolds

ARRAY

Click to expand paymentHolds

expectedReleaseDate

STRING

holdAmount

OBJECT

Click to expand holdAmount

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

holdReason

STRING

holdState

STRING

releaseDate

STRING

sellerActionsToRelease

ARRAY

Click to expand sellerActionsToRelease

sellerActionToRelease

STRING

paymentMethod

STRING

paymentReferenceId

STRING

paymentStatus

STRING

refunds

ARRAY

Click to expand refunds

amount

OBJECT

Click to expand amount

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

refundDate

STRING

refundReferenceId

STRING

refundStatus

STRING

totalDueSeller

OBJECT

Click to expand totalDueSeller

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

pricingSummary

OBJECT

Click to expand pricingSummary

adjustment

OBJECT

Click to expand adjustment

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

deliveryCost

OBJECT

Click to expand deliveryCost

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

deliveryDiscount

OBJECT

Click to expand deliveryDiscount

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

fee

OBJECT

Click to expand fee

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

priceDiscountSubtotal

OBJECT

Click to expand priceDiscountSubtotal

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

priceSubtotal

OBJECT

Click to expand priceSubtotal

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

tax

OBJECT

Click to expand tax

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

total

OBJECT

Click to expand total

convertedFromCurrency

STRING

convertedFromValue

STRING

currency

STRING

value

STRING

salesRecordReference

STRING

sellerId

STRING

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Third-Party Downtime Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues