# eBay (v1)
Information note **eBay is in beta**
eBay is currently in beta. The info in this guide is subject to change.
Information note **eBay is supported by the Singer community**
This integration is powered by [Singer's](https://www.singer.io/) eBay tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-ebay) or [join the Singer Slack](https://singer-slackin.herokuapp.com/).
## eBay integration summary
Stitch’s eBay integration replicates data using the [eBay Fulfillment API](https://developer.ebay.com/api-docs/sell/fulfillment/static/overview.html). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/ebay#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](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Beta | **Supported by**
the Info icon
Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) |
| **Stitch plan**
the Info icon
The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**
the Info icon
Indicates if the integration is available as a source in Stitch Connect. | the Success icon
This version of the integration is available via the API.
Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon
Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.
The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon
This feature is supported for this version of the integration.
Supported | **Column selection**
the Info icon
The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon
This feature is supported for this version of the integration.
Supported |
| **Select all**
the Info icon
Indicates if the integration supports selecting all available tables and columns. | the Success icon
Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon
This feature is supported for this version of the integration.
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](https://app.stitchdata.com/).
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 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](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) 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](https://help.qlik.com/en-US/stitch/integrations/saas/ebay#orders).
### Step 3: Create a replication schedule
Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.
In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). 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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)
* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)
* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (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](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) 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
Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements).
The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/ebay#schema)
**Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts.
* Selection options
* Individual tables and columns
* All tables and columns
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.
Information note **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](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature.
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 tabThe 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.**
Information note
**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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) 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.
Information note **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
Information note
**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.
Information note
**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](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) 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](https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrders#h2-error-codes).
| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table |
| --- | --- |
| **Primary Key ** | orderId |
| **Useful links** | [orders schema on GitHub](https://github.com/singer-io/tap-ebay/blob/master/tap_ebay/schemas/orders.json "Opens in new tab: orders schema on GitHub")
[eBay API method](https://developer.ebay.com/api-docs/sell/fulfillment/resources/order/methods/getOrders "Opens in new tab: eBay API method") |
orders table schema
| **buyer**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand buyer
username
STRING
|
| --- |
| **buyerCheckoutNotes**
STRING |
| **cancelStatus**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand cancelStatus
cancelRequests
ARRAY
cancelCompletedDate
STRING
cancelInitiator
STRING
cancelReason
STRING
cancelRequestId
STRING
cancelRequestState
STRING
cancelRequestedDate
STRING
cancelState
STRING
cancelledDate
STRING
|
| **creationDate**
STRING |
| **ebayCollectAndRemitTax**
BOOLEAN |
| **fulfillmentHrefs**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. |
| **fulfillmentStartInstructions**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand fulfillmentStartInstructions
ebaySupportedFulfillment
BOOLEAN
finalDestinationAddress
OBJECT
addressLine1
STRING
addressLine2
STRING
city
STRING
countryCode
STRING
county
STRING
postalCode
STRING
stateOrProvince
STRING
fulfillmentInstructionsType
STRING
maxEstimatedDeliveryDate
STRING
minEstimatedDeliveryDate
STRING
pickupStep
OBJECT
merchantLocationKey
STRING
shippingStep
OBJECT
shipTo
OBJECT
companyName
STRING
contactAddress
OBJECT
addressLine1
STRING
addressLine2
STRING
city
STRING
countryCode
STRING
county
STRING
postalCode
STRING
stateOrProvince
STRING
email
STRING
fullName
STRING
primaryPhone
OBJECT
phoneNumber
STRING
shipToReferenceId
STRING
shippingCarrierCode
STRING
shippingServiceCode
STRING
|
| **lastModifiedDate**
STRING |
| **legacyOrderId**
STRING |
| **lineItems**
ARRAY
This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand lineItems
appliedPromotions
ARRAY
description
STRING
discountAmount
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
promotionId
STRING
deliveryCost
OBJECT
importCharges
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
shippingCost
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
shippingIntermediationFee
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
discountedLineItemCost
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
ebayCollectAndRemitTaxes
ARRAY
amount
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
taxType
STRING
giftDetails
OBJECT
message
STRING
recipientEmail
STRING
senderName
STRING
legacyItemId
STRING
legacyVariationId
STRING
lineItemCost
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
lineItemFulfillmentInstructions
OBJECT
guaranteedDelivery
BOOLEAN
maxEstimatedDeliveryDate
STRING
minEstimatedDeliveryDate
STRING
shipByDate
STRING
lineItemFulfillmentStatus
STRING
lineItemId
STRING
listingMarketplaceId
STRING
properties
OBJECT
buyerProtection
BOOLEAN
fromBestOffer
BOOLEAN
soldViaAdCampaign
BOOLEAN
purchaseMarketplaceId
STRING
quantity
INTEGER
refunds
ARRAY
amount
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
refundDate
STRING
refundReferenceId
STRING
sku
STRING
soldFormat
STRING
taxes
ARRAY
amount
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
title
STRING
total
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
|
| **orderFulfillmentStatus**
STRING |
| **orderId**
STRING |
| **orderPaymentStatus**
STRING |
| **paymentSummary**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.
Click to expand paymentSummary
payments
ARRAY
amount
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
paymentDate
STRING
paymentHolds
ARRAY
expectedReleaseDate
STRING
holdAmount
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
holdReason
STRING
holdState
STRING
releaseDate
STRING
sellerActionsToRelease
ARRAY
sellerActionToRelease
STRING
paymentMethod
STRING
paymentReferenceId
STRING
paymentStatus
STRING
refunds
ARRAY
amount
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
refundDate
STRING
refundReferenceId
STRING
refundStatus
STRING
totalDueSeller
OBJECT
convertedFromCurrency
STRING
convertedFromValue
STRING
currency
STRING
value
STRING
|
| **pricingSummary**
OBJECT
This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.