CData Sync App は、Amazon Marketplace データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Amazon Marketplace コネクタはCData Sync アプリケーションから使用可能で、Amazon Marketplace からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はAmazon Marketplace API を利用して、Amazon Selling Partner (SP) API への双方向のアクセスを可能にします。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
以下のプロパティが必須です。
Amazon Marketplace はOAuth 認証標準を利用しています。
OAuth で認証するには、組み込みアプリケーションを使用するか、新しいカスタムOAuth アプリを作成する必要があります。組み込みアプリケーションは、デスクトップアプリケーションおよびヘッドレスマシンをサポートします。Web アプリケーションでは、カスタムOAuth アプリケーションを作成する必要があります。
カスタムOAuth アプリケーションを使用して、サービスアカウントまたはユーザーアカウントで認証できます。詳しくは、カスタムOAuth アプリの作成 を参照してください。
Amazon Marketplace は埋め込みクレデンシャルを6ヶ月ごとに入れ替える必要があるため、CData のクレデンシャルはoa.cdata.com でホストされます。カスタムクレデンシャルを指定しない場合、CData のWeb サービスから埋め込みクレデンシャルがダウンロードされ、デフォルトでOAuthClientLocation で指定した場所に保存されます。 NOTE:ファイアウォールがoa.cdata.com をブロックしないことを確認してください。
このセクションでは、Amazon Marketplace Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、Amazon Marketplace オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Amazon Marketplace オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、Amazon Marketplace API へのSQL の実行について詳しく説明します。
ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。
Seller Central API で利用可能なエンティティについては、Seller Central データモデル を参照してください。
Vendor Central API で利用可能なエンティティについては、Vendor Central データモデル を参照してください。
CData Sync App は、Seller Central API をリレーショナルビューおよびストアドプロシージャとしてモデル化します。
Amazon Seller Central データモデルを使用するには、Schema をSellerCentral に設定します。
ビュー は、Orders、OrderItems などの変更できないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
レポートタイプごとに、ビューが公開されています。たとえば、レポートタイプFEE_DISCOUNTS_REPORT はREPORT_FEE_DISCOUNTS_REPORT という名前のビューとして公開されます。 これらのビューは、'DataStartTime' と'DataEndTime' のオプション datetime パラメータを使用してクエリできます。両方のdatetime パラメータが指定されると、ドライバーは指定された間隔に一致する既存のレポートを自動的に検索し、見つからない場合は新しいレポートが作成されます。レポートは、RequestReport ストアドプロシージャを使用して手動で作成できます。 また、ReportOptions JSON-aggregate 擬似カラムを使用して、レポートタイプに応じて必要となる追加フィールドを指定することもできます。レポートオプションの詳細については、Amazon Selling-Partner API Documentation を参照してください。
レポートが作成され結果セットにプッシュされた後、次にこのレポートタイプに'DataStartTime' と'DataEndTime' の同じフィルタを使用してクエリを実行すると、新しいレポートが作成される代わりに、以前に作成されたレポートがダウンロードされます。
Sync App はAmazon Marketplace のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Destinations | Returns information about all destinations. |
| InboundDeliveryWindowOptions | Retrieves all delivery window options for a shipment. |
| InboundItemComplianceDetails | List the inbound compliance details for MSKUs in a given marketplace. |
| InboundPackingOptions | Retrieves a list of all packing options for an inbound plan. |
| InboundPlacementOptions | Provides a list of all placement options for an inbound plan. |
| InboundPlan | Provides a list of inbound plans with minimal information. |
| InboundSelfShipAppointmentSlots | Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. |
| InboundShipmentContentUpdatePreview | Retrieve a paginated list of shipment content update previews for a given shipment. |
| ListingsItems | Returns details about a listings item for a selling partner. |
| ListingsItemsAttributes | Returns details about a listings item attributes for a selling partner. |
| OutboundFulfillmentOrders | Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter. |
| Subscriptions | Returns information about subscriptions of the specified notification type. |
Returns information about all destinations.
| Name | Type | ReadOnly | References | Description |
| DestinationId [KEY] | String | False |
The destination identifier generated when you created the destination. | |
| Name | String | False |
The developer-defined name for this destination. | |
| ResourceSqsArn | String | False |
The Amazon Resource Name (ARN) associated with the SQS queue (Amazon Simple Queue Service queue destination). | |
| ResourceEventBridgeName | String | False |
The name of the partner event source associated with the destination (Amazon EventBridge destination). | |
| ResourceEventBridgeRegion | String | False |
The AWS region in which you will be receiving the notifications (Amazon EventBridge destination). | |
| ResourceEventBridgeAccountId | String | False |
The identifier for the AWS account that is responsible for charges related to receiving notifications (Amazon EventBridge destination). |
Retrieves all delivery window options for a shipment.
| Name | Type | ReadOnly | References | Description |
| InboundPlanId [KEY] | String | False |
Identifier of an inbound plan. | |
| ShipmentId [KEY] | String | False |
The shipment to generate delivery window options for. | |
| DeliveryWindowOptionId [KEY] | String | False |
Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered. | |
| StartDate | Datetime | False |
The timestamp at which this delivery window option starts. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| EndDate | Datetime | False |
The timestamp at which this delivery window option ends. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| ValidUntil | Datetime | False |
The timestamp at which this window delivery option becomes no longer valid. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| AvailabilityType | String | False |
Identifies type of Delivery Window Availability. Values: `AVAILABLE`, `CONGESTED` |
List the inbound compliance details for MSKUs in a given marketplace.
| Name | Type | ReadOnly | References | Description |
| Msku [KEY] | String | False |
The merchant SKU, a merchant-supplied identifier for a specific SKU. | |
| HsnCode | String | False |
Harmonized System of Nomenclature code. | |
| Amount | Decimal | False |
Decimal value of the currency. | |
| Code | String | False |
ISO 4217 standard of a currency code. | |
| Asin | String | False |
The Amazon Standard Identification Number, which identifies the detail page identifier. | |
| MarketplaceId | String | False |
The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values. | |
| Fnsku | String | False |
The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition. | |
| TaxRate | String | False |
Contains the type and rate of tax. |
Retrieves a list of all packing options for an inbound plan.
| Name | Type | ReadOnly | References | Description |
| PackingOptionId [KEY] | String | False |
Identifier of a packing option. | |
| InboundPlanId [KEY] | String | False |
Identifier of an inbound plan. | |
| Discounts | String | False |
Discount for the offered option. | |
| Fees | String | False |
Fee for the offered option. | |
| Expiration | Datetime | False |
The timestamp at which this packing option becomes no longer valid. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| Status | String | False |
The status of the packing option. Can be: `OFFERED`, `ACCEPTED`, or `EXPIRED`. | |
| ShippingConfiguration | String | False |
List of supported shipping modes. | |
| PackingGroups | String | False |
Packing group IDs. |
Provides a list of all placement options for an inbound plan.
| Name | Type | ReadOnly | References | Description |
| PlacementOptionId [KEY] | String | False |
The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs. | |
| InboundPlanId [KEY] | String | False |
Identifier of an inbound plan. | |
| Discounts | String | False |
Contains details about cost related modifications to the placement cost. | |
| Fees | String | False |
Contains details about cost related modifications to the placement cost. | |
| Expiration | Datetime | False |
The timestamp at which this packing option becomes no longer valid. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| Status | String | False |
The status of a placement option. Can be: `OFFERED`, `ACCEPTED`, or `EXPIRED`. | |
| ShipmentIds | String | False |
Shipment ids. | |
| CustomPlacementInput | String | False |
Provide units going to the warehouse. |
Provides a list of inbound plans with minimal information.
| Name | Type | ReadOnly | References | Description |
| InboundPlanId [KEY] | String | False |
Identifier of an inbound plan. | |
| Name | String | False |
Human-readable name of the inbound plan. | |
| MarketplaceIds | String | False |
A list of marketplace IDs. | |
| CreatedAt | Datetime | False |
The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| LastUpdatedAt | Datetime | False |
The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| Status | String | False |
Current status of the inbound plan. Can be: `ACTIVE`, `VOIDED`, `SHIPPED`, 'ERRORED'. | |
| ShipmentSummary | String | False |
Summary information about a shipment. | |
| PlacementOptionSummary | String | False |
Summary information about a placement option. | |
| PackingOptionSummary | String | False |
Summary information about a packing option. | |
| StateOrProvinceCode | String | False |
The state or province code. | |
| PhoneNumber | String | False |
The phone number. | |
| City | String | False |
The city. | |
| String | False |
The email address. | ||
| CompanyName | String | False |
The name of the business. | |
| PostalCode | String | False |
The postal code. | |
| AddressLine2 | String | False |
Additional street address information. | |
| AddressLine1 | String | False |
Street address information. | |
| CountryCode | String | False |
The country code in two-character ISO 3166-1 alpha-2 format. | |
| AddressName | String | False |
The name of the customer in the specified address. | |
| InboundPlanAggregate | String | False |
Parameter used for creating new inbound plans by passing the JSON aggregate. | |
| InboundPlanItems | String | False |
Inbound plan item's input parameters. Used for creating an inbound plan. |
Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.
| Name | Type | ReadOnly | References | Description |
| ShipmentId [KEY] | String | False |
Identifier of a shipment. A shipment contains the boxes and units being inbounded. | |
| InboundPlanId [KEY] | String | False |
Identifier of an inbound plan. | |
| SlotId [KEY] | String | False |
An identifier to a self-ship appointment slot. | |
| StartTime | Datetime | False |
The start timestamp of the appointment in UTC. | |
| EndTime | Datetime | False |
The end timestamp of the appointment in UTC. | |
| ExpiresAt | Datetime | False |
The time at which the self ship appointment slot expires. In ISO 8601 datetime format. |
Retrieve a paginated list of shipment content update previews for a given shipment.
| Name | Type | ReadOnly | References | Description |
| ShipmentId | String | False |
Identifier of a shipment. A shipment contains the boxes and units being inbounded. | |
| ContentUpdatePreviewId | String | False |
Identifier of a content update preview. | |
| InboundPlanId | String | False |
Identifier of an inbound plan. | |
| Expiration | Datetime | False |
The date in ISO 8601 format for when the content update expires. | |
| BoxUpdateInput | String | False |
Input information for updating a box | |
| ItemInput | String | False |
Defines an item's input parameters. | |
| VoidableUntil | Datetime | False |
Voidable until timestamp. | |
| Name | String | False |
The name of the carrier. | |
| EndTime | Datetime | False |
The end timestamp of the appointment in UTC. | |
| ShippingMode | String | False |
Mode of shipment transportation that this option will provide. Can be: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`. | |
| QuoteExpiration | Datetime | False |
The time at which this transportation option quote expires. | |
| TransportationOptionId | String | False |
Identifier of a transportation option. A transportation option represent one option for how to send a shipment. | |
| StartTime | Datetime | False |
The start timestamp of the appointment in UTC. | |
| AlphaCode | String | False |
The carrier code. For example, USPS or DHLEX. | |
| Amount | Decimal | False |
Decimal value of the currency. | |
| Code | String | False |
ISO 4217 standard of a currency code. | |
| ShippingSolution | String | False |
Shipping program for the option. Can be: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`. |
Returns details about a listings item for a selling partner.
The following filters are required:
SELECT * FROM ListingsItems WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
INSERT INTO ListingsItems (ProductType, Requirements, Attributes, SKU, SellerId)
VALUES ('product_type', 'LISTING', '{\"AttributeName\": \"test_attribute\", \"AttributeValue\": \"value\"}', '12345', 'XXXXXXXXXXXXXX')
DELETE FROM ListingsItems WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
When inserting, you can also use temp tables in order to insert multiple attributes, as shown in the example below:
INSERT INTO Attributes#TEMP (AttributeName, AttributeValue) VALUES ('attr1', 'val1')
INSERT INTO Attributes#TEMP (AttributeName, AttributeValue) VALUES ('attr2', 'val2')
INSERT INTO Attributes#TEMP (AttributeName, AttributeValue) VALUES ('attr3', 'val3')
INSERT INTO ListingsItems (ProductType, Requirements, Attributes, SKU, SellerId)
VALUES ('product_type', 'LISTING', 'Attributes#TEMP', '12345', 'XXXXXXXXXXXXXX')
*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.
| Name | Type | ReadOnly | References | Description |
| SKU [KEY] | String | False |
A selling partner provided identifier for an Amazon listing. | |
| FulfillmentAvailability | String | False |
Fulfillment availability for the listings item. | |
| Procurements | String | False |
The vendor procurement information for the listings item. | |
| ProcurementCostCurrency | String | False |
The price (ISO4217 currency code) that you want Amazon to pay you for this product. | |
| ProcurementCostAmount | String | False |
The price (numeric value) that you want Amazon to pay you for this product. | |
| Attributes | String | False |
This field is required for INSERT statements. Aggregate field containing structured 'AttributeName' and 'AttributeValue' fields. | |
| SellerId [KEY] | String | False |
A selling partner identifier, such as a merchant account or vendor code. | |
| Requirements | String | False |
This field can be specified for INSERT statements. 使用できる値は次のとおりです。LISTING, LISTING_PRODUCT_ONLY, LISTING_OFFER_ONLY | |
| ProductType | String | False |
This field is required for INSERT statements. |
Returns details about a listings item attributes for a selling partner.
The following filters are required:
SELECT * FROM ListingsItemsAttributes WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
UPDATE ListingsItemsAttributes SET AttributeValue = 'test_value', ProductType = 'LUGGAGE'
WHERE SKU = '12345' AND AttributeName = 'item_name_value'
You can also retrieve all SKU fields from another sub-query, for example:
SELECT * FROM ListingsItems WHERE SellerId = 'XXXXXXXXXXXXXX' AND SKU IN (
SELECT DISTINCT(SKUIdentifierSellerSKU) FROM CatalogItems WHERE MarketplaceId = 'XXXXXXXXXXXXXX' AND Query = 'test' AND SkuIdentifierSellerSku IS NOT NULL
)
| Name | Type | ReadOnly | References | Description |
| SKU [KEY] | String | True |
A selling partner provided identifier for an Amazon listing. | |
| AttributeName [KEY] | String | False |
The attribute name for the listings item. | |
| AttributeValue | String | False |
The attribute value for the listings item. | |
| ProductType | String | False |
The Amazon product type of the listings item. Required for Updating an attribute. | |
| SellerId [KEY] | String | True |
A selling partner identifier, such as a merchant account or vendor code. | |
| AttributePath | String | True |
The attribute path for the listings item. | |
| AttributeGroup | String | True |
The attribute group for the listings item. |
Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.
| Name | Type | ReadOnly | References | Description |
| SellerFulfillmentOrderId [KEY] | String | False |
The fulfillment order identifier | |
| DisplayableOrderId | String | False |
A fulfillment order identifier submitted when creating a fulfillment order. Displays as the order identifier in recipient-facing materials such as the packing slip. | |
| DisplayableOrderComment | String | False |
A text block submitted when creating a fulfillment order. Displays in recipient-facing materials such as the packing slip. | |
| DisplayableOrderDate | Datetime | False |
A date and time submitted when creating a fulfillment order. Displays as the order date in recipient-facing materials such as the packing slip. | |
| FeatureConstraints | String | False |
A list of features and their fulfillment policies to apply to the order. | |
| FulfillmentAction | String | False |
Specifies whether the fulfillment order should ship now or have an order hold put on it. | |
| FulfillmentOrderStatus | String | False |
The current status of the fulfillment order. | |
| FulfillmentPolicy | String | False |
The FulfillmentPolicy value specified when creating a fulfillment order. | |
| ReceivedDate | Datetime | False |
The date and time that the fulfillment order was received by an Amazon fulfillment center. | |
| ShippingSpeedCategory | String | False |
The shipping method used for the fulfillment order. | |
| StatusUpdatedDate | Datetime | False |
The date and time that the status of the fulfillment order last changed, in ISO 8601 date time format. | |
| AddressLine1 | String | False |
The first line of the address. | |
| AddressLine2 | String | False |
Additional address information. | |
| AddressLine3 | String | False |
Additional address information. | |
| City | String | False |
The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan. | |
| CountryCode | String | False |
The two digit country code. In ISO 3166-1 alpha-2 format. | |
| DistrictOrCounty | String | False |
The district or county where the person, business, or institution is located. | |
| AddressName | String | False |
The name of the person, business or institution at the address. | |
| PostalCode | String | False |
The postal code of the address. | |
| StateOrRegion | String | False |
The state or region where the person, business or institution is located. | |
| Phone | String | False |
The phone number of the person, business, or institution located at the address. | |
| ReturnAuthorizations | String | False |
A JSON object of return authorization information. | |
| ReturnItems | String | False |
A JSON object of items that Amazon accepted for return. Returns empty if no items were accepted for return. | |
| FulfillmentShipments | String | False |
A JSON object of fulfillment shipment information. | |
| FulfillmentOrderItems | String | False |
A JSON object of fulfillment order item information. | |
| MarketplaceId | String | False |
The marketplace identifier. | |
| QueryStartDate | String | False |
A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order. | |
| PaymentInformation | String | False |
A JSON object of various payment attributes related to this fulfillment order. Required for India but is optional for all other marketplaces. |
Returns information about subscriptions of the specified notification type.
| Name | Type | ReadOnly | References | Description |
| SubscriptionId [KEY] | String | False |
The subscription identifier generated when the subscription is created. | |
| NotificationType [KEY] | String | False |
The type of notification. 使用できる値は次のとおりです。ACCOUNT_STATUS_CHANGED, ANY_OFFER_CHANGED, B2B_ANY_OFFER_CHANGED, BRANDED_ITEM_CONTENT_CHANGE, FBA_INVENTORY_AVAILABILITY_CHANGES, FBA_OUTBOUND_SHIPMENT_STATUS, FEE_PROMOTION, FEED_PROCESSING_FINISHED, FULFILLMENT_ORDER_STATUS, ITEM_PRODUCT_TYPE_CHANGE, LISTINGS_ITEM_STATUS_CHANGE, LISTINGS_ITEM_ISSUES_CHANGE, ORDER_STATUS_CHANGE, PRICING_HEALTH, PRODUCT_TYPE_DEFINITIONS_CHANGE, REPORT_PROCESSING_FINISHED | |
| PayloadVersion | String | False |
The version of the payload object to be used in the notification. | |
| DestinationId | String | False |
The identifier for the destination where notifications will be delivered. | |
| MarketplaceIds | String | False |
A list of marketplace identifiers to subscribe to (e.g. ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. | |
| AggregationTimePeriod | String | False |
The supported time period to use to perform marketplace-ASIN level aggregation. 使用できる値は次のとおりです。FiveMinutes, TenMinutes | |
| EventFilterType | String | False |
An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| CatalogItems | The Catalog Items table helps you retrieve item details for items in the catalog. |
| CatalogItemsClassifications | The Catalog Items Classifications table helps you retrieve classification details for items in the catalog. |
| CompetitivePricing | Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. |
| Feeds | The GetFeedSubmissionList operation returns a list of feed submissions. |
| FeesEstimate | Returns the estimated fees for the listed products. |
| InboundDeliveryChallanDocument | Provide delivery challan document for PCP transportation in India marketplace. |
| InboundOperationStatus | Gets the status of the processing of an asynchronous API call. |
| InboundPackingGroupBoxes | Retrieves a page of boxes from a given packing group. |
| InboundPackingGroupItems | Retrieves a page of items in a given packing group. |
| InboundPlanBoxes | Provides a paginated list of box packages in an inbound plan. |
| InboundPlanItems | Provides a paginated list of item packages in an inbound plan. |
| InboundPlanPallets | Provides a paginated list of pallet packages in an inbound plan. |
| InboundShipmentBoxes | Provides a paginated list of box packages in a shipment. |
| InboundShipmentItems | Returns a list of items in a specified inbound shipment. |
| InboundShipmentPallets | Provides a paginated list of pallet packages in a shipment. |
| InboundShipments | Returns a list of inbound shipments based on criteria that you specify. |
| InboundTransportationOptions | Retrieves all transportation options for a shipment. |
| InventorySupply | Returns information about the availability of inventory that a seller has in Amazon's fulfillment network and in current inbound shipments. You can check the current availability status for your Fulfillment by Amazon inventory as well as discover when availability status changes. |
| ItemOffers | Returns the lowest priced offers for a single item based on ASIN. |
| ListingOffers | Generated schema file. |
| ListingsItemsIssues | Returns details about a listings item issues for a selling partner. |
| ListingsItemsOffers | Returns details about a listings item offers for a selling partner. |
| ListingsItemsSummaries | Returns details about a listings item summaries for a selling partner. |
| OrderItems | Returns order items based on the Amazon Order Id that you specify. |
| OrderMetrics | Returns aggregated order metrics for a given interval, broken down by granularity, for a given buyer type. |
| Orders | Returns orders created or updated during a time frame that you specify. |
| OutboundFeatures | Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature. |
| OutboundFulfillmentOrderItems | Returns the fulfillment order items indicated by the specified order identifier. |
| OutboundFulfillmentsPreview | Returns a list of fulfillment order previews based on shipping criteria that you specify. |
| OutboundPackageTracking | Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. |
| OutboundReturnItems | An array of items that Amazon accepted for return. Returns empty if no items were accepted for return. |
| OutboundReturnReasons | Returns a list of return reason codes for a seller SKU in a given marketplace. |
| ProductPricing | Generated schema file. |
| ReportList | Returns report details for the reports that match the filters that you specify. |
| ReportTypes | Returns report details for the reports that match the filters that you specify. |
| ShippingDocuments | Returns the shipping documents associated with a package in a shipment. |
| ShippingRates | Returns the available shipping service offerings. |
| ShippingTracking | Returns tracking information for a purchased shipment. |
The Catalog Items table helps you retrieve item details for items in the catalog.
The following filters are required:
SELECT * FROM CatalogItems WHERE MarketplaceID = 'XXXXXXXXXXXXX' AND ISBN = 'XXXXXXXXXXXXX'
| Name | Type | References | Description |
| MarketplaceASIN [KEY] | String | The Marketplace ASIN. | |
| AdultProduct | Boolean | Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature. | |
| Autographed | Boolean | Identifies an Amazon catalog item is autographed by a player or celebrity. | |
| Brand | String | Name of the brand associated with an Amazon catalog item. | |
| BrowseClassificationClassificationId | String | Classification Id (browse node) associated with an Amazon catalog item. | |
| BrowseClassificationDisplayName | String | Classification Name (browse node) associated with an Amazon catalog item. | |
| Color | String | Name of the color associated with an Amazon catalog item. | |
| ContributorsRole | String | Role of an individual contributor in the creation of an item, such as author or actor. | |
| ContributorsName | String | Name of the contributor. | |
| ItemClassification | String | Classification type associated with the Amazon catalog item. | |
| ItemName | String | Name, or title, associated with an Amazon catalog item. | |
| Manufacturer | String | Name of the manufacturer associated with an Amazon catalog item. | |
| Memorabilia | Boolean | Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment. | |
| ModelNumber | String | Model number associated with an Amazon catalog item. | |
| PackageQuantity | Integer | Quantity of an Amazon catalog item in one package. | |
| PartNumber | String | Part number associated with an Amazon catalog item. | |
| ReleaseDate | String | First date on which an Amazon catalog item is shippable to customers. | |
| Size | String | Name of the size associated with an Amazon catalog item. | |
| Style | String | Name of the style associated with an Amazon catalog item. | |
| TradeInEligible | Boolean | Identifies an Amazon catalog item is eligible for trade-in. | |
| WebsiteDisplayGroup | String | Identifier of the website display group associated with an Amazon catalog item. | |
| WebsiteDisplayGroupName | String | Display name of the website display group associated with an Amazon catalog item. | |
| Attributes | String | A JSON object containing structured item attribute data keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions available in the Selling Partner API for Product Type Definitions. | |
| Classifications | String | A JSON array of classifications (browse nodes) associated with the item in the Amazon catalog by Amazon marketplace. | |
| Dimensions | String | A JSON object of the dimensions for an item in the Amazon catalog. | |
| Identifiers | String | A JSON object of the identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers. | |
| Images | String | A JSON object of the images for an item in the Amazon catalog. | |
| ProductTypes | String | A JSON object of the product types associated with the Amazon catalog item. | |
| Relationships | String | A JSON object of the relationship details of an Amazon catalog item (for example, variations). | |
| SalesRankings | String | A JSON object of the sales ranks of an Amazon catalog item. | |
| VendorDetails | String | A JSON object of the vendor details associated with an Amazon catalog item. Vendor details are available to vendors only. | |
| ASIN | String | Amazon Standard Identification Number that identifies a product. | |
| EAN | String | A European Article Number that uniquely identifies the catalog item, manufacturer, and its attributes. | |
| GTIN | String | A Global Trade Item Number that uniquely identifies a product. | |
| ISBN | String | The unique commercial book identifier used to identify books internationally. | |
| JAN | String | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | |
| MINSAN | String | A Minsan Code that uniquely identifies an item. | |
| SellerSKU | String | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId | |
| UPC | String | A 12-digit bar code used for retail packaging. | |
| IncludedData | String | A comma-delimited list of item details to request. If none are specified, will default to returning summaries data. Values: attributes, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails. | |
| Locale | String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | |
| SellerId | String | A selling partner identifier, such as a seller account or vendor code. Note: Required when setting identifier SellerSKU. | |
| PageSize | String | Number of results to be returned per page. | |
| Query | String | Keyword(s) to use to search for items in the catalog. | |
| BrandNames | String | A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers. | |
| ClassificationIds | String | A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers. | |
| KeywordsLocale | String | The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers. | |
| MarketplaceId | String | Specifies the marketplace for which items are returned. |
The Catalog Items Classifications table helps you retrieve classification details for items in the catalog.
| Name | Type | References | Description |
| ClassificationId [KEY] | String | Identifier of the classification (browse node identifier). | |
| MarketplaceASIN [KEY] | String | Amazon Standard Identification Number that identifies a product. | |
| DisplayName | String | Display name for the classification (browse node). | |
| ParentClassificationId | String | Parent classification (browse node) ID of the current classification. | |
| MarketplaceId | String | Specifies the marketplace for which items are returned. | |
| ShowParentClassifications | Boolean | Specifies whether to list all browse nodes for the item(s) or just the top-level browse node. By default, only the top-level browse nodes are listed. | |
| EAN | String | A European Article Number that uniquely identifies the catalog item, manufacturer, and its attributes. | |
| GTIN | String | A Global Trade Item Number that uniquely identifies a product. | |
| ISBN | String | The unique commercial book identifier used to identify books internationally. | |
| JAN | String | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | |
| MINSAN | String | A Minsan Code that uniquely identifies an item. | |
| SellerSKU | String | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId | |
| UPC | String | A 12-digit bar code used for retail packaging. | |
| Locale | String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | |
| SellerId | String | A selling partner identifier, such as a seller account or vendor code. Note: Required when setting identifier SellerSKU. | |
| Query | String | Keyword(s) to use to search for items in the catalog. | |
| BrandNames | String | A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers. | |
| ItemClassifications | String | A comma-separated list of classification IDs for filtering keyword searches. The results may vary, as the classification could refer to either the item's classification or its parent classification. Note: Cannot be used with identifiers. | |
| KeywordsLocale | String | The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers. |
Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.
| Name | Type | References | Description |
| ASIN [KEY] | String | The value of Amazon Standard Identification Number for the product. | |
| SellerSKU | String | Stock Keeping Unit that identifies a product in the Amazon catalog. | |
| MarketplaceId | String | A marketplace identifier. Specifies the marketplace for which prices are returned. | |
| CompetitivePriceId | String | The competitive price Id of the product. | |
| LandedPriceAmount | Decimal | The landed price amount of the price. | |
| LandedPriceCurrencyCode | String | The landed price currency code of the price. | |
| ListingPriceAmount | Decimal | The listing price amount of the price. | |
| ListingPriceCurrencyCode | String | The listing price currency code of the price. | |
| PointsNumber | Integer | The points number of the price. | |
| PointsMonetaryValueAmount | Decimal | The points monetary value amount of the price. | |
| PointsMonetaryValueCurrencyCode | String | The points monetary value currency code of the price. | |
| ShippingAmount | Decimal | The shipping amount of the buyying price. | |
| ShippingCurrencyCode | String | The shipping currency code of the buyying price. | |
| TradeInValueAmount | Decimal | The trade-in value amount of the buyying price. | |
| TradeInValueCurrencyCode | String | The trade-in value currency code of the buyying price. | |
| BelongsToRequester | Boolean | The boolean value if the product belongs to the requester. | |
| Condition | String | The condition of the product. | |
| Status | String | The status of the product. | |
| SalesRankings | String | A JSON aggregate containing the list of sales rank information for the item, by category. | |
| ItemType | String | Required. Indicates whether ASIN values or seller SKU values are used to identify items.
使用できる値は次のとおりです。Asin, Sku | |
| CustomerType | String | Indicates whether to request pricing information from the point of view of consumer or business buyers. Default is Consumer.
使用できる値は次のとおりです。Consumer, Business |
The GetFeedSubmissionList operation returns a list of feed submissions.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
Note: 'FeedType' attribute is required to query the view. You can view available values for 'FeedType' here.
Following are example queries that are processed server side:
SELECT * FROM Feeds WHERE FeedId = '50950018754'
SELECT * FROM Feeds WHERE FeedType = 'POST_PRODUCT_PRICING_DATA'
SELECT * FROM Feeds WHERE FeedType IN ( 'POST_PRODUCT_PRICING_DATA', 'POST_INVENTORY_AVAILABILITY_DATA' )
SELECT * FROM Feeds WHERE FeedType = 'POST_PRODUCT_PRICING_DATA' AND MarketplaceIds = 'A1VC38T7YXB528'
SELECT * FROM Feeds WHERE FeedType = 'POST_PRODUCT_PRICING_DATA' AND ProcessingStatus = 'DONE'
SELECT * FROM Feeds WHERE FeedType = 'POST_PRODUCT_PRICING_DATA' AND CreatedTime > '2021-06-20' AND CreatedTime < '2021-08-01 12:00:00'
Note: When filtering with CreatedTime, values older than 90 days will not be accepted.
| Name | Type | References | Description |
| FeedId [KEY] | String | The Id of the Feed. This identifier is unique only in combination with a seller ID. | |
| FeedType | String | The Type of the feed. FeedType is not required when UseSandbox=True. | |
| MarketplaceIds | String | A list of marketplace identifiers for the report. | |
| CreatedTime | Datetime | The date and time when the feed was created. While filtering, CreatedTime value is only accepted till 90 days old. | |
| ProcessingStatus | String | The processing status of the report. | |
| ProcessingStartTime | Datetime | The Date when the feed processing started. | |
| ProcessingEndTime | Datetime | The Date when the feed processing completed. | |
| ResultFeedDocumentId | String | The identifier for the feed document. This identifier is unique only in combination with a seller ID. |
Returns the estimated fees for the listed products.
| Name | Type | References | Description |
| IdValue [KEY] | String | Required. The item identifier. | |
| SellerID | String | The seller identifier. | |
| TimeOfFeesEstimation | Datetime | The time at which the fees were estimated. | |
| TotalFeesEstimateAmount | Decimal | Total estimated fees for a given item, price and fulfillment channel. | |
| TotalFeesEstimateCurrencyCode | String | The currency code for the total estimated fees. | |
| FeeType | String | The type of fee charged to a seller. | |
| FeeAmount | Decimal | The amount charged for a given fee. | |
| FeeAmountCurrencyCode | String | The currency code for the charged amount. | |
| FeePromotionAmount | Decimal | The promotion amount for a given fee. | |
| FeePromotionCurrencyCode | String | The currency code for the promotion amount. | |
| TaxAmount | Decimal | The tax amount for a given fee. | |
| TaxCurrencyCode | String | The currency code for the tax amount . | |
| FinalFeeAmount | Decimal | The final fee amount for a given fee. | |
| FinalFeeCurrencyCode | String | The currency code for the final fee amount. | |
| MarketplaceId | String | Required. The marketplace identifier. | |
| IdType | String | Required. The item type.
使用できる値は次のとおりです。ASIN, SellerSku | |
| Identifier | String | Required. The unique identifier provided by the caller to track this request. | |
| IsAmazonFulfilled | Boolean | When true, the offer is fulfilled by Amazon. | |
| ListingPriceAmount | Decimal | Required. The price of the item. | |
| ListingPriceCurrencyCode | String | Required. The currency code for the price of the item. | |
| ShippingAmount | Decimal | Required. The shipping cost. | |
| ShippingCurrencyCode | String | Required. The currency code for the shipping cost. | |
| PointsNumber | Decimal | Required. The number of Amazon Points offered with the purchase of an item. | |
| PointsAmount | Decimal | Required. The monetary value for points. | |
| PointsCurrencyCode | String | Required. The currency code for points. |
Provide delivery challan document for PCP transportation in India marketplace.
| Name | Type | References | Description |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| ShipmentId [KEY] | String | Identifier of a shipment. A shipment contains the boxes and units being inbounded. | |
| Uri | String | Uniform resource identifier to identify where the document is located. | |
| Expiration | Datetime | The timestamp of expiration of the URI. This is in ISO 8601 datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| DownloadType | String | The type of download. Can be `URL`. |
Gets the status of the processing of an asynchronous API call.
| Name | Type | References | Description |
| OperationId [KEY] | String | The operation ID returned by the asynchronous API call. | |
| OperationProblem | String | A problem with additional properties persisted to an operation. | |
| Operation | String | The name of the operation in the asynchronous API call. | |
| OperationStatus | String | The status of an operation. |
Retrieves a page of boxes from a given packing group.
| Name | Type | References | Description |
| PackageId [KEY] | String | Primary key to uniquely identify a Package (Box or Pallet). | |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| ContentInformationSource | String | Indication of how box content is meant to be provided. | |
| Item | String | Information associated with a single SKU in the seller's catalog. | |
| BoxId | String | The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. | |
| CountryCode | String | ISO 3166 standard alpha-2 country code. | |
| State | String | State. | |
| WarehouseId | String | An identifier for a warehouse, such as a FC, IXD, upstream storage. | |
| Value | Decimal | Value of a weight. | |
| UnitOfWeight | String | Unit of the weight being measured. | |
| TemplateName | String | Template name of the box. | |
| Width | Decimal | The width of a package. | |
| Height | Decimal | The height of a package. | |
| UnitOfMeasurement | String | Unit of linear measure. | |
| Length | Decimal | The length of a package. | |
| Quantity | Int | The number of containers where all other properties like weight or dimensions are identical. | |
| PackingGroupId [KEY] | String | Identifier of a packing group. |
Retrieves a page of items in a given packing group.
| Name | Type | References | Description |
| PackingGroupId [KEY] | String | Identifier of a packing group. | |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| Msku | String | The merchant defined SKU ID. | |
| ManufacturingLotCode | String | The manufacturing lot code. | |
| Fnsku | String | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. | |
| Expiration | String | The expiration date of the MSKU in ISO 8601 format. The same MSKU with different expiration dates cannot go into the same box. | |
| Code | String | ISO 4217 standard of a currency code. | |
| Amount | Decimal | Decimal value of the currency. | |
| Quantity | Int | The number of the specified MSKU. | |
| PrepOwner | String | In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`. | |
| PrepType | String | Type of preparation that should be done. Can be: `ITEM_LABELING`, `ITEM_BUBBLEWRAP`, `ITEM_POLYBAGGING`, `ITEM_TAPING`, `ITEM_BLACK_SHRINKWRAP`, `ITEM_HANG_GARMENT`, `ITEM_BOXING`, `ITEM_SETCREAT`, `ITEM_RMOVHANG`, `ITEM_SUFFOSTK`, `ITEM_CAP_SEALING`, `ITEM_DEBUNDLE`, `ITEM_SETSTK`, `ITEM_SIOC`, `ITEM_NO_PREP`, `ADULT`, `BABY`, `TEXTILE`, `HANGER`, `FRAGILE`, `LIQUID`, `SHARP`, `SMALL`, `PERFORATED`, `GRANULAR`, `SET`, `FC_PROVIDED`, `UNKNOWN`, `NONE`. | |
| LabelOwner | String | Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. | |
| Asin | String | The Amazon Standard Identification Number (ASIN) of the item. |
Provides a paginated list of box packages in an inbound plan.
| Name | Type | References | Description |
| BoxId [KEY] | String | The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. | |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| LabelOwner | String | Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. | |
| Msku | String | The merchant defined SKU ID. | |
| UnitOfMeasurement | String | Unit of linear measure. | |
| PackageId | String | Primary key to uniquely identify a Package (Box or Pallet). | |
| ContentInformationSource | String | Indication of how box content is meant to be provided. | |
| Value | Decimal | Value of a weight. | |
| Fnsku | String | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. | |
| Height | Decimal | The height of a package. | |
| PrepInstruction | String | Information pertaining to the preparation of inbound goods. | |
| CountryCode | String | ISO 3166 standard alpha-2 country code. | |
| State | String | State. | |
| Width | Decimal | The width of a package. | |
| WarehouseId | String | An identifier for a warehouse, such as a FC, IXD, upstream storage. | |
| UnitOfWeight | String | Unit of the weight being measured. | |
| TemplateName | String | Template name of the box. | |
| Expiration | String | The expiration date of the MSKU in ISO 8601 format. The same MSKU with different expiration dates cannot go into the same box. | |
| Length | Decimal | The length of a package. | |
| ManufacturingLotCode | String | The manufacturing lot code. | |
| Quantity | Int | The number of containers where all other properties like weight or dimensions are identical. | |
| Asin | String | The Amazon Standard Identification Number (ASIN) of the item. |
Provides a paginated list of item packages in an inbound plan.
| Name | Type | References | Description |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| Msku | String | The merchant defined SKU ID. | |
| ManufacturingLotCode | String | The manufacturing lot code. | |
| Fnsku | String | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. | |
| Expiration | String | The expiration date of the MSKU in ISO 8601 format. The same MSKU with different expiration dates cannot go into the same box. | |
| Quantity | Int | The number of the specified MSKU. | |
| LabelOwner | String | Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. | |
| Asin | String | The Amazon Standard Identification Number (ASIN) of the item. | |
| PrepInstructions | String | Decimal value of the currency. |
Provides a paginated list of pallet packages in an inbound plan.
| Name | Type | References | Description |
| PackageId [KEY] | String | Primary key to uniquely identify a Package (Box or Pallet). | |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| Quantity | Int | The number of containers where all other properties like weight or dimensions are identical. | |
| UnitOfMeasurement | String | Unit of linear measure. | |
| Length | Decimal | The length of a package. | |
| Width | Decimal | The width of a package. | |
| Height | Decimal | The height of a package. | |
| Value | Decimal | Value of a weight. | |
| UnitOfWeight | String | Unit of the weight being measured. | |
| Stackability | String | Indicates whether pallets will be stacked when carrier arrives for pick-up. |
Provides a paginated list of box packages in a shipment.
| Name | Type | References | Description |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| ShipmentId [KEY] | String | Identifier of a shipment. A shipment contains the boxes and units being inbounded. | |
| PackageId [KEY] | String | Primary key to uniquely identify a Package (Box or Pallet). | |
| LabelOwner | String | Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. | |
| Msku | String | The merchant defined SKU ID. | |
| UnitOfMeasurement | String | Unit of linear measure. | |
| ContentInformationSource | String | Indication of how box content is meant to be provided. | |
| Region | String | Representation of a location used within the inbounding experience. | |
| Value | Decimal | Value of a weight. | |
| Fnsku | String | A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center. | |
| Height | Decimal | The height of a package. | |
| Unit | String | Unit of the weight being measured. | |
| PrepInstruction | String | Information pertaining to the preparation of inbound goods. | |
| BoxId | String | The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box. | |
| CountryCode | String | ISO 3166 standard alpha-2 country code. | |
| State | String | State. | |
| Width | Decimal | The width of a package. | |
| WarehouseId | String | An identifier for a warehouse, such as a FC, IXD, upstream storage. | |
| TemplateName | String | Template name of the box. | |
| Expiration | String | The expiration date of the MSKU in ISO 8601 format. The same MSKU with different expiration dates cannot go into the same box. | |
| Length | Decimal | The length of a package. | |
| ManufacturingLotCode | String | The manufacturing lot code. | |
| Quantity | Int | The number of containers where all other properties like weight or dimensions are identical. | |
| Asin | String | The Amazon Standard Identification Number (ASIN) of the item. |
Returns a list of items in a specified inbound shipment.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM InboundShipmentItems WHERE MarketplaceId = 'ATVPDKIKX0DER'
SELECT * FROM InboundShipmentItems WHERE ShipmentId = 'FBA8J3K9LZPX'
SELECT * FROM InboundShipmentItems WHERE LastUpdatedDate > '2020-01-01'
| Name | Type | References | Description |
| ShipmentId [KEY] | String | The ID of the shipment. | |
| SellerSKU [KEY] | String | The Seller SKU of the item. | |
| QuantityShipped | Int | The item quantity that you are shipping. | |
| QuantityInCase | Int | The item quantity in each case, for case-packed items. | |
| QuantityReceived | Int | The item quantity that has been received at an Amazon fulfillment center. | |
| FulfillmentNetworkSKU | String | Amazon's fulfillment network SKU of the item. | |
| PrepDetailsList | String | A JSON aggregate of preparation instructions and who is responsible for that preparation. | |
| MarketplaceId | String | Marketplace identifier for the report. | |
| ReleaseDate | Date | The date that a pre-order item will be available for sale. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| LastUpdatedDate | Datetime | A date used for selecting inbound shipments that were last updated before/after a specified time. |
Provides a paginated list of pallet packages in a shipment.
| Name | Type | References | Description |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| ShipmentId [KEY] | String | Identifier of a shipment. A shipment contains the boxes and units being inbounded. | |
| PackageId [KEY] | String | Primary key to uniquely identify a Package (Box or Pallet). | |
| UnitOfMeasurement | String | Unit of linear measure. | |
| Length | Decimal | The length of a package. | |
| Quantity | Int | The number of containers where all other properties like weight or dimensions are identical. | |
| Height | Decimal | The height of a package. | |
| UnitOfWeight | String | Unit of the weight being measured. | |
| Stackability | String | Indicates whether pallets will be stacked when carrier arrives for pick-up. | |
| Width | Decimal | The width of a package. | |
| Value | Decimal | Value of a weight. |
Returns a list of inbound shipments based on criteria that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM InboundShipments WHERE ShipmentStatus = 'Working'
SELECT * FROM InboundShipments WHERE ShipmentStatus IN ('Working', 'SHIPPED', 'IN_TRANSIT')
SELECT * FROM InboundShipments WHERE ShipmentId = '503-9993250-1405404'
SELECT * FROM InboundShipments WHERE MarketplaceId = 'ATVPDKIKX0DER'
SELECT * FROM InboundShipments WHERE LastUpdatedDate >= '2016-12-12'
| Name | Type | References | Description |
| ShipmentId [KEY] | String | The ID of the shipment. | |
| ShipmentStatus | String | The status of your inbound shipment. | |
| ShipmentName | String | The unique name of the inbound shipment. | |
| ShipFromPostalCode | String | The PostalCode of the return address. | |
| ShipFromName | String | The Name of the return address. | |
| ShipFromCountryCode | String | The CountryCode of the return address. | |
| ShipFromDistrictOrCounty | String | The district or county of the return address. | |
| ShipFromStateOrProvinceCode | String | The State Or Province Code of the return address. | |
| ShipFromAddressLine1 | String | The street address information of the return address. | |
| ShipFromAddressLine2 | String | Additional street address information of the return address. | |
| ShipFromCity | String | The City of the return address. | |
| LabelPrepType | String | The type of label preparation. | |
| AreCasesRequired | Boolean | Boolean that indicates whether or not an inbound shipment contains case-packed boxes. | |
| DestinationFulfillmentCenterId | String | The Amazon fulfillment center identifier created by Amazon. | |
| ConfirmedNeedByDate | Date | Date that the shipment must arrive at an Amazon fulfillment center for pre-ordered items. | |
| MarketplaceId | String | Marketplace identifier for the report. | |
| BoxContentsSource | String | Where the seller provided box contents information for a shipment. | |
| EstimatedBoxContentsFeeTotalUnits | Int | The number of units to ship for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
| EstimatedBoxContentsFeePerUnitCurrencyCode | String | The currency code for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
| EstimatedBoxContentsFeePerUnitValue | Decimal | The manual processing fee per unit for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
| EstimatedBoxContentsTotalFeeCurrencyCode | String | The Total fee currency code for an estimate of the manual processing fee charged by Amazon for boxes without box content information. | |
| EstimatedBoxContentsTotalFeeValue | Decimal | The Total fee value for an estimate of the manual processing fee charged by Amazon for boxes without box content information. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| LastUpdatedDate | Datetime | A date used for selecting inbound shipments that were last updated before/after a specified time. | |
| InboundShipmentItemList | String | A list of inbound shipment item information. |
Retrieves all transportation options for a shipment.
| Name | Type | References | Description |
| InboundPlanId [KEY] | String | Identifier of an inbound plan. | |
| TransportationOptionId [KEY] | String | Identifier of a transportation option. A transportation option represent one option for how to send a shipment. | |
| ShipmentId [KEY] | String | Identifier of a shipment. A shipment contains the boxes and units being inbounded. | |
| VoidableUntil | Datetime | Voidable until timestamp. | |
| Amount | Decimal | Decimal value of the currency. | |
| Expiration | Datetime | The timestamp at which this transportation option quote becomes no longer valid. This is based in ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`. | |
| Code | String | ISO 4217 standard of a currency code. | |
| Name | String | The contact's name. | |
| EndTime | Datetime | The end timestamp of the appointment in UTC. | |
| ShippingMode | String | Mode of shipment transportation that this option will provide. Can be: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`. | |
| StartTime | Datetime | The start timestamp of the appointment in UTC. | |
| AlphaCode | String | The carrier code. For example, USPS or DHLEX. | |
| ShippingSolution | String | Shipping program for the option. Can be: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`. | |
| PlacementOptionId | String | The placement option to generate transportation options for. |
Returns information about the availability of inventory that a seller has in Amazon's fulfillment network and in current inbound shipments. You can check the current availability status for your Fulfillment by Amazon inventory as well as discover when availability status changes.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
Note: Attributes 'GranularityType' and 'GranularityId' are required to query the view. You must set GranularityId to the MarketplaceId from the API matching your region.
Following are example queries which are processed server side:
SELECT * FROM InventorySupply WHERE GranularityType = 'Marketplace' AND GranularityId = 'ATVPDKIKX0DER' AND SellerSKU = '123'
SELECT * FROM InventorySupply WHERE GranularityType = 'Marketplace' AND GranularityId = 'ATVPDKIKX0DER' AND StartDateTime > '2020-01-01'
| Name | Type | References | Description |
| UID [KEY] | String | Auto Generated Primary Key field. | |
| FNSKU | String | The Fulfillment Network SKU (FNSKU) of the item. The FNSKU is a unique identifier for each inventory item stored in an Amazon fulfillment center. | |
| SellerSKU | String | The Seller SKU of the item. Required if the QueryStartDateTime is not specified. | |
| ASIN | String | The Amazon Standard Identification Number (ASIN) of the item. | |
| Condition | String | The condition of the item. | |
| GranularityType | String | The granularity type for the inventory aggregation level. Acceptable value(s) are: 'Marketplace'. | |
| GranularityId | String | The granularity ID for the inventory aggregation level. | |
| TotalQuantity | Integer | The total number of units in an inbound shipment or in Amazon fulfillment centers. | |
| ProductName | String | The localized language product title of the item within the specific marketplace. | |
| LastUpdatedTime | String | The date and time that any quantity was last updated. | |
| FulfillableQuantity | Integer | The item quantity that can be picked, packed, and shipped. | |
| InboundWorkingQuantity | Integer | The item quantity that can be picked, packed, and shipped. | |
| InboundShippedQuantity | Integer | The item quantity that can be picked, packed, and shipped. | |
| InboundReceivingQuantity | Integer | The item quantity that can be picked, packed, and shipped. | |
| TotalReservedQuantity | Integer | The total number of units in Amazon's fulfillment network that are currently being picked, packed, and shipped. | |
| PendingCustomerOrderQuantity | Integer | The number of units reserved for customer orders. | |
| PendingTransshipmentQuantity | Integer | The number of units being transferred from one fulfillment center to another. | |
| FcProcessingQuantity | Integer | The number of units that have been sidelined at the fulfillment center for additional processing. | |
| TotalUnfulfillableQuantity | Integer | The total number of units in Amazon's fulfillment network in unsellable condition. | |
| CustomerDamagedQuantity | Integer | The number of units in customer damaged disposition. | |
| WarehouseDamagedQuantity | Integer | The number of units in warehouse damaged disposition. | |
| DistributorDamagedQuantity | Integer | The number of units in distributor damaged disposition. | |
| CarrierDamagedQuantity | Integer | The number of units in carrier damaged disposition. | |
| DefectiveQuantity | Integer | The number of units in defective disposition. | |
| ExpiredQuantity | Integer | The number of units in expired disposition. | |
| Stores | String | A list of seller-enrolled stores that apply to this seller SKU. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| StartDateTime | Datetime | A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the current date and time. | |
| MarketplaceId | String | The marketplace ID for the marketplace for which to return inventory summaries. |
Returns the lowest priced offers for a single item based on ASIN.
| Name | Type | References | Description |
| ASIN | String | Required. The Amazon Standard Identification Number (ASIN) of the item. | |
| MarketplaceId | String | A marketplace identifier. Specifies the marketplace for which prices are returned. | |
| ItemCondition | String | The condition of the lowest priced product listed.
使用できる値は次のとおりです。New, Used, Collectible, Refurbished, Club | |
| OffersListingPriceAmount | Decimal | The listing price amount of the offered price. | |
| OffersListingPriceCurrencyCode | String | The listing price currency code of the offered price. | |
| OffersShippingAmount | Decimal | The shipping amount of the offered price. | |
| OffersShippingCurrencyCode | String | The shipping currency code of the offered price. | |
| FeedbackCount | Integer | The feedback count. | |
| SellerPositiveFeedbackRating | Double | The positive feedback rating of the seller. | |
| SellerId [KEY] | String | The seller Id. | |
| ShippingTimeAvailabilityType | String | The shipping time availability type. | |
| ShippingTimeMaximumHours | Integer | The maximum hours of shipping time. | |
| ShippingTimeMinimumHours | Integer | The minimum hours of shipping time. | |
| ShippingTimeAvailableDate | String | The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. | |
| QuantityDiscountPrices | String | Contains pricing information that includes special pricing when buying in bulk. | |
| PointsNumber | Integer | The number of points. | |
| PointsMonetaryValueCurrencyCode | String | The currency code in ISO 4217 format. | |
| PointsMonetaryValueAmount | String | The monetary value. | |
| IsBuyBoxWinner | Boolean | When true, the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. | |
| IsPrime | Boolean | Indicates whether the offer is an Amazon Prime offer. | |
| IsNationalPrime | Boolean | Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. | |
| ShipsFromCountry | String | The country from where the product is shipped. | |
| ShipsFromState | String | The state from where the product is shipped. | |
| IsFeaturedMerchant | Boolean | The boolean value of the merchant being featured. | |
| IsFulfilledByAmazon | Boolean | The boolean value of the merchant being fulfilled by Amazon. | |
| CustomerType | String | Indicates whether to request pricing information from the point of view of consumer or business buyers. Default is Consumer.
使用できる値は次のとおりです。Consumer, Business | |
| MyOffer | Boolean | When true, this is the seller's offer. | |
| OfferType | String | Indicates the type of customer that the offer is valid for. | |
| SubCondition | String | The subcondition of the item. Subcondition values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. | |
| ConditionNotes | String | Information about the condition of the item. |
Generated schema file.
| Name | Type | References | Description |
| SellerSKU [KEY] | String | Identifies an item in the given marketplace. | |
| MarketplaceId | String | A marketplace identifier. Specifies the marketplace for which prices are returned. | |
| ItemCondition | String | The condition of the lowest priced product listed.
使用できる値は次のとおりです。New, Used, Collectible, Refurbished, Club | |
| OffersListingPriceAmount | Decimal | The listing price amount of the offered price. | |
| OffersListingPriceCurrencyCode | String | The listing price currency code of the offered price. | |
| OffersShippingAmount | Decimal | The shipping amount of the offered price. | |
| OffersShippingCurrencyCode | String | The shipping currency code of the offered price. | |
| FeedbackCount | Integer | The feedback count. | |
| SellerPositiveFeedbackRating | Double | The positive feedback rating of the seller. | |
| SellerId | String | The seller Id. | |
| ShippingTimeAvailabilityType | String | The shipping time availability type. | |
| ShippingTimeMaximumHours | Integer | The maximum hours of shipping time. | |
| ShippingTimeMinimumHours | Integer | The minimum hours of shipping time. | |
| ShippingTimeAvailableDate | String | The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. | |
| QuantityDiscountPrices | String | Contains pricing information that includes special pricing when buying in bulk. | |
| PointsNumber | Integer | The number of points. | |
| PointsMonetaryValueCurrencyCode | String | The currency code in ISO 4217 format. | |
| PointsMonetaryValueAmount | String | The monetary value. | |
| IsBuyBoxWinner | Boolean | When true, the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. | |
| IsPrime | Boolean | Indicates whether the offer is an Amazon Prime offer. | |
| IsNationalPrime | Boolean | Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. | |
| ShipsFromCountry | String | The country from where the product is shipped. | |
| ShipsFromState | String | The state from where the product is shipped. | |
| IsFeaturedMerchant | Boolean | The boolean value of the merchant being featured. | |
| IsFulfilledByAmazon | Boolean | The boolean value of the merchant being fulfilled by Amazon. | |
| CustomerType | String | Indicates whether to request pricing information from the point of view of consumer or business buyers. Default is Consumer.
使用できる値は次のとおりです。Consumer, Business | |
| MyOffer | Boolean | When true, this is the seller's offer. | |
| OfferType | String | Indicates the type of customer that the offer is valid for. | |
| SubCondition | String | The subcondition of the item. Subcondition values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. | |
| ConditionNotes | String | Information about the condition of the item. |
Returns details about a listings item issues for a selling partner.
The following filters are required:
SELECT * FROM ListingsItemsIssues WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
| Name | Type | References | Description |
| SKU | String | A selling partner provided identifier for an Amazon listing. | |
| Code | String | An issue code that identifies the type of issue. | |
| Message | String | A message that describes the issue. | |
| Severity | String | The severity of the issue.
使用できる値は次のとおりです。INFO, WARNING, ERROR |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
Returns details about a listings item offers for a selling partner.
The following filters are required:
SELECT * FROM ListingsItemsOffers WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
| Name | Type | References | Description |
| SKU | String | A selling partner provided identifier for an Amazon listing | |
| MarketplaceId | String | A marketplace identifier. Identifies the Amazon marketplace for the listings item. | |
| OfferType | String | Type of offer for the listings item.
使用できる値は次のとおりです。B2B, B2C | |
| PriceAmount | String | Purchase price amount of the listings item. | |
| PriceCurrency | String | Purchase price currency of the listings item. | |
| Points | String | The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the Points element is only returned in Japan (JP). |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
Returns details about a listings item summaries for a selling partner.
The following filters are required:
SELECT * FROM ListingsItemsSummaries WHERE SKU = '12345' AND SellerId = 'XXXXXXXXXXXXXX'
| Name | Type | References | Description |
| SKU | String | A selling partner provided identifier for an Amazon listing. | |
| Asin | String | Amazon Standard Identification Number (ASIN) of the listings item. | |
| ConditionType | String | Identifies the condition of the listings item.
使用できる値は次のとおりです。new_new, new_open_box, new_oem, refurbished_refurbished, used_like_new, used_very_good, used_good, used_acceptable, collectible_like_new, collectible_very_good, collectible_good, collectible_acceptable, club_club | |
| CreatedDate | Datetime | Date the listings item was created, in ISO 8601 format. | |
| ItemName | String | Name, or title, associated with an Amazon catalog item. | |
| LastUpdatedDate | Datetime | Date the listings item was last updated, in ISO 8601 format. | |
| MainImageLink | String | Link, or URL, for the main image. | |
| MainImageHeight | Integer | Height of the main image in pixels. | |
| MainImageWidth | Integer | Width of the main image in pixels. | |
| MarketplaceId | String | A marketplace identifier. Identifies the Amazon marketplace for the listings item. | |
| ProductType | String | The Amazon product type of the listings item. | |
| Status | String | Statuses that apply to the listings item. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
Returns order items based on the Amazon Order Id that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App. OrderItems table supports server side filtering with = and IN operators for AmazonOrderId field.
SELECT * FROM OrderItems WHERE AmazonOrderId = '503-9993250-1405404'
| Name | Type | References | Description |
| OrderItemId [KEY] | String | An Amazon-defined order item identifier. | |
| AmazonOrderId | String |
Orders.AmazonOrderId | The Amazon ID of the order. |
| ASIN | String | The Amazon Standard Identification Number (ASIN) of the item. | |
| SellerSKU | String | The seller stock keeping unit (SKU) of the item. | |
| BuyerCustomizedInfoCustomizedURL | String | The Buyer CustomizedURL. | |
| Title | String | The name of the item. | |
| QuantityOrdered | Integer | The quantity of items ordered. | |
| QuantityShipped | Integer | The quantity of items shipped. | |
| GrantedPointsNumber | Integer | The Granted Points Number. | |
| GrantedPointsMonetaryValueAmount | Decimal | The Granted Points Amount. | |
| GrantedPointsMonetaryValueCurrencyCode | String | The Granted Points CurrencyCode. | |
| NumberOfItems | Integer | The total number of items that are included in the ASIN. | |
| ItemPriceAmount | Decimal | The Item Price Amount. | |
| ItemPriceCurrencyCode | String | The Item Price Currency Code. | |
| ShippingPriceAmount | Decimal | The Shipping Price Amount. | |
| ShippingPriceCurrencyCode | String | The Shipping Price Currency Code. | |
| ItemTaxAmount | Decimal | The Item Tax Amount. | |
| ItemTaxCurrencyCode | String | The Item Tax Currency Code. | |
| ShippingTaxAmount | String | The Shipping Tax Amount. | |
| ShippingTaxCurrencyCode | String | The ShippingTax Currency Code. | |
| ShippingDiscountAmount | String | The Shipping Discount Amount. | |
| ShippingDiscountCurrencyCode | String | The Shipping Discount Currency Code. | |
| ShippingDiscountTaxAmount | String | The Shipping Discount Tax Amount. | |
| ShippingDiscountTaxCurrencyCode | String | The Shipping Discount Tax Currency Code. | |
| PromotionDiscountAmount | Decimal | The Promotion Discount Amount. | |
| PromotionDiscountCurrencyCode | String | The Promotion Discount Currency Code. | |
| PromotionDiscountTaxAmount | Decimal | The Promotion Discount Tax Amount. | |
| PromotionDiscountTaxCurrencyCode | String | The Promotion Discount Tax Currency Code. | |
| PromotionIds | String | The IDs of Promotions. | |
| CODFeeAmount | Decimal | The COD FeeAmount. | |
| CODFeeCurrencyCode | String | The COD FeeCurrency Code. | |
| CODFeeDiscountAmount | String | The COD FeeDiscount Amount. | |
| CODFeeDiscountCurrencyCode | String | The COD FeeDiscount Currency Code. | |
| IsGift | Boolean | Boolean specifying if the item is gift. | |
| ConditionNote | String | The Condition Note. | |
| ConditionId | String | The Condition Id. | |
| ConditionSubtypeId | String | The Condition Subtype Id. | |
| ScheduledDeliveryStartDate | Datetime | The Scheduled Delivery StartDate. | |
| ScheduledDeliveryEndDate | Datetime | The Scheduled Delivery EndDate. | |
| PriceDesignation | String | The Price Designation. | |
| TaxCollectionModel | String | The tax collection model applied to the item. | |
| TaxCollectionResponsibleParty | String | The party responsible for withholding the taxes and remitting them to the taxing authority. | |
| SerialNumberRequired | Boolean | When true, the product type for this item has a serial number. Returned only for Amazon Easy Ship orders. | |
| IsTransparency | Boolean | When true, transparency codes are required. | |
| IossNumber | String | The IOSS number for the marketplace. | |
| StoreChainStoreId | String | The store chain store identifier. Linked to a specific store in a store chain. | |
| DeemedResellerCategory | String | Applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK. | |
| IsBuyerRequestedCancel | Boolean | When true, the buyer has requested cancellation. | |
| BuyerCancelReason | String | The reason that the buyer requested cancellation. | |
| BuyerCustomizedInfoURL | String | The location of a zip file containing Amazon Custom data. | |
| GiftWrapPriceAmount | String | The Gift Wrap Price Amount. | |
| GiftWrapPriceCurrencyCode | String | The Gift Wrap Price Currency Code. | |
| GiftWrapTaxAmount | String | The Gift Wrap Tax Amount. | |
| GiftWrapTaxCurrencyCode | String | The Gift Wrap Tax Currency Code. | |
| GiftMessageText | String | A gift message provided by the buyer. | |
| GiftWrapLevel | String | The gift wrap level specified by the buyer. | |
| AssociatedItems | String | A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| LastUpdateDate | Datetime | The last time the order is updated. |
Returns aggregated order metrics for a given interval, broken down by granularity, for a given buyer type.
| Name | Type | References | Description |
| IntervalTime | String | A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone. | |
| BreakdownStartTime | Datetime | The starting date-time of the interval used for selecting order metrics. Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). | |
| BreakdownEndTime | Datetime | The ending date-time of the interval used for selecting order metrics. Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). | |
| UnitCount | Integer | The number of units in orders based on the specified filters. | |
| OrderItemCount | Integer | The number of order items based on the specified filters. | |
| OrderCount | Integer | The number of orders based on the specified filters. | |
| AverageUnitPriceCurrencyCode | String | Three-digit currency code. In ISO 4217 format. | |
| AverageUnitPriceAmount | Double | The currency amount. | |
| TotalSalesCurrencyCode | String | Three-digit currency code. In ISO 4217 format. | |
| TotalSalesAmount | Double | The currency amount. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| GranularityTimeZone | String | An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the offset of the specified interval value. | |
| Granularity | String | The granularity of the grouping of order metrics, based on a unit of time. Specifying granularity=Hour results in a successful request only if the interval specified is less than or equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 years from now. | |
| MarketplaceId | String | A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. | |
| BuyerType | String | Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B buyers. | |
| FulfillmentNetwork | String | Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. | |
| FirstDayOfWeek | String | Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. | |
| Asin | String | Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. | |
| Sku | String | Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. |
Returns orders created or updated during a time frame that you specify.
Note: If you're retrieving personally identifiable information (PII), you must set IncludeRestrictedData to true. When retreiving PII, the OAuth application that you use to authenticate must be granted the Direct-to-consumer-shipping role to query this view. If you authenticated with the embedded OAuth application, you will need to create your own OAuth application with the Direct-to-consumer-shipping role enabled. See カスタムOAuth アプリの作成 for more information about creating an OAuth application.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Orders WHERE AmazonOrderId = '249-7638334-8161403'
SELECT * FROM Orders WHERE SellerOrderId = '249-7638334' AND purchasedate > '2010-01-01'
SELECT * FROM Orders WHERE LastUpdateDate >= '2016-12-12'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12'
SELECT * FROM Orders WHERE MarketplaceId = 'ATVPDKIKX0DER'
SELECT * FROM Orders WHERE BuyerEmail = '[email protected]'
SELECT * FROM Orders WHERE IsISPU = false
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND OrderStatus = 'Canceled'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND FulfillmentChannel = 'MFN'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND BuyerEmail = '[email protected]'
SELECT * FROM Orders WHERE PurchaseDate >= '2016-12-12' AND PaymentMethod = 'Other'
| Name | Type | References | Description |
| AmazonOrderId [KEY] | String | The Amazon ID of the order. | |
| SellerOrderId | String | The Seller ID of the order. | |
| PurchaseDate | Datetime | The date of the purchase. | |
| LastUpdateDate | Datetime | The last update date. | |
| OrderStatus | String | Status of the order. | |
| FulfillmentChannel | String | The Fulfillment Channel. | |
| SalesChannel | String | The Sales Channel. | |
| OrderChannel | String | The Order Channel. | |
| ShipServiceLevel | String | The level of the Ship Service. | |
| ShippingAddressName | String | The Shipping Address Name. | |
| ShippingAddressAddressLine1 | String | The Shipping Address AddressLine. | |
| ShippingAddressAddressLine2 | String | The Shipping Address AddressLine. | |
| ShippingAddressAddressLine3 | String | The Shipping Address AddressLine. | |
| ShippingAddressCity | String | The Shipping Address City. | |
| ShippingAddressCounty | String | The Shipping Address County. | |
| ShippingAddressDistrict | String | The Shipping Address District. | |
| ShippingAddressStateOrRegion | String | The Shipping Address State Or Region. | |
| ShippingAddressPostalCode | String | The Shipping Address Postal Code. | |
| ShippingAddressCountryCode | String | The Shipping Address Country Code. | |
| ShippingAddressPhone | String | The Shipping Address Phone. | |
| ShippingAddressMunicipality | String | The Shipping Municipality. | |
| ShippingAddress_AddressType | String | The Shipping Address Type. | |
| DefaultShipAddressName | String | The Shipping Address Name. | |
| DefaultShipAddressLine1 | String | Default Ship From Location Address AddressLine. | |
| DefaultShipAddressLine2 | String | Default Ship From Location Address AddressLine. | |
| DefaultShipAddressLine3 | String | Default Ship From Location Address AddressLine. | |
| DefaultShipCity | String | Default Ship From Location Address City. | |
| DefaultShipCounty | String | Default Ship From Location Address County. | |
| DefaultShipDistrict | String | Default Ship From Location Address District. | |
| DefaultShipStateOrRegion | String | Default Ship From Location Address State Or Region. | |
| DefaultShipPostalCode | String | Default Ship From Location Address Postal Code. | |
| DefaultShipCountryCode | String | Default Ship From Location Address Country Code. | |
| DefaultShipPhone | String | Default Ship From Location Address Phone. | |
| DefaultShipMunicipality | String | The Default Ship Municipality. | |
| DefaultShip_AddressType | String | Default Ship From Location Address Type. | |
| OrderTotalCurrencyCode | String | The Order Currency Code. | |
| OrderTotalAmount | Decimal | The Order Amount. | |
| NumberOfItemsShipped | Integer | The Number Of Items Shipped. | |
| NumberOfItemsUnshipped | Integer | The Number Of Items Unshipped. | |
| PaymentExecutionDetail | String | The Payment Execution Detail. | |
| PaymentMethod | String | The Payment Method. | |
| PaymentMethodDetails | String | The Details of payment method. | |
| IsReplacementOrder | Boolean | Boolean specifying if it is a replacement order. | |
| ReplacedOrderId | String | The Replaced OrderId. | |
| MarketplaceId | String | The MarketplaceId. | |
| BuyerEmail | String | The Buyer Email. | |
| BuyerName | String | The Buyer Name. | |
| BuyerCounty | String | The Buyer Country. | |
| BuyerTaxInfo | String | The Buyer Tax Info. | |
| BuyerInvoicePreference | String | Can be individual or business. | |
| ShipmentServiceLevelCategory | String | The Shipment Service Level Category. | |
| ShippedByAmazonTFM | Boolean | The Shipped By Amazon TFM. | |
| TFMShipmentStatus | String | The TFM Shipment Status. | |
| CbaDisplayableShippingLabel | String | The Cba Displayable Shipping Label. | |
| OrderType | String | The Type of Order. | |
| HasAutomatedShippingSettings | Boolean | If true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order. | |
| AutomatedCarrier | String | Auto-generated carrier for SSA orders | |
| AutomatedShipMethod | String | Auto-generated ship method for SSA orders. | |
| EarliestShipDate | Datetime | The Earliest Ship Date. | |
| EasyShipShipmentStatus | String | The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders. | |
| HasRegulatedItems | Boolean | Whether the order contains regulated items which may require additional approval steps before being fulfilled. | |
| PromiseResponseDueDate | Datetime | Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders. | |
| LatestShipDate | Datetime | The Latest Ship Date. | |
| EarliestDeliveryDate | Datetime | The Earliest Delivery Date . | |
| LatestDeliveryDate | Datetime | The Latest Delivery Date. | |
| IsBusinessOrder | Boolean | Boolean specifying if it is a Business Order. | |
| IsEstimatedShipDateSet | Boolean | When true, the estimated ship date is set for the order. Returned only for Sourcing on Demand orders. | |
| IsSoldByAB | Boolean | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). | |
| IsIBA | Boolean | When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). | |
| IsISPU | Boolean | When true, this order is marked to be picked up from a store rather than delivered. | |
| IsGlobalExpressEnabled | Boolean | When true, the order is a GlobalExpress order. | |
| PurchaseOrderNumber | String | The Purchase Order Number. | |
| IsPrime | Boolean | Boolean specifying if it is a Prime Order. | |
| IsPremiumOrder | Boolean | Boolean specifying if it is a Premium Order. | |
| CompanyName | String | The company name of the recipient. | |
| ExtendedFields | String | The container for address extended fields. For example, street name or street number. Only available for Brazil shipping addresses. | |
| AmazonPrograms | String | A list of the programs that are associated with the specified order item. |
Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.
| Name | Type | References | Description |
| MarketplaceId [KEY] | String | Required. The marketplace identifier. | |
| FeatureName | String | The feature name. | |
| FeatureDescription | String | The feature description. | |
| SellerEligible | Boolean | Indicates whether the seller is eligible to use the feature. | |
| SellerSku | String | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | |
| FnSku | String | The unique SKU used by Amazon's fulfillment network. | |
| Asin | String | The Amazon Standard Identification Number (ASIN) of the item. | |
| SkuCount | String | The number of SKUs available for this service. | |
| OverlappingSkus | String | Other seller SKUs that are shared across the same inventory. | |
| IneligibleReasons | String | A list of one or more reasons that the seller SKU is ineligible for the feature. | |
| QueryStartDate | Datetime | A date that you can use to select inventory that has been updated since a specified date. |
Returns the fulfillment order items indicated by the specified order identifier.
| Name | Type | References | Description |
| SellerFulfillmentOrderId [KEY] | String | The fulfillment order identifier | |
| SellerFulfillmentOrderItemId [KEY] | String | A fulfillment order item identifier submitted with a call to the createFulfillmentOrder operation. | |
| SellerSku | String | The seller SKU of the item. | |
| CancelledQuantity | Integer | The item quantity that was cancelled by the seller. | |
| EstimatedArrivalDate | Datetime | The estimated arrival date and time of the item quantity. Note that this value can change over time. If the shipment that contains the item quantity has been cancelled, estimatedArrivalDate is not returned. | |
| EstimatedShipDate | Datetime | The estimated date and time that the item quantity is scheduled to ship from the fulfillment center. Note that this value can change over time. If the shipment that contains the item quantity has been cancelled, estimatedShipDate is not returned. | |
| FulfillmentNetworkSku | String | Amazon's fulfillment network SKU of the item. | |
| OrderItemDisposition | String | Indicates whether the item is sellable or unsellable. | |
| Quantity | Integer | The item quantity. | |
| UnfulfillableQuantity | Integer | The item quantity that is unfulfillable. | |
| GiftMessage | String | A message to the gift recipient, if applicable. | |
| DisplayableComment | String | Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip. | |
| PerUnitDeclaredValue | Decimal | The monetary value assigned by the seller to this item. | |
| PerUnitDeclaredCurrencyCode | String | The currency code of the monetary value assigned by the seller to this item. | |
| PerUnitTaxValue | Decimal | The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. | |
| PerUnitTaxCurrencyCode | String | The currency code of the tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. | |
| PerUnitPriceValue | Decimal | The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. | |
| PerUnitPriceCurrencyCode | String | The currency code of the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order. |
Returns a list of fulfillment order previews based on shipping criteria that you specify.
| Name | Type | References | Description |
| SellerFulfillmentOrderItemId [KEY] | String | A fulfillment order item identifier that the seller created with a call to the createFulfillmentOrder operation. | |
| EarliestArrivalDate | Datetime | The earliest date that the shipment is expected to arrive at its destination. | |
| EarliestShipDate | Datetime | The earliest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format. | |
| EstimatedShippingWeightUnit | String | The estimated shipping unit weight of the item quantity for a single item, as identified by sellerSku, in a shipment. | |
| EstimatedShippingWeightValue | String | The estimated shipping weight value of the item quantity for a single item, as identified by sellerSku, in a shipment. | |
| IsCodCapable | Boolean | Indicates whether this fulfillment order preview is for COD (Cash On Delivery). | |
| IsFulfillable | Boolean | Indicates whether this fulfillment order preview is fulfillable. | |
| LatestArrivalDate | Datetime | The latest date that the shipment is expected to arrive at its destination, in ISO 8601 date time format. | |
| LatestShipDate | Datetime | The latest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format. | |
| MarketplaceId | String | The marketplace the fulfillment order is placed against. | |
| Quantity | Integer | The item quantity. | |
| SellerSku | String | The seller SKU of the item. | |
| ShippingSpeedCategory | String | The shipping method used for the fulfillment order. When this value is ScheduledDelivery, choose Ship for the fulfillmentAction. Hold is not a valid fulfillmentAction value when the shippingSpeedCategory value is ScheduledDelivery. | |
| ScheduledDeliveryInfo | String | Provides additional insight into the shipment timeline when exact delivery dates are not able to be precomputed. | |
| ShippingWeightCalculationMethod | String | The method used to calculate the estimated shipping weight. | |
| UnfulfilledItemSellerSku | String | The seller SKU of the unfulfillable item. | |
| UnfulfilledItemQuantity | Integer | The item quantity of the unfulfillable item. | |
| UnfulfilledItemSellerFulfillmentOrderItemId | String | The fulfillment order item identifier of the unfulfillable item. | |
| UnfulfilledItemUnfulfillableReasons | String | Error codes associated with the fulfillment order preview that indicate why the item is unfulfillable. | |
| AddressLine1 | String | The first line of the address. | |
| AddressLine2 | String | Additional address information. | |
| AddressLine3 | String | Additional address information. | |
| City | String | The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan. | |
| CountryCode | String | The two digit country code. In ISO 3166-1 alpha-2 format. | |
| DistrictOrCounty | String | The district or county where the person, business, or institution is located. | |
| AddressName | String | The name of the person, business or institution at the address. | |
| PostalCode | String | The postal code of the address. | |
| StateOrRegion | String | The state or region where the person, business or institution is located. | |
| Phone | String | The phone number of the person, business, or institution located at the address. | |
| IncludeCODFulfillmentPreview | Boolean | When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD. | |
| IncludeDeliveryWindows | Boolean | When true, returns the ScheduledDeliveryInfo response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery. |
Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.
| Name | Type | References | Description |
| PackageNumber [KEY] | Integer | Required.The package identifier. | |
| AdditionalLocationInfo | String | Additional location information. | |
| CarrierCode | String | The name of the carrier. | |
| CarrierPhoneNumber | String | The phone number of the carrier. | |
| CarrierURL | String | The URL of the carrier's website. | |
| CustomerTrackingLink | String | Link on swiship.com that allows customers to track the package. | |
| CurrentStatus | String | The current delivery status of the package. | |
| CurrentStatusDescription | String | Description corresponding to the CurrentStatus value. | |
| EstimatedArrivalDate | Datetime | The estimated arrival date. | |
| ShipDate | Datetime | The shipping date for the package. | |
| ShipToAddressCity | String | The destination city address information for tracking the package. | |
| ShipToAddressCountry | String | The destination state address information for tracking the package. | |
| ShipToAddressState | String | The destination country address information for tracking the package. | |
| SignedForBy | String | The name of the person who signed for the package. | |
| EventAddressCity | String | The city address information where the delivery event took place. | |
| EventAddressCountry | String | The country address information where the delivery event took place. | |
| EventAddressState | String | The state address information where the delivery event took place. | |
| EventCode [KEY] | String | The event code where the delivery event took place. | |
| EventDate | Datetime | The date and time that the delivery event took place, in ISO 8601 date time format. | |
| EventDescription | String | A description for the corresponding event code. | |
| TrackingNumber | String | The tracking number for the package. |
An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.
| Name | Type | References | Description |
| SellerFulfillmentOrderId [KEY] | String | The fulfillment order identifier. | |
| SellerReturnItemId | String | An identifier assigned by the seller to the return item. | |
| RmaPageURL | String | A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping. | |
| ReturnAuthorizationId | String | An identifier for the return authorization. This identifier associates return items with the return authorization used to return them. | |
| SellerFulfillmentOrderItemId | String | The identifier assigned to the item by the seller when the fulfillment order was created. | |
| AmazonReturnReasonCode | String | The return reason code that the Amazon fulfillment center assigned to the return item. | |
| AmazonShipmentId | String | The identifier for the shipment that is associated with the return item. | |
| ReturnComment | String | An optional comment about the return item. | |
| Status | String | Indicates if the return item has been processed by an Amazon fulfillment center. | |
| StatusChangedDate | Datetime | Indicates when the status last changed. | |
| SellerReturnReasonCode | String | The return reason code assigned to the return item by the seller. | |
| ReturnReceivedCondition | String | The condition of the return item when received by an Amazon fulfillment center. | |
| AmazonRmaId | String | The return merchandise authorization (RMA) that Amazon needs to process the return. | |
| FulfillmentCenterId | String | An identifier for the Amazon fulfillment center that the return items should be sent to. | |
| ReturnToAddressAddressLine1 | String | The first line of the address. | |
| ReturnToAddressAddressLine2 | String | Additional address information. | |
| ReturnToAddressAddressLine3 | String | Additional address information. | |
| ReturnToAddressCity | String | The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan. | |
| ReturnToAddressCountryCode | String | The two digit country code. In ISO 3166-1 alpha-2 format. | |
| ReturnToAddressDistrictOrCounty | String | The district or county where the person, business, or institution is located. | |
| ReturnToAddressName | String | The name of the person, business or institution at the address. | |
| ReturnToAddressPostalCode | String | The postal code of the address. | |
| ReturnToAddressStateOrRegion | String | The state or region where the person, business or institution is located. |
Returns a list of return reason codes for a seller SKU in a given marketplace.
| Name | Type | References | Description |
| ReturnReasonCode [KEY] | String | A code that indicates a valid return reason. | |
| Description | String | A human readable description of the return reason code. | |
| TranslatedDescription | String | A translation of the description. The translation is in the language specified in the Language request parameter. | |
| SellerSku | String | Required. The seller SKU for which return reason codes are required. | |
| MarketplaceId | String | The marketplace for which the seller wants return reason codes. | |
| Language | String | The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into. | |
| SellerFulfillmentOrderId | String | Required. The fulfillment order identifier. |
Generated schema file.
| Name | Type | References | Description |
| ASIN [KEY] | String | The value of Amazon Standard Identification Number for the product. | |
| SellerSKU | String | Stock Keeping Unit that identifies a product in the Amazon catalog. | |
| MarketplaceId | String | A marketplace identifier. Specifies the marketplace for which prices are returned. | |
| LandedPriceAmount | Decimal | The landed price amount of the buying price. | |
| LandedPriceCurrencyCode | String | The landed price currency code of the buying price. | |
| ListingPriceAmount | Decimal | The listing price amount of the buying price. | |
| ListingPriceCurrencyCode | String | The listing price currency code of the buying price. | |
| ShippingAmount | Decimal | The shipping amount of the buying price. | |
| ShippingCurrencyCode | String | The shipping currency code of the buying price. | |
| FulfillmentChannel | String | The fulfillment channel for the product listed. | |
| ItemCondition | String | The condition of the product listed. | |
| ItemSubCondition | String | The sub-condition of the product listed. | |
| RegularPriceAmount | Decimal | The regular price amount of the product. | |
| RegularPriceCurrencyCode | String | The regular price currecny code for the product. | |
| Status | String | The status of the product. | |
| ItemType | String | Required. Indicates whether ASIN values or seller SKU values are used to identify items.
使用できる値は次のとおりです。Asin, Sku | |
| CustomerType | String | Indicates whether to request pricing information from the point of view of consumer or business buyers. Default is Consumer.
使用できる値は次のとおりです。Consumer, Business | |
| OfferType | String | Indicates whether to request pricing information for the seller's B2C (business-to-consumer) or B2B (business-to-business) offers. Default is B2C.
使用できる値は次のとおりです。B2C, B2B |
Returns report details for the reports that match the filters that you specify.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
Note: 'ReportType' attribute is required to query the view. You can view available values for 'ReportType' in Amazon Selling-Partner API Documentation, or you can query the 'ReportTypes' view.
Following are example queries that are processed server side:
SELECT * FROM ReportList WHERE ReportId = '51013018828'
SELECT * FROM ReportList WHERE ReportType = 'GET_FLAT_FILE_OPEN_LISTINGS_DATA'
SELECT * FROM ReportList WHERE ReportType = 'GET_FLAT_FILE_OPEN_LISTINGS_DATA' AND CreatedTime > '2021-06-12' AND CreatedTime < '2021-08-01 12:00:00'
SELECT * FROM ReportList WHERE ReportType = 'GET_FLAT_FILE_OPEN_LISTINGS_DATA' AND MarketplaceIds = 'A1VC38T7YXB528'
SELECT * FROM ReportList WHERE ReportType = 'GET_FLAT_FILE_OPEN_LISTINGS_DATA' AND ProcessingStatus = 'DONE'
Note: When filtering with CreatedTime, values older than 90 days will not be accepted.
| Name | Type | References | Description |
| ReportId [KEY] | String | Report Id. | |
| ReportType | String | The type of the Report. ReportType is not required when UseSandbox=True. | |
| ReportDocumentId | String | The identifier for the report document. | |
| CreatedTime | Datetime | The date and time when the report was created. While filtering, CreatedTime value is only accepted till 90 days old. | |
| DataStartTime | Datetime | The start of a date and time range used for selecting the data to report. | |
| DataEndTime | Datetime | The end of a date and time range used for selecting the data to report. | |
| MarketplaceIds | String | A list of marketplace identifiers for the report. | |
| ProcessingStartTime | Datetime | The date and time when the report processing started. | |
| ProcessingEndTime | Datetime | The date and time when the report processing completed. | |
| ProcessingStatus | String | The processing status of the report. |
Returns report details for the reports that match the filters that you specify.
This view lists all the available Report Types of Seller Central API and their respective format (JSON, XML, CSV, TSV, PDF, XLSX).
SELECT * FROM ReportTypes
| Name | Type | References | Description |
| ReportTypeId [KEY] | String | Sequential id of the report type. | |
| ReportTypeValue | String | Enumeration value of the report type. | |
| ReportFormat | String | The download format of the report type
使用できる値は次のとおりです。JSON, XML, CSV, TSV, PDF, XLSX | |
| Category | String | Report format category. | |
| Description | String | Report format description. | |
| URL | String | Amazon Selling-Partner API Documentation link of the report type. |
Returns the shipping documents associated with a package in a shipment.
| Name | Type | References | Description |
| ShipmentId [KEY] | String | Required. The unique shipment identifier provided by a shipping service. | |
| PackageClientReferenceId | String | Required. A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation. | |
| PackageDocumentType | String | The type of shipping document. | |
| PackageDocumentFormat | String | The file format of the document. | |
| PackageDocumentContents | String | A Base64 encoded string of the file contents. | |
| PackageDocumentDPI | Long | The resolution of the document (for example, 300 means 300 dots per inch). | |
| TrackingId | String | The carrier generated identifier for a package in a purchased shipment. | |
| ShippingBusinessId | String | Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces. |
Returns the available shipping service offerings.
| Name | Type | References | Description |
| ServiceId [KEY] | String | An identifier for the shipping service. | |
| IsEligible | Boolean | A boolean value that indicates whether the shipping service offering is eligible. | |
| RequestToken | String | A unique token generated to identify a getRates operation. | |
| AvailableValueAddedServiceGroups | String | A JSON format of value-added services available for a shipping service offering. | |
| BilledWeightUnit | String | The weight unit. | |
| BilledWeightValue | Decimal | The weight value. | |
| CarrierId | String | The carrier identifier for the offering, provided by the carrier. | |
| CarrierName | String | The carrier name for the offering. | |
| DeliveryWindowStartTime | Datetime | The promised start time of delivery. | |
| DeliveryWindowEndTime | Datetime | The promised end time of delivery. | |
| PickupWindowStartTime | Datetime | The promised start time of pickup. | |
| PickupWindowEndTime | Datetime | The promised end time of pickup. | |
| RequiresAdditionalInputs | Boolean | When true, indicates that additional inputs are required to purchase this shipment service. | |
| RateId | String | An identifier for the rate (shipment offering) provided by a shipping service provider. | |
| ServiceName | String | The name of the shipping service. | |
| SupportedDocumentSpecifications | String | A JSON format of the document specifications supported for a shipment service offering. | |
| TotalChargeUnit | String | The currency code of the total charge. | |
| TotalChargeValue | Decimal | The monetary value of the total charge. | |
| IneligibilityReasons | String | A JSON aggregate of reasons why a shipping service offering is ineligible. | |
| ShipTo | String | Required. The ship to address. | |
| ShipFrom | String | The ship from address. | |
| ReturnTo | String | The return to address. | |
| ShipDate | Datetime | The ship date and time (the requested pickup). This defaults to the current date and time. | |
| Packages | String | A list of packages to be shipped through a shipping service offering. | |
| ValueAddedServicesValue | Decimal | A collection's monetary value of supported value-added services. | |
| ValueAddedServicesUnit | String | A collection's currency code of supported value-added services. | |
| TaxDetailsType | String | Indicates the type of tax. | |
| TaxDetailsRegistrationNumber | String | The shipper's tax registration number associated with the shipment for customs compliance purposes in certain regions. | |
| ChannelType | String | The shipment source channel type.
使用できる値は次のとおりです。AMAZON, EXTERNAL デフォルト値はAMAZONです。 | |
| AmazonOrderDetails | String | The Amazon order ID associated with the Amazon order fulfilled by this shipment.. This is required if the shipment source channel is Amazon. | |
| AmazonShipmentDetails | String | The encrypted shipment ID. This attribute is required only for a Direct Fulfillment shipment. | |
| ShippingBusinessId | String | Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces. |
Returns tracking information for a purchased shipment.
| Name | Type | References | Description |
| TrackingId [KEY] | String | A carrier-generated tracking identifier originally returned by the purchaseShipment operation. | |
| CarrierId | String | A carrier identifier originally returned by the getRates operation for the selected rate. | |
| AlternateLegTrackingId | String | The carrier generated reverse identifier for a returned package in a purchased shipment. | |
| PromisedDeliveryDate | Datetime | The date and time by which the shipment is promised to be delivered. | |
| SummaryStatus | String | A package status summary. | |
| EventCode | String | The tracking event type. | |
| EventTime | Datetime | The ISO 8601 formatted timestamp of the event. | |
| City | String | The city or town where the event is located. | |
| CountryCode | String | The two digit country code. Follows ISO 3166-1 alpha-2 format. | |
| PostalCode | String | The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. | |
| StateOrRegion | String | The state, county or region where the event is located. | |
| ShippingBusinessId | String | Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces. |
CData Sync App は、Vendor Central API をリレーショナルビューおよびストアドプロシージャとしてモデル化します。
Amazon Vendor Central データモデルを使用するには、Schema をVendorCentral に設定します。
ビュー は、VendorOrders、CatalogItems などの変更できないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
レポートタイプごとに、ビューが公開されています。たとえば、レポートタイプFEE_DISCOUNTS_REPORT はREPORT_FEE_DISCOUNTS_REPORT という名前のビューとして公開されます。 これらのビューは、'DataStartTime' と'DataEndTime' のオプション datetime パラメータを使用してクエリできます。両方のdatetime パラメータが指定されると、ドライバーは指定された間隔に一致する既存のレポートを自動的に検索し、見つからない場合は新しいレポートが作成されます。レポートは、RequestReport ストアドプロシージャを使用して手動で作成できます。 また、ReportOptions JSON-aggregate 擬似カラムを使用して、レポートタイプに応じて必要となる追加フィールドを指定することもできます。レポートオプションの詳細については、Amazon Selling-Partner API Documentation を参照してください。
レポートが作成され結果セットにプッシュされた後、次にこのレポートタイプに'DataStartTime' と'DataEndTime' の同じフィルタを使用してクエリを実行すると、新しいレポートが作成される代わりに、以前に作成されたレポートがダウンロードされます。
Sync App はAmazon Marketplace のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Destinations | Returns information about all destinations. |
| ListingsItems | Returns details about a listings item for a selling partner. |
| ListingsItemsAttributes | Returns details about a listings item attributes for a selling partner. |
| Subscriptions | Returns information about subscriptions of the specified notification type. |
| VendorCustomerInvoices | This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of customer invoices created during a time frame that you specify. The date range to search must be no more than 7 days. |
| VendorPackingSlips | This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. |
| VendorShippingLabels | This table is part of Vendor Direct Fulfillment Shipping API. Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. The date range to search must not be more than 7 days. |
Returns information about all destinations.
| Name | Type | ReadOnly | References | Description |
| DestinationId [KEY] | String | False |
The destination identifier generated when you created the destination. | |
| Name | String | False |
The developer-defined name for this destination. | |
| ResourceSqsArn | String | False |
The Amazon Resource Name (ARN) associated with the SQS queue (Amazon Simple Queue Service queue destination). | |
| ResourceEventBridgeName | String | False |
The name of the partner event source associated with the destination (Amazon EventBridge destination). | |
| ResourceEventBridgeRegion | String | False |
The AWS region in which you will be receiving the notifications (Amazon EventBridge destination). | |
| ResourceEventBridgeAccountId | String | False |
The identifier for the AWS account that is responsible for charges related to receiving notifications (Amazon EventBridge destination). |
Returns details about a listings item for a selling partner.
| Name | Type | ReadOnly | References | Description |
| SKU [KEY] | String | False |
A selling partner provided identifier for an Amazon listing. | |
| FulfillmentAvailability | String | False |
Fulfillment availability for the listings item. | |
| Procurements | String | False |
The vendor procurement information for the listings item. | |
| ProcurementCostCurrency | String | False |
The price (ISO4217 currency code) that you want Amazon to pay you for this product. | |
| ProcurementCostAmount | String | False |
The price (numeric value) that you want Amazon to pay you for this product. | |
| Attributes | String | False |
This field is required for INSERT statements. Aggregate field containing structured 'AttributeName' and 'AttributeValue' fields. | |
| SellerId [KEY] | String | False |
A selling partner identifier, such as a merchant account or vendor code. | |
| Requirements | String | False |
This field can be specified for INSERT statements. 使用できる値は次のとおりです。LISTING, LISTING_PRODUCT_ONLY, LISTING_OFFER_ONLY | |
| ProductType | String | False |
This field is required for INSERT statements. |
Returns details about a listings item attributes for a selling partner.
| Name | Type | ReadOnly | References | Description |
| SKU [KEY] | String | True |
A selling partner provided identifier for an Amazon listing. | |
| AttributeName [KEY] | String | False |
The attribute name for the listings item. | |
| AttributeValue | String | False |
The attribute value for the listings item. | |
| ProductType | String | False |
The Amazon product type of the listings item. Required for Updating an attribute. | |
| SellerId [KEY] | String | True |
A selling partner identifier, such as a merchant account or vendor code. | |
| AttributePath | String | True |
The attribute path for the listings item. | |
| AttributeGroup | String | True |
The attribute group for the listings item. |
Returns information about subscriptions of the specified notification type.
| Name | Type | ReadOnly | References | Description |
| SubscriptionId [KEY] | String | False |
The subscription identifier generated when the subscription is created. | |
| NotificationType [KEY] | String | False |
The type of notification. 使用できる値は次のとおりです。ACCOUNT_STATUS_CHANGED, ANY_OFFER_CHANGED, B2B_ANY_OFFER_CHANGED, BRANDED_ITEM_CONTENT_CHANGE, FBA_INVENTORY_AVAILABILITY_CHANGES, FBA_OUTBOUND_SHIPMENT_STATUS, FEE_PROMOTION, FEED_PROCESSING_FINISHED, FULFILLMENT_ORDER_STATUS, ITEM_PRODUCT_TYPE_CHANGE, LISTINGS_ITEM_STATUS_CHANGE, LISTINGS_ITEM_ISSUES_CHANGE, ORDER_STATUS_CHANGE, PRICING_HEALTH, PRODUCT_TYPE_DEFINITIONS_CHANGE, REPORT_PROCESSING_FINISHED | |
| PayloadVersion | String | False |
The version of the payload object to be used in the notification. | |
| DestinationId | String | False |
The identifier for the destination where notifications will be delivered. | |
| MarketplaceIds | String | False |
A list of marketplace identifiers to subscribe to (e.g. ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. | |
| AggregationTimePeriod | String | False |
The supported time period to use to perform marketplace-ASIN level aggregation. 使用できる値は次のとおりです。FiveMinutes, TenMinutes | |
| EventFilterType | String | False |
An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter. |
This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of customer invoices created during a time frame that you specify. The date range to search must be no more than 7 days.
Some example queries:
SELECT * FROM VendorCustomerInvoices WHERE PurchaseOrderNumber = '12345'
SELECT * FROM VendorCustomerInvoices WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'
| Name | Type | ReadOnly | References | Description |
| PurchaseOrderNumber [KEY] | String | False |
This field will contain the Purchase Order Number for this order. | |
| Content | String | False |
The Base64encoded customer invoice. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CreatedDate | String |
Filters for created date. If left empty the default specified range is from 6 days earlier to today. |
This view is part of Vendor Direct Fulfillment Shipping API. Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.
Some example queries:
SELECT * FROM VendorPackingSlips WHERE PurchaseOrderNumber = '12345'
SELECT * FROM VendorPackingSlips WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'
| Name | Type | ReadOnly | References | Description |
| PurchaseOrderNumber [KEY] | String | False |
This field will contain the Purchase Order Number for this order. | |
| Content | String | False |
A Base64encoded string of the packing slip PDF. | |
| ContentType | String | False |
The format of the file such as PDF, JPEG etc |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CreatedDate | String |
Filters for created date. If left empty the default specified range is from 6 days earlier to today |
This table is part of Vendor Direct Fulfillment Shipping API. Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. The date range to search must not be more than 7 days.
Some example queries:
SELECT * FROM VendorShippingLabels WHERE PurchaseOrderNumber = '12345'
SELECT * FROM VendorShippingLabels WHERE CreatedDate > '2022-09-10T12:00:00' AND CreatedDate < '2022-09-15T12:00:00'
INSERT INTO Items#TEMP (ItemSequenceNumber, BuyerProductIdentifier, VendorProductIdentifier, Amount, UnitOfMeasure)
VALUES ( 1, 'item_id', 'prod_id', 10, 'unit');
INSERT INTO Container#TEMP (ContainerType, ContainerIdentifier, TrackingNumber, PackedItems)
VALUES ( 'carton', 'container_id', 'string', 'Items#TEMP');
INSERT INTO Address1#TEMP ( Name, AddressLine1, City, County, CountryCode)
VALUES ('Name', 'Fayettville NC', 'Fayettville', 'North Carolina', 'NC');
INSERT INTO TaxTest#TEMP (RegistrationType, RegistrationNumber, RegistrationMessages, RegistrationAddress)
VALUES ( 'VAT', 'string', 'string', 'Address1#TEMP');
INSERT INTO VendorShippingLabels (PurchaseOrderNumber, SellingPartyPartyId, SellingPartyTaxRegistrationDetails, ShipFromPartyPartyId, Containers)
VALUES ('1234567890', '11111', 'TaxTest#TEMP', '22222', 'Container#TEMP');
In order to get the Transaction ID returned from the API for the INSERT statement, you can issue a select statement from the LastResultInfo temp table, as shown below:
SELECT * FROM LastResultInfo#TEMP
*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.
| Column Name | Type | Required | Description |
| ContainerType | String | True | The type of container. |
| ContainerIdentifier | String | True | The container identifier. |
| TrackingNumber | String | False | The tracking number. |
| ContainerSequenceNumber | Integer | False | An integer that must be submitted for multi-box shipments only, where one item may come in separate packages. |
| ManifestId | String | False | The manifest identifier. |
| ManifestDate | String | False | The date of the manifest. |
| ShipMethod | String | False | The shipment method. |
| ScacCode | String | False | SCAC code required for NA VOC vendors only. |
| Carrier | String | False | Carrier required for EU VOC vendors only. |
| Length | String | False | Physical dimensional measurements of a container. |
| Width | String | False | Physical dimensional measurements of a container. |
| Height | String | False | Physical dimensional measurements of a container. |
| DimensionUnit | String | False | Physical dimensional measurements of a container. |
| Value | String | False | The weight. |
| WeightUnit | String | False | The weight. |
| PackedItems | Aggregate | True | A list of packed items. See: PackedItems table schema. |
| Column Name | Type | Required | Description |
| ItemSequenceNumber | Integer | True | Item Sequence Number for the item. This must be the same value as sent in the order for a given item. |
| BuyerProductIdentifier | String | False | Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required. |
| VendorProductIdentifier | String | False | The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number. |
| Amount | Decimal | True | Quantity of units shipped for a specific item at a shipment level. If the item is present only in certain packages or pallets within the shipment, please provide this at the appropriate package or pallet level. |
| UnitOfMeasure | String | True | Unit of measure for the shipped quantity. |
| Column Name | Type | Required | Description |
| RegistrationType | String | True | Tax registration type for the entity. Allowed Values: VAT, GST. |
| RegistrationNumber | String | True | Tax registration number for the party. For example, VAT ID. |
| RegistrationMessages | String | False | Tax registration message that can be used for additional tax related details |
| RegistrationAddress | Aggregate | False | Address of the party. See: AddressDetails table schema. |
| Column Name | Type | Required | Description |
| Name | String | True | The name of the person, business or institution at that address. |
| AddressLine1 | String | True | First line of street address. |
| AddressLine2 | String | False | Additional address information, if required. |
| AddressLine3 | String | False | Additional address information, if required. |
| City | String | False | The city where the person, business or institution is located. |
| County | String | False | The county where person, business or institution is located. |
| District | String | False | The district where person, business or institution is located. |
| StateOrRegion | String | False | The state or region where person, business or institution is located. |
| PostalOrZipCode | String | False | The postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. |
| CountryCode | String | True | The two digit country code. In ISO 3166-1 alpha-2 format. |
| Phone | String | False | The phone number of the person, business or institution located at that address. |
| Name | Type | ReadOnly | References | Description |
| PurchaseOrderNumber [KEY] | String | False | ||
| LabelFormat | String | True |
使用できる値は次のとおりです。PNG, ZPL | |
| LabelData | String | True | ||
| SellingPartyPartyId | String | False | ||
| SellingPartyAddressLine1 | String | False | ||
| SellingPartyAddressLine2 | String | False | ||
| SellingPartyAddressLine3 | String | False | ||
| SellingPartyAddressCity | String | False | ||
| SellingPartyAddressCountryCode | String | False | ||
| SellingPartyAddressCounty | String | False | ||
| SellingPartyAddressDistrict | String | False | ||
| SellingPartyAddressName | String | False | ||
| SellingPartyAddressPhone | String | False | ||
| SellingPartyAddressPostalCode | String | False | ||
| SellingPartyAddressStateOrRegion | String | False | ||
| SellingPartyTaxRegistrationDetails | String | False | ||
| ShipFromPartyPartyId | String | False | ||
| ShipFromPartyAddressLine1 | String | False | ||
| ShipFromPartyAddressLine2 | String | False | ||
| ShipFromPartyAddressLine3 | String | False | ||
| ShipFromPartyAddressCity | String | False | ||
| ShipFromPartyAddressCountryCode | String | False | ||
| ShipFromPartyAddressCounty | String | False | ||
| ShipFromPartyAddressDistrict | String | False | ||
| ShipFromPartyAddressName | String | False | ||
| ShipFromPartyAddressPhone | String | False | ||
| ShipFromPartyAddressPostalCode | String | False | ||
| ShipFromPartyAddressStateOrRegion | String | False | ||
| ShipFromPartyTaxRegistrationDetails | String | False |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CreatedDate | String | |
| Containers | String |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| CatalogItems | The Catalog Items table helps you retrieve item details for items in the catalog. |
| CatalogItemsClassifications | The Catalog Items Classifications table helps you retrieve classification details for items in the catalog. |
| ListingsItemsIssues | Returns details about a listings item issues for a selling partner. |
| ListingsItemsOffers | Returns details about a listings item offers for a selling partner. |
| ListingsItemsSummaries | Returns details about a listings item summaries for a selling partner. |
| ReportList | Returns report details for the reports that match the filters that you specify. |
| ReportTypes | Returns report details for the reports that match the filters that you specify. |
| VendorOrders | The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data. |
The Catalog Items table helps you retrieve item details for items in the catalog.
The following filters are required:
SELECT * FROM CatalogItems WHERE MarketplaceID = 'XXXXXXXXXXXXX' AND ISBN = 'XXXXXXXXXXXXX'
| Name | Type | References | Description |
| MarketplaceASIN [KEY] | String | The Marketplace ASIN. | |
| AdultProduct | Boolean | Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature. | |
| Autographed | Boolean | Identifies an Amazon catalog item is autographed by a player or celebrity. | |
| Brand | String | Name of the brand associated with an Amazon catalog item. | |
| BrowseClassificationClassificationId | String | Classification Id (browse node) associated with an Amazon catalog item. | |
| BrowseClassificationDisplayName | String | Classification Name (browse node) associated with an Amazon catalog item. | |
| Color | String | Name of the color associated with an Amazon catalog item. | |
| ContributorsRole | String | Role of an individual contributor in the creation of an item, such as author or actor. | |
| ContributorsName | String | Name of the contributor. | |
| ItemClassification | String | Classification type associated with the Amazon catalog item. | |
| ItemName | String | Name, or title, associated with an Amazon catalog item. | |
| Manufacturer | String | Name of the manufacturer associated with an Amazon catalog item. | |
| Memorabilia | Boolean | Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment. | |
| ModelNumber | String | Model number associated with an Amazon catalog item. | |
| PackageQuantity | Integer | Quantity of an Amazon catalog item in one package. | |
| PartNumber | String | Part number associated with an Amazon catalog item. | |
| ReleaseDate | String | First date on which an Amazon catalog item is shippable to customers. | |
| Size | String | Name of the size associated with an Amazon catalog item. | |
| Style | String | Name of the style associated with an Amazon catalog item. | |
| TradeInEligible | Boolean | Identifies an Amazon catalog item is eligible for trade-in. | |
| WebsiteDisplayGroup | String | Identifier of the website display group associated with an Amazon catalog item. | |
| WebsiteDisplayGroupName | String | Display name of the website display group associated with an Amazon catalog item. | |
| Attributes | String | A JSON object containing structured item attribute data keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions available in the Selling Partner API for Product Type Definitions. | |
| Classifications | String | A JSON array of classifications (browse nodes) associated with the item in the Amazon catalog by Amazon marketplace. | |
| Dimensions | String | A JSON object of the dimensions for an item in the Amazon catalog. | |
| Identifiers | String | A JSON object of the identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers. | |
| Images | String | A JSON object of the images for an item in the Amazon catalog. | |
| ProductTypes | String | A JSON object of the product types associated with the Amazon catalog item. | |
| Relationships | String | A JSON object of the relationship details of an Amazon catalog item (for example, variations). | |
| SalesRankings | String | A JSON object of the sales ranks of an Amazon catalog item. | |
| VendorDetails | String | A JSON object of the vendor details associated with an Amazon catalog item. Vendor details are available to vendors only. | |
| ASIN | String | Amazon Standard Identification Number that identifies a product. | |
| EAN | String | A European Article Number that uniquely identifies the catalog item, manufacturer, and its attributes. | |
| GTIN | String | A Global Trade Item Number that uniquely identifies a product. | |
| ISBN | String | The unique commercial book identifier used to identify books internationally. | |
| JAN | String | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | |
| MINSAN | String | A Minsan Code that uniquely identifies an item. | |
| SellerSKU | String | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId | |
| UPC | String | A 12-digit bar code used for retail packaging. | |
| IncludedData | String | A comma-delimited list of item details to request. If none are specified, will default to returning summaries data. Values: attributes, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails. | |
| Locale | String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | |
| SellerId | String | A selling partner identifier, such as a seller account or vendor code. Note: Required when setting identifier SellerSKU. | |
| PageSize | String | Number of results to be returned per page. | |
| Query | String | Keyword(s) to use to search for items in the catalog. | |
| BrandNames | String | A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers. | |
| ClassificationIds | String | A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers. | |
| KeywordsLocale | String | The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers. | |
| MarketplaceId | String | Specifies the marketplace for which items are returned. |
The Catalog Items Classifications table helps you retrieve classification details for items in the catalog.
| Name | Type | References | Description |
| ClassificationId [KEY] | String | Identifier of the classification (browse node identifier). | |
| MarketplaceASIN [KEY] | String | Amazon Standard Identification Number that identifies a product. | |
| DisplayName | String | Display name for the classification (browse node). | |
| ParentClassificationId | String | Parent classification (browse node) ID of the current classification. | |
| MarketplaceId | String | Specifies the marketplace for which items are returned. | |
| ShowParentClassifications | Boolean | Specifies whether to list all browse nodes for the item(s) or just the top-level browse node. By default, only the top-level browse nodes are listed. | |
| EAN | String | A European Article Number that uniquely identifies the catalog item, manufacturer, and its attributes. | |
| GTIN | String | A Global Trade Item Number that uniquely identifies a product. | |
| ISBN | String | The unique commercial book identifier used to identify books internationally. | |
| JAN | String | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | |
| MINSAN | String | A Minsan Code that uniquely identifies an item. | |
| SellerSKU | String | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId | |
| UPC | String | A 12-digit bar code used for retail packaging. | |
| Locale | String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | |
| SellerId | String | A selling partner identifier, such as a seller account or vendor code. Note: Required when setting identifier SellerSKU. | |
| Query | String | Keyword(s) to use to search for items in the catalog. | |
| BrandNames | String | A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers. | |
| ItemClassifications | String | A comma-separated list of classification IDs for filtering keyword searches. The results may vary, as the classification could refer to either the item's classification or its parent classification. Note: Cannot be used with identifiers. | |
| KeywordsLocale | String | The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers. |
Returns details about a listings item issues for a selling partner.
| Name | Type | References | Description |
| SKU | String | A selling partner provided identifier for an Amazon listing. | |
| Code | String | An issue code that identifies the type of issue. | |
| Message | String | A message that describes the issue. | |
| Severity | String | The severity of the issue.
使用できる値は次のとおりです。INFO, WARNING, ERROR |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
Returns details about a listings item offers for a selling partner.
| Name | Type | References | Description |
| SKU | String | A selling partner provided identifier for an Amazon listing | |
| MarketplaceId | String | A marketplace identifier. Identifies the Amazon marketplace for the listings item. | |
| OfferType | String | Type of offer for the listings item.
使用できる値は次のとおりです。B2B, B2C | |
| PriceAmount | String | Purchase price amount of the listings item. | |
| PriceCurrency | String | Purchase price currency of the listings item. | |
| Points | String | The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the Points element is only returned in Japan (JP). |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
Returns details about a listings item summaries for a selling partner.
| Name | Type | References | Description |
| SKU | String | A selling partner provided identifier for an Amazon listing. | |
| Asin | String | Amazon Standard Identification Number (ASIN) of the listings item. | |
| ConditionType | String | Identifies the condition of the listings item.
使用できる値は次のとおりです。new_new, new_open_box, new_oem, refurbished_refurbished, used_like_new, used_very_good, used_good, used_acceptable, collectible_like_new, collectible_very_good, collectible_good, collectible_acceptable, club_club | |
| CreatedDate | Datetime | Date the listings item was created, in ISO 8601 format. | |
| ItemName | String | Name, or title, associated with an Amazon catalog item. | |
| LastUpdatedDate | Datetime | Date the listings item was last updated, in ISO 8601 format. | |
| MainImageLink | String | Link, or URL, for the main image. | |
| MainImageHeight | Integer | Height of the main image in pixels. | |
| MainImageWidth | Integer | Width of the main image in pixels. | |
| MarketplaceId | String | A marketplace identifier. Identifies the Amazon marketplace for the listings item. | |
| ProductType | String | The Amazon product type of the listings item. | |
| Status | String | Statuses that apply to the listings item. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| SellerId | String | A selling partner identifier, such as a merchant account or vendor code. |
Returns report details for the reports that match the filters that you specify.
| Name | Type | References | Description |
| ReportId [KEY] | String | Report Id. | |
| ReportType | String | The type of the Report. ReportType is not required when UseSandbox=True. | |
| ReportDocumentId | String | The identifier for the report document. | |
| CreatedTime | Datetime | The date and time when the report was created. While filtering, CreatedTime value is only accepted till 90 days old. | |
| DataStartTime | Datetime | The start of a date and time range used for selecting the data to report. | |
| DataEndTime | Datetime | The end of a date and time range used for selecting the data to report. | |
| MarketplaceIds | String | A list of marketplace identifiers for the report. | |
| ProcessingStartTime | Datetime | The date and time when the report processing started. | |
| ProcessingEndTime | Datetime | The date and time when the report processing completed. | |
| ProcessingStatus | String | The processing status of the report. |
Returns report details for the reports that match the filters that you specify.
| Name | Type | References | Description |
| ReportTypeId [KEY] | String | Sequential id of the report type. | |
| ReportTypeValue | String | Enumeration value of the report type. | |
| ReportFormat | String | The download format of the report type
使用できる値は次のとおりです。JSON, XML, CSV, TSV, PDF, XLSX | |
| Category | String | Report format category. | |
| Description | String | Report format description. | |
| URL | String | Amazon Selling-Partner API Documentation link of the report type. |
The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
The Sync App will use the Amazon Marketplace API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
Following are example queries which are processed server side:
SELECT * FROM VendorOrders
SELECT * FROM VendorOrders WHERE PurchaseOrderNumber = '123456789'
SELECT * FROM VendorOrders WHERE PurchaseOrderState = 'New'
SELECT * FROM VendorOrders ORDER BY PurchaseOrderDate DESC
SELECT * FROM VendorOrders WHERE PurchaseOrderDate > '2022-06-01T12:00:00' AND PurchaseOrderDate < '2022-06-10T12:00:00'
SELECT * FROM VendorOrders WHERE PurchaseOrderChangedDate > '2022-06-01T12:00:00' AND PurchaseOrderChangedDate < '2022-06-10T12:00:00'
SELECT * FROM VendorOrders WHERE SellerPartyId = '123456789'
| Name | Type | References | Description |
| PurchaseOrderNumber | String | The purchase order number for this order. | |
| PurchaseOrderState | String | The current state of the purchase order.
使用できる値は次のとおりです。New, Acknowledged, Closed | |
| DealCode | String | If requested by the recipient, this field will contain a promotional/deal number. | |
| DeliveryWindow | String | This indicates the delivery window. Format is start and end date separated by double hyphen (--) | |
| ShipWindow | String | This indicates the ship window. Format is start and end date separated by double hyphen (--). | |
| Items | String | A list of items in this purchase order. | |
| PaymentMethod | String | Payment method used.
使用できる値は次のとおりです。Prepaid, CreditCard, Consignment, Invoice | |
| PurchaseOrderDate | Datetime | The date the purchase order was placed. | |
| PurchaseOrderChangedDate | Datetime | The date when purchase order was last changed by Amazon after the order was placed. | |
| PurchaseOrderStateChangedDate | Datetime | The date when current purchase order state was changed. | |
| PurchaseOrderType | String | Type of purchase order.
使用できる値は次のとおりです。RushOrder, NewProductIntroduction, ConsignedOrder, RegularOrder | |
| BillPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
| BillAddressAddressLine1 | String | First line of the address. | |
| BillAddressAddressLine2 | String | Additional address information, if required. | |
| BillAddressAddressLine3 | String | Additional address information, if required. | |
| BillAddressCity | String | The city where the person, business or institution is located. | |
| BillAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
| BillAddressCounty | String | The county where person, business or institution is located. | |
| BillAddressDistrict | String | The district where person, business or institution is located. | |
| BillAddressName | String | The name of the address of the person, business or institution. | |
| BillAddressPhone | String | The phone number of the person, business or institution located at that address. | |
| BillAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
| BillAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
| BillTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
| BillTaxRegistrationType | String | Tax registration type for the entity.
使用できる値は次のとおりです。VAT, GST | |
| ShipPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
| ShipAddressAddressLine1 | String | First line of the address. | |
| ShipAddressAddressLine2 | String | Additional address information, if required. | |
| ShipAddressAddressLine3 | String | Additional address information, if required. | |
| ShipAddressCity | String | The city where the person, business or institution is located. | |
| ShipAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
| ShipAddressCounty | String | The county where person, business or institution is located. | |
| ShipAddressDistrict | String | The district where person, business or institution is located. | |
| ShipAddressName | String | The name of the address of the person, business or institution. | |
| ShipAddressPhone | String | The phone number of the person, business or institution located at that address. | |
| ShipAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
| ShipAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
| ShipTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
| ShipTaxRegistrationType | String | Tax registration type for the entity. | |
| BuyerPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
| BuyerAddressAddressLine1 | String | First line of the address. | |
| BuyerAddressAddressLine2 | String | Additional address information, if required. | |
| BuyerAddressAddressLine3 | String | Additional address information, if required. | |
| BuyerAddressCity | String | The city where the person, business or institution is located. | |
| BuyerAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
| BuyerAddressCounty | String | The county where person, business or institution is located. | |
| BuyerAddressDistrict | String | The district where person, business or institution is located. | |
| BuyerAddressName | String | The name of the address of the person, business or institution. | |
| BuyerAddressPhone | String | The phone number of the person, business or institution located at that address. | |
| BuyerAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
| BuyerAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
| BuyerTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
| BuyerTaxRegistrationType | String | Tax registration type for the entity. | |
| SellerPartyId | String | Assigned identification for the party. For example, warehouse code or vendor code. | |
| SellerAddressAddressLine1 | String | First line of the address. | |
| SellerAddressAddressLine2 | String | Additional address information, if required. | |
| SellerAddressAddressLine3 | String | Additional address information, if required. | |
| SellerAddressCity | String | The city where the person, business or institution is located. | |
| SellerAddressCountryCode | String | The two digit country code in ISO 3166-1 alpha-2 format. | |
| SellerAddressCounty | String | The county where person, business or institution is located. | |
| SellerAddressDistrict | String | The district where person, business or institution is located. | |
| SellerAddressName | String | The name of the address of the person, business or institution. | |
| SellerAddressPhone | String | The phone number of the person, business or institution located at that address. | |
| SellerAddressPostalCode | String | The postal code of that address. It contains a series of letters or digits or both. | |
| SellerAddressStateOrRegion | String | The state or region where person, business or institution is located. | |
| SellerTaxRegistrationNumber | String | Tax registration number for the entity. For example, VAT ID. | |
| SellerTaxRegistrationType | String | Tax registration type for the entity. | |
| ImportContainers | String | Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. | |
| InternationalCommercialTerms | String | Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. | |
| MethodOfPayment | String | If the recipient requests, contains the shipment method of payment. This is for import PO's only.
使用できる値は次のとおりです。PaidBySeller, PrepaidBySeller, FOBPortOfCall, DefinedByBuyerAndSeller, CollectOnDelivery, PaidByBuyer | |
| PortOfDelivery | String | The port where goods on an import purchase order must be delivered by the vendor. | |
| ShippingInstructions | String | Special instructions regarding the shipment. |
| プロパティ | 説明 |
| Schema | The type of schema to use. |
| Marketplace | The Marketplace region that you are registered to sell in. |
| AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
| AppId | Application Id for Selling Partner app you created. |
| AWSSessionToken | AWS Session Token for Selling Partner app you created. |
| AWSAccessKey | Your AWS access key. |
| AWSSecretKey | Your AWS secret key. |
| IncludeRestrictedData | Determines if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII). |
| UseSandbox | A boolean determining if the connection should be made to the Selling Partner sandbox account. |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthAppStatus | Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status. |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| IncludeReports | Set this connection property to true to expose already created reports as views, this property is avaible for both schemas (SellerCentral and VendorCentral). |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| ProcedurePooling | Whether or not to get feed results after an execution of a stored procedure. |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| ReportTypes | Set this connection property to one or more report types to filter reports. |
| RowScanDepth | The maximum number of rows to scan to look for the columns datatype in a report. |
| SellerId | The Seller ID or merchant identifier you received when creating the account. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| TypeDetectionScheme | Specifies how to determine the data types of columns when selecting from Reports. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| Schema | The type of schema to use. |
| Marketplace | The Marketplace region that you are registered to sell in. |
| AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
| AppId | Application Id for Selling Partner app you created. |
| AWSSessionToken | AWS Session Token for Selling Partner app you created. |
| AWSAccessKey | Your AWS access key. |
| AWSSecretKey | Your AWS secret key. |
| IncludeRestrictedData | Determines if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII). |
| UseSandbox | A boolean determining if the connection should be made to the Selling Partner sandbox account. |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
The type of schema to use.
The available schemas are SellerCentral and VendorCentral.
The Marketplace region that you are registered to sell in.
Available regions for are Australia, Belgium, Brazil, Canada, Egypt, France, Germany, India, Ireland, Italy, Japan, Mexico, Netherlands, Poland, Saudi Arabia, Singapore, Spain, Sweden, Turkey, United Arab Emirates, United Kingdom, United States.
The Amazon Resource Name of the role to use when authenticating.
When authenticating outside of AWS, it is common to use a Role for authentication instead of your direct AWS account credentials. Entering the AWSRoleARN will cause the CData Sync App to perform a role based authentication instead of using the AWSAccessKey and AWSSecretKey directly. The AWSAccessKey and AWSSecretKey must still be specified to perform this authentication. You cannot use the credentials of an AWS root user when setting RoleARN. The AWSAccessKey and AWSSecretKey must be those of an IAM user.
Application Id for Selling Partner app you created.
Application Id for Selling Partner app you created.
AWS Session Token for Selling Partner app you created.
AWS Session Token can be obtained from AssumeRole request to AWS. AWSAccessKey and AWSSecretKey should also be provided when setting AWSSessionToken.
Your AWS access key.
This is the Access Key tied to the AWS user that is associated with the the OAuthClientId.
Your AWS secret key.
This is the Secret Key tied to the AWS user that is associated with the the OAuthClientId.
Determines if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).
Determines if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).
A boolean determining if the connection should be made to the Selling Partner sandbox account.
A boolean determining if the connection should be made to the Selling Partner sandbox account.
Amazon Web サービスのホスティングリージョン。
Amazon Web サービスのホスティングリージョン。利用可能な値は、OHIO、NORTHERNVIRGINIA、NORTHERNCALIFORNIA、OREGON、CAPETOWN、HONGKONG、HYDERABAD、JAKARTA、MALAYSIA、MELBOURNE、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、TOKYO、CENTRAL、CALGARY、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、SPAIN、STOCKHOLM、ZURICH、TELAVIV、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST、ISOLATEDUSEAST、ISOLATEDUSEASTB、ISOLATEDUSWEST、およびISOLATEDEUWEST です。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthAppStatus | Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status. |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.
Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.
If you set this property to 'Draft', the version=beta parameter is added to OAuth authorization URI, and the workflow authorizes an application in Draft state. Otherwise, the workflow authorizes an application published on the Amazon Seller Central Partner Network.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がAmazon Marketplace への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がAmazon Marketplace への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がAmazon Marketplace にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\AmazonMarketplace Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeReports | Set this connection property to true to expose already created reports as views, this property is avaible for both schemas (SellerCentral and VendorCentral). |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| ProcedurePooling | Whether or not to get feed results after an execution of a stored procedure. |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| ReportTypes | Set this connection property to one or more report types to filter reports. |
| RowScanDepth | The maximum number of rows to scan to look for the columns datatype in a report. |
| SellerId | The Seller ID or merchant identifier you received when creating the account. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| TypeDetectionScheme | Specifies how to determine the data types of columns when selecting from Reports. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
Set this connection property to true to expose already created reports as views, this property is avaible for both schemas (SellerCentral and VendorCentral).
Set this connection property to true to expose already created reports as views, this property is avaible for both schemas (SellerCentral and VendorCentral).
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Whether or not to get feed results after an execution of a stored procedure.
Set this to False if you do not want to wait to get the results of a stored procedure.
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
Set this connection property to one or more report types to filter reports.
Set this connection property to one or more comma-separated report types to filter reports. This property decides which report types to expose as views when IncludeReports = True and Schema = SellerCentral.
The maximum number of rows to scan to look for the columns datatype in a report.
The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.
The Seller ID or merchant identifier you received when creating the account.
The Seller ID or merchant identifier you received when creating the account.
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
Specifies how to determine the data types of columns when selecting from Reports.
When IncludeReports is set to True, this property specifies how to determine the data types.
| None | Setting TypeDetectionScheme to None will return all columns as the string type. |
| RowScan | Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. |
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。
テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
Amazon Marketplace テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。