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

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the eBay icon.

  4. 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:

  • For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

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.

Step 3: Create a replication schedule

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:

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

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

Step 5: Set objects to replicate

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:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.
  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.
  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. 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.

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.


eBay table reference

Replication Method :

Full Table

Primary Key :

orderId

API endpoint :

getOrders

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

orderId
STRING

The order ID.

buyer
OBJECT

username
STRING

orders (table), buyer (attribute)

buyerCheckoutNotes
STRING

cancelStatus
OBJECT

cancelRequests
ARRAY

value
OBJECT

cancelCompletedDate
STRING

cancelInitiator
STRING

cancelReason
STRING

cancelRequestId
STRING

cancelRequestState
STRING

cancelRequestedDate
STRING

orders (table), value (attribute)
orders (table), cancelRequests (attribute)

cancelState
STRING

cancelledDate
STRING

orders (table), cancelStatus (attribute)

creationDate
STRING

ebayCollectAndRemitTax
BOOLEAN

fulfillmentHrefs
ARRAY

value
STRING

orders (table), fulfillmentHrefs (attribute)

fulfillmentStartInstructions
ARRAY

value
OBJECT

ebaySupportedFulfillment
BOOLEAN

finalDestinationAddress
OBJECT

addressLine1
STRING

addressLine2
STRING

city
STRING

countryCode
STRING

county
STRING

postalCode
STRING

stateOrProvince
STRING

orders (table), finalDestinationAddress (attribute)

fulfillmentInstructionsType
STRING

maxEstimatedDeliveryDate
STRING

minEstimatedDeliveryDate
STRING

pickupStep
OBJECT

merchantLocationKey
STRING

orders (table), pickupStep (attribute)

shippingStep
OBJECT

shipTo
OBJECT

companyName
STRING

contactAddress
OBJECT

addressLine1
STRING

addressLine2
STRING

city
STRING

countryCode
STRING

county
STRING

postalCode
STRING

stateOrProvince
STRING

orders (table), contactAddress (attribute)

email
STRING

fullName
STRING

primaryPhone
OBJECT

phoneNumber
STRING

orders (table), primaryPhone (attribute)
orders (table), shipTo (attribute)

shipToReferenceId
STRING

shippingCarrierCode
STRING

shippingServiceCode
STRING

orders (table), shippingStep (attribute)
orders (table), value (attribute)
orders (table), fulfillmentStartInstructions (attribute)

lastModifiedDate
STRING

legacyOrderId
STRING

lineItems
ARRAY

value
OBJECT

appliedPromotions
ARRAY

value
OBJECT

description
STRING

discountAmount
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), discountAmount (attribute)

promotionId
STRING

orders (table), value (attribute)
orders (table), appliedPromotions (attribute)

deliveryCost
OBJECT

importCharges
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), importCharges (attribute)

shippingCost
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), shippingCost (attribute)

shippingIntermediationFee
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), shippingIntermediationFee (attribute)
orders (table), deliveryCost (attribute)

discountedLineItemCost
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), discountedLineItemCost (attribute)

ebayCollectAndRemitTaxes
ARRAY

value
OBJECT

amount
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), amount (attribute)

taxType
STRING

orders (table), value (attribute)
orders (table), ebayCollectAndRemitTaxes (attribute)

giftDetails
OBJECT

message
STRING

recipientEmail
STRING

senderName
STRING

orders (table), giftDetails (attribute)

legacyItemId
STRING

legacyVariationId
STRING

lineItemCost
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), lineItemCost (attribute)

lineItemFulfillmentInstructions
OBJECT

guaranteedDelivery
BOOLEAN

maxEstimatedDeliveryDate
STRING

minEstimatedDeliveryDate
STRING

shipByDate
STRING

orders (table), lineItemFulfillmentInstructions (attribute)

lineItemFulfillmentStatus
STRING

lineItemId
STRING

listingMarketplaceId
STRING

properties
OBJECT

buyerProtection
BOOLEAN

fromBestOffer
BOOLEAN

soldViaAdCampaign
BOOLEAN

orders (table), properties (attribute)

purchaseMarketplaceId
STRING

quantity
INTEGER

refunds
ARRAY

value
OBJECT

amount
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), amount (attribute)

refundDate
STRING

refundReferenceId
STRING

orders (table), value (attribute)
orders (table), refunds (attribute)

sku
STRING

soldFormat
STRING

taxes
ARRAY

value
OBJECT

amount
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), amount (attribute)
orders (table), value (attribute)
orders (table), taxes (attribute)

title
STRING

total
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), total (attribute)
orders (table), value (attribute)
orders (table), lineItems (attribute)

orderFulfillmentStatus
STRING

orderPaymentStatus
STRING

paymentSummary
OBJECT

payments
ARRAY

value
OBJECT

amount
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), amount (attribute)

paymentDate
STRING

paymentHolds
ARRAY

value
OBJECT

expectedReleaseDate
STRING

holdAmount
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), holdAmount (attribute)

holdReason
STRING

holdState
STRING

releaseDate
STRING

sellerActionsToRelease
ARRAY

value
OBJECT

sellerActionToRelease
STRING

orders (table), value (attribute)
orders (table), sellerActionsToRelease (attribute)
orders (table), value (attribute)
orders (table), paymentHolds (attribute)

paymentMethod
STRING

paymentReferenceId
STRING

paymentStatus
STRING

orders (table), value (attribute)
orders (table), payments (attribute)

refunds
ARRAY

value
OBJECT

amount
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), amount (attribute)

refundDate
STRING

refundReferenceId
STRING

refundStatus
STRING

orders (table), value (attribute)
orders (table), refunds (attribute)

totalDueSeller
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), totalDueSeller (attribute)
orders (table), paymentSummary (attribute)

pricingSummary
OBJECT

adjustment
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), adjustment (attribute)

deliveryCost
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), deliveryCost (attribute)

deliveryDiscount
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), deliveryDiscount (attribute)

fee
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), fee (attribute)

priceDiscountSubtotal
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), priceDiscountSubtotal (attribute)

priceSubtotal
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), priceSubtotal (attribute)

tax
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), tax (attribute)

total
OBJECT

convertedFromCurrency
STRING

convertedFromValue
STRING

currency
STRING

value
STRING

orders (table), total (attribute)
orders (table), pricingSummary (attribute)

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.