# eBay

eBay is a global marketplace where businesses and individuals can buy and sell items.

eBay integration replicates data using the [eBay Fulfillment API](https://developer.ebay.com/api-docs/sell/fulfillment/static/overview.html).

See the [Schema](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/WebApplications/Connecting-Ebay.htm#Schema) section for a list of objects available for replication.

## Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Information noteMake sure that the account you use has read access to the tables you want to fetch.

To retrieve your client secret and ID:

1. Log into your [eBay](https://developer.ebay.com/signin?return_to=%2Fmy%2Fkeys) developer portal.
2. Go to the Application Keys page.
3. Enter your application name.
4. Under either Sandbox or Production, click Create a keyset.
5. Click OAuth Scopes to confirm the App ID has the required scopes.
6. In the User Tokens field, enter the redirect URL https://connector.qlik.com/auth/oauth/v3.htm.
7. Copy and paste your client secret and client ID into a secured file.

## Creating the connection

For more information, see [Connecting to SaaS applications](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/Landing/connecting-web-applications.htm).

1. Click Authenticate when you have filled in the required connection settings.

   You may be asked to log in to the source application.

   A window is displayed with an authentication code.

2. Copy the code to the clipboard and return to the connection dialog.

3. Paste the code in Complete authentication with the code provided by the source and click Verify.

   Tip noteYou may need to scroll down to see this field.

   When status is Verified, the authentication is verified.

4. Provide a name for the connection in Connection name.

5. Select Open connection metadata to define metadata for the connection when it has been created.

Connection settings

| Setting | Description |
| --- | --- |
| Data gateway | Select a Data Movement gateway if required by your use case.<br><br>Information note<br><br>This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None.<br><br>For information on the benefits of Data Movement gateway and use cases that require it, see [Qlik Data Gateway - Data Movement](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Gateways/replication-gateway.htm). |
| Start Date | Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target. |
| Client ID | Client ID. |
| Client Secret | Client secret. |

## Schema

Information note

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

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

### 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** | Full Table |
| --- | --- |
| **Primary Key** | orderId |
| **Useful links** | [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**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>username: STRING</li></ul> |
| --- |
| **buyerCheckoutNotes**<br><br><br>STRING |
| **cancelStatus**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>cancelRequests: ARRAY, which is also a nested data structure.											<ul><li>cancelCompletedDate: STRING</li><li>cancelInitiator: STRING</li><li>cancelReason: STRING</li><li>cancelRequestId: STRING</li><li>cancelRequestState: STRING</li><li>cancelRequestedDate: STRING</li></ul></li><li>cancelState: STRING</li><li>cancelledDate: STRING</li></ul> |
| **creationDate**<br><br><br>STRING |
| **ebayCollectAndRemitTax**<br><br><br>BOOLEAN |
| **fulfillmentHrefs**<br><br><br>ARRAY<br><br>This is a nested data structure. |
| **fulfillmentStartInstructions**<br><br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>ebaySupportedFulfillment: BOOLEAN</li><li>finalDestinationAddress: OBJECT, which is also a nested data structure.											<ul><li>addressLine1: STRING</li><li>addressLine2: STRING</li><li>city: STRING</li><li>countryCode: STRING</li><li>county: STRING</li><li>postalCode: STRING</li><li>stateOrProvince: STRING</li></ul></li><li>fulfillmentInstructionsType: STRING</li><li>maxEstimatedDeliveryDate: STRING</li><li>minEstimatedDeliveryDate: STRING</li><li>pickupStep: OBJECT, which is also a nested data structure.											<ul><li>merchantLocationKey: STRING</li></ul></li><li>shippingStep: OBJECT, which is also a nested data structure.											<ul><li>shipTo: OBJECT, which is also a nested data structure.													<ul><li>companyName: STRING</li><li>contactAddress: OBJECT, which is also a nested data structure.															<ul><li>addressLine1: STRING</li><li>addressLine2: STRING</li><li>city: STRING</li><li>countryCode: STRING</li><li>county: STRING</li><li>postalCode: STRING</li><li>stateOrProvince: STRING</li></ul></li><li>email: STRING</li><li>fullName: STRING</li><li>primaryPhone: OBJECT, which is also a nested data structure.															<ul><li>phoneNumber: STRING</li></ul></li></ul></li><li>shipToReferenceId: STRING</li><li>shippingCarrierCode: STRING</li><li>shippingServiceCode: STRING</li></ul></li></ul> |
| **lastModifiedDate**<br><br><br>STRING |
| **legacyOrderId**<br><br><br>STRING |
| **lineItems**<br><br><br>ARRAY<br><br>This is a nested data structure:<br><br><ul><li>appliedPromotions: ARRAY, which is also a nested data structure.											<ul><li>description: STRING</li><li>discountAmount: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>promotionId: STRING</li></ul></li><li>deliveryCost: OBJECT, which is also a nested data structure.											<ul><li>importCharges: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>shippingCost: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>shippingIntermediationFee: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li></ul></li><li>discountedLineItemCost: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>ebayCollectAndRemitTaxes: ARRAY, which is also a nested data structure.											<ul><li>amount: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>taxType: STRING</li></ul></li><li>giftDetails: OBJECT, which is also a nested data structure.											<ul><li>message: STRING</li><li>recipientEmail: STRING</li><li>senderName: STRING</li></ul></li><li>legacyItemId: STRING</li><li>legacyVariationId: STRING</li><li>lineItemCost: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>lineItemFulfillmentInstructions: OBJECT, which is also a nested data structure.											<ul><li>guaranteedDelivery: BOOLEAN</li><li>maxEstimatedDeliveryDate: STRING</li><li>minEstimatedDeliveryDate: STRING</li><li>shipByDate: STRING</li></ul></li><li>lineItemFulfillmentStatus: STRING</li><li>lineItemId: STRING</li><li>listingMarketplaceId: STRING</li><li>properties: OBJECT, which is also a nested data structure.											<ul><li>buyerProtection: BOOLEAN</li><li>fromBestOffer: BOOLEAN</li><li>soldViaAdCampaign: BOOLEAN</li></ul></li><li>purchaseMarketplaceId: STRING</li><li>quantity: INTEGER</li><li>refunds: ARRAY, which is also a nested data structure.											<ul><li>amount: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>refundDate: STRING</li><li>refundReferenceId: STRING</li></ul></li><li>sku: STRING</li><li>soldFormat: STRING</li><li>taxes: ARRAY, which is also a nested data structure.											<ul><li>amount: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li></ul></li><li>title: STRING</li><li>total: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li></ul> |
| **orderFulfillmentStatus**<br><br><br>STRING |
| **orderId**<br><br><br>STRING |
| **orderPaymentStatus**<br><br><br>STRING |
| **paymentSummary**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>payments: ARRAY, which is also a nested data structure.											<ul><li>amount: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>paymentDate: STRING</li><li>paymentHolds: ARRAY, which is also a nested data structure.													<ul><li>expectedReleaseDate: STRING</li><li>holdAmount: OBJECT, which is also a nested data structure.															<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>holdReason: STRING</li><li>holdState: STRING</li><li>releaseDate: STRING</li><li>sellerActionsToRelease: ARRAY, which is also a nested data structure.															<ul><li>sellerActionToRelease: STRING</li></ul></li></ul></li><li>paymentMethod: STRING</li><li>paymentReferenceId: STRING</li><li>paymentStatus: STRING</li></ul></li><li>refunds: ARRAY, which is also a nested data structure.											<ul><li>amount: OBJECT, which is also a nested data structure.													<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>refundDate: STRING</li><li>refundReferenceId: STRING</li><li>refundStatus: STRING</li></ul></li><li>totalDueSeller: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li></ul> |
| **pricingSummary**<br><br><br>OBJECT<br><br>This is a nested data structure:<br><br><ul><li>adjustment: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>deliveryCost: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>deliveryDiscount: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>fee: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>priceDiscountSubtotal: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>priceSubtotal: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>tax: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li><li>total: OBJECT, which is also a nested data structure.											<ul><li>convertedFromCurrency: STRING</li><li>convertedFromValue: STRING</li><li>currency: STRING</li><li>value: STRING</li></ul></li></ul> |
| **salesRecordReference**<br><br><br>STRING |
| **sellerId**<br><br><br>STRING |