Cloud

Build 25.0.9434
  • Amazon Marketplace
    • はじめに
      • 接続の確立
      • Amazon Marketplace データ保護ポリシー
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • Seller Central データモデル
        • テーブル
          • Destinations
          • InboundDeliveryWindowOptions
          • InboundItemComplianceDetails
          • InboundPackingOptions
          • InboundPlacementOptions
          • InboundPlan
          • InboundSelfShipAppointmentSlots
          • InboundShipmentContentUpdatePreview
          • ListingsItems
          • ListingsItemsAttributes
          • OutboundFulfillmentOrders
          • Subscriptions
        • ビュー
          • CatalogItems
          • CatalogItemsClassifications
          • CompetitivePricing
          • Feeds
          • FeesEstimate
          • InboundDeliveryChallanDocument
          • InboundOperationStatus
          • InboundPackingGroupBoxes
          • InboundPackingGroupItems
          • InboundPlanBoxes
          • InboundPlanItems
          • InboundPlanPallets
          • InboundShipmentBoxes
          • InboundShipmentItems
          • InboundShipmentPallets
          • InboundShipments
          • InboundTransportationOptions
          • InventorySupply
          • ItemOffers
          • ListingOffers
          • ListingsItemsIssues
          • ListingsItemsOffers
          • ListingsItemsSummaries
          • OrderItems
          • OrderMetrics
          • Orders
          • OutboundFeatures
          • OutboundFulfillmentOrderItems
          • OutboundFulfillmentsPreview
          • OutboundPackageTracking
          • OutboundReturnItems
          • OutboundReturnReasons
          • ProductPricing
          • ReportList
          • ReportTypes
          • ShippingDocuments
          • ShippingRates
          • ShippingTracking
        • ストアドプロシージャ
          • CancelFeed
          • CancelFulfillmentOrder
          • CancelInboundPlan
          • CancelReport
          • CancelSelfShipAppointment
          • CancelShipment
          • ConfirmDeliveryWindowOptions
          • ConfirmPackingOption
          • ConfirmPlacementOption
          • ConfirmShipment
          • ConfirmShipmentContentUpdatePreview
          • ConfirmTransportationOptions
          • CreateFulfillmentReturn
          • CreateMarketplaceItemLabels
          • CreateProductReviewAndSellerFeedbackSolicitation
          • CreateReportSchema
          • CreateScheduledPackage
          • CreateScheduledPackageBulk
          • CreateTransportationOption
          • GetAdditionalInputsSchema
          • GetFeedProcessingReport
          • GetInboundShipmentBillOfLading
          • GetInboundShipmentLabel
          • GetReport
          • GetScheduledPackage
          • GetSolicitationActionsForOrder
          • ListHandoverSlots
          • PurchaseShipment
          • RequestReport
          • ScheduleSelfShipAppointment
          • SetPackingInformation
          • SubmitCartonContentFeed
          • SubmitFulfillmentOrderStatus
          • SubmitOrderAcknowledgementFeed
          • SubmitOrderAdjustmentFeed
          • SubmitOrderFulfillmentFeed
          • SubmitSourcingOnDemandFeed
          • SubmitVATInvoiceFeed
          • UpdateScheduledPackages
          • UpdateShipmentStatus
          • UpdateShipmentTrackingDetails
      • Vendor Central データモデル
        • テーブル
          • Destinations
          • ListingsItems
          • ListingsItemsAttributes
          • Subscriptions
          • VendorShippingLabels
        • ビュー
          • CatalogItems
          • CatalogItemsClassifications
          • DirectFulfillmentOrderItems
          • DirectFulfillmentOrders
          • ListingsItemsIssues
          • ListingsItemsOffers
          • ListingsItemsSummaries
          • ReportList
          • ReportTypes
          • VendorCustomerInvoices
          • VendorOrderItems
          • VendorOrders
          • VendorOrderStatus
          • VendorPackingSlips
        • ストアドプロシージャ
          • AcknowledgeDirectFulfillmentOrder
          • AcknowledgeDirectFulfillmentOrderBatch
          • CancelReport
          • CheckDirectFulfillmentTransaction
          • CheckVendorTransactionStatus
          • ConfirmDirectFulfillmentShipment
          • ConfirmDirectFulfillmentShipmentBatch
          • CreateDirectFulfillmentContainer
          • CreateReportSchema
          • GetReport
          • RequestReport
          • SubmitDirectFulfillmentShippingLabel
          • SubmitDirectFulfillmentShippingLabelBatch
          • SubmitVendorOrderAcknowledgement
          • SubmitVendorPayments
          • SubmitVendorShipmentConfirmations
          • UpdateDirectFulfillmentInventory
          • UpdateDirectFulfillmentShipmentStatus
          • UpdateDirectFulfillmentShipmentStatusBatch
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • Schema
        • Marketplace
        • AWSRoleARN
        • AppId
        • AWSSessionToken
        • AWSAccessKey
        • AWSSecretKey
        • IncludeRestrictedData
        • UseSandbox
        • AWSRegion
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • OAuthAppStatus
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • IncludeReports
        • MaxRows
        • ProcedurePooling
        • PseudoColumns
        • ReportTypes
        • RowScanDepth
        • SellerId
        • Timeout
        • TypeDetectionScheme
        • UseSimpleNames
    • Third Party Copyrights

Amazon Marketplace - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるAmazon Marketplace へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してAmazon Marketplace に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Amazon Marketplace への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Amazon Marketplace は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのAmazon Marketplace への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Amazon Marketplace への接続

接続の確立 は、CData Cloud にデータベースを作成するためのAmazon Marketplace への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してAmazon Marketplace からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Amazon Marketplace に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Amazon Marketplace への接続

以下のプロパティが必須です。

  • Schema:SellerCentral に設定。
  • InitiateOAuth:GETANDREFRESH に設定。
  • Marketplace:販売登録されているマーケットプレイスのリージョンに設定。

Amazon Marketplace への認証

OAuth

Amazon Marketplace はOAuth 認証標準を利用しています。

OAuth で認証するには、組み込みアプリケーションを使用するか、新しいカスタムOAuth アプリを作成する必要があります。組み込みアプリケーションは、デスクトップアプリケーションおよびヘッドレスマシンをサポートします。Web アプリケーションでは、カスタムOAuth アプリケーションを作成する必要があります。

カスタムOAuth アプリケーションを使用して、サービスアカウントまたはユーザーアカウントで認証できます。詳しくは、カスタムOAuth アプリの作成 を参照してください。

埋め込みクレデンシャルのダウンロード

Amazon Marketplace は埋め込みクレデンシャルを6ヶ月ごとに入れ替える必要があるため、CData のクレデンシャルはoa.cdata.com でホストされます。カスタムクレデンシャルを指定しない場合、CData のWeb サービスから埋め込みクレデンシャルがダウンロードされ、デフォルトでOAuthClientLocation で指定した場所に保存されます。 NOTE:ファイアウォールがoa.cdata.com をブロックしないことを確認してください。

CData Cloud

Amazon Marketplace データ保護ポリシー

セキュリティのため、Amazon Marketplace ではPII(個人識別情報)へのアクセスを制限しています。以下の目的に必要な場合に限り、注文の配送後30日以内のみ、PII を保持することが可能です。

  • 注文を出荷する
  • 税金を計算 / 送金する
  • 納税請求書を作成する
  • 税務上もしくは規制上の要件などの法的要件を満たす
税務上またはその他の規制上の目的のために、PII のアーカイブコピーを保持することが法律で義務付けられている場合、PII を「コールド」バックアップまたはオフライン暗号化バックアップとして保管する必要があります(例えば、即時またはインタラクティブな使用には利用できません)。

これは例えば、Amazon Marketplace ドライバーが30日後に顧客の配送先住所を表示しなくなることを意味します。 詳しくは以下のAmazon のドキュメントを参照してください:

Amazon Marketplace データ保護ポリシー

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

CData Cloud は、Amazon Marketplace オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Amazon Marketplace オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、Amazon Marketplace API へのSQL の実行について詳しく説明します。

ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。

SellerCentral API の使用

Seller Central API で利用可能なエンティティについては、Seller Central データモデル を参照してください。

VendorCentral API の使用

Vendor Central API で利用可能なエンティティについては、Vendor Central データモデル を参照してください。

CData Cloud

Seller Central データモデル

CData Cloud は、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' の同じフィルタを使用してクエリを実行すると、新しいレポートが作成される代わりに、以前に作成されたレポートがダウンロードされます。

CData Cloud

テーブル

Cloud はAmazon Marketplace のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Amazon Marketplace テーブル

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.

CData Cloud

Destinations

Returns information about all destinations.

Columns

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

CData Cloud

InboundDeliveryWindowOptions

Retrieves all delivery window options for a shipment.

Columns

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 True

Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered.

StartDate Datetime True

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 True

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 True

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 True

Identifies type of Delivery Window Availability. Values: `AVAILABLE`, `CONGESTED`

CData Cloud

InboundItemComplianceDetails

List the inbound compliance details for MSKUs in a given marketplace.

Columns

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 True

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 True

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.

CData Cloud

InboundPackingOptions

Retrieves a list of all packing options for an inbound plan.

Columns

Name Type ReadOnly References Description
PackingOptionId [KEY] String True

Identifier of a packing option.

InboundPlanId [KEY] String False

Identifier of an inbound plan.

Discounts String True

Discount for the offered option.

Fees String True

Fee for the offered option.

Expiration Datetime True

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 True

The status of the packing option. Can be: `OFFERED`, `ACCEPTED`, or `EXPIRED`.

ShippingConfiguration String True

Deprecated. Use SupportedConfiguration instead. List of supported shipping modes.

PackingGroups String True

Packing group IDs.

SupportedConfiguration String True

A list of possible configurations for this option.

CData Cloud

InboundPlacementOptions

Provides a list of all placement options for an inbound plan.

Columns

Name Type ReadOnly References Description
PlacementOptionId [KEY] String True

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 True

Contains details about cost related modifications to the placement cost.

Fees String True

Contains details about cost related modifications to the placement cost.

Expiration Datetime True

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 True

The status of a placement option. Can be: `OFFERED`, `ACCEPTED`, or `EXPIRED`.

ShipmentIds String True

Shipment ids.

CustomPlacementInput String False

Provide units going to the warehouse.

CData Cloud

InboundPlan

Provides a list of inbound plans with minimal information.

Columns

Name Type ReadOnly References Description
InboundPlanId [KEY] String True

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 True

The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.

LastUpdatedAt Datetime True

The ISO 8601 datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.

Status String True

Current status of the inbound plan. Can be: `ACTIVE`, `VOIDED`, `SHIPPED`, 'ERRORED'.

ShipmentSummary String True

Summary information about a shipment.

PlacementOptionSummary String True

Summary information about a placement option.

PackingOptionSummary String True

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.

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

CData Cloud

InboundSelfShipAppointmentSlots

Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse.

Columns

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 True

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 True

The time at which the self ship appointment slot expires. In ISO 8601 datetime format.

CData Cloud

InboundShipmentContentUpdatePreview

Retrieve a paginated list of shipment content update previews for a given shipment.

Columns

Name Type ReadOnly References Description
ShipmentId [KEY] String False

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

ContentUpdatePreviewId [KEY] String True

Identifier of a content update preview.

InboundPlanId [KEY] String False

Identifier of an inbound plan.

Expiration Datetime True

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 True

Voidable until timestamp.

Name String True

The name of the carrier.

EndTime Datetime True

The end timestamp of the appointment in UTC.

ShippingMode String True

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 True

The time at which this transportation option quote expires.

TransportationOptionId String True

Identifier of a transportation option. A transportation option represent one option for how to send a shipment.

StartTime Datetime True

The start timestamp of the appointment in UTC.

AlphaCode String True

The carrier code. For example, USPS or DHLEX.

Amount Decimal True

Decimal value of the currency.

Code String True

ISO 4217 standard of a currency code.

ShippingSolution String True

Shipping program for the option. Can be: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`.

CData Cloud

ListingsItems

Returns details about a listings item for a selling partner.

The following filter is required:

  • SellerId: You can specify SellerId either as a criteria condition in WHERE filters or in the connection string.
Some example queries:
SELECT * FROM ListingsItems WHERE SellerId = 'XXXXXXXXXXXXXX'

INSERT INTO ListingsItems (ProductType, Requirements, Attributes, SellerId)
VALUES ('product_type', 'LISTING', '{\"AttributeName\": \"test_attribute\", \"AttributeValue\": \"value\"}', '12345', 'XXXXXXXXXXXXXX')

DELETE FROM ListingsItems WHERE 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, 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.

Columns

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.

CData Cloud

ListingsItemsAttributes

Returns details about a listings item attributes for a selling partner.

The following filters are required:

  • SKU
  • SellerId: You can either specify SellerId as a pseudo-column condition in WHERE filters, or in the connection string.
Some example queries:
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
)

Columns

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.

CData Cloud

OutboundFulfillmentOrders

Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.

Columns

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.

CData Cloud

Subscriptions

Returns information about subscriptions of the specified notification type.

Columns

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.

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Amazon Marketplace ビュー

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.

CData Cloud

CatalogItems

The Catalog Items table helps you retrieve item details for items in the catalog.

The following filters are required:

  • MarketplaceId
  • One of the following: Query, SellerSKU, UPC, EAN, ISBN, JAN
For example:
SELECT * FROM CatalogItems WHERE MarketplaceID = 'XXXXXXXXXXXXX' AND ISBN = 'XXXXXXXXXXXXX'

SELECT * FROM CatalogItems WHERE MarketplaceID = 'XXXXXXXXXXXXX' AND IncludedData = 'attributes'

Columns

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. To include attribute data in results, IncludedData='attributes' must be specified as a filter in the query.
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 Deprecated. Use MarketplaceASIN instead. 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.
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.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ClassificationIds String A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers.

CData Cloud

CatalogItemsClassifications

The Catalog Items Classifications table helps you retrieve classification details for items in the catalog.

Columns

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.

CData Cloud

CompetitivePricing

Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.

Columns

Name Type References Description
ASIN 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

CData Cloud

Feeds

The GetFeedSubmissionList operation returns a list of feed submissions.

Select

The Cloud 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 Cloud.

Note: 'FeedType' attribute is required to query the view. You can view available values for 'FeedType' here.

  • FeedId supports the '=' comparison.
  • FeedType supports the '=' and 'IN' comparisons.
  • MarketplaceIds supports the '=' and 'IN' comparisons.
  • ProcessingStatus supports the '=' and 'IN' comparisons.
  • CreatedTime supports the '=', '<', '>', '<=' and '>=' comparisons.

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.

Columns

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.

CData Cloud

FeesEstimate

Returns the estimated fees for the listed products.

Columns

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.

CData Cloud

InboundDeliveryChallanDocument

Provide delivery challan document for PCP transportation in India marketplace.

Columns

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

CData Cloud

InboundOperationStatus

Gets the status of the processing of an asynchronous API call.

Columns

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.

CData Cloud

InboundPackingGroupBoxes

Retrieves a page of boxes from a given packing group.

Columns

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.

CData Cloud

InboundPackingGroupItems

Retrieves a page of items in a given packing group.

Columns

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.

CData Cloud

InboundPlanBoxes

Provides a paginated list of box packages in an inbound plan.

Columns

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.

CData Cloud

InboundPlanItems

Provides a paginated list of item packages in an inbound plan.

Columns

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.

CData Cloud

InboundPlanPallets

Provides a paginated list of pallet packages in an inbound plan.

Columns

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.

CData Cloud

InboundShipmentBoxes

Provides a paginated list of box packages in a shipment.

Columns

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.

CData Cloud

InboundShipmentItems

Returns a list of items in a specified inbound shipment.

Select

The Cloud 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 Cloud.

  • MarketplaceId supports the '=' comparison.
  • ShipmentId supports the '=' comparison.
  • LastUpdatedDate supports the '=', '<', '>', '<=', '>=' comparisons.
For example, the following query is processed server side:
SELECT * FROM InboundShipmentItems  WHERE MarketplaceId = 'ATVPDKIKX0DER'

SELECT * FROM InboundShipmentItems  WHERE ShipmentId = 'FBA8J3K9LZPX'

SELECT * FROM InboundShipmentItems  WHERE LastUpdatedDate > '2020-01-01'

Columns

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.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
LastUpdatedDate Datetime A date used for selecting inbound shipments that were last updated before/after a specified time.

CData Cloud

InboundShipmentPallets

Provides a paginated list of pallet packages in a shipment.

Columns

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.

CData Cloud

InboundShipments

Returns a list of inbound shipments based on criteria that you specify.

Select

The Cloud 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 Cloud.

  • ShipmentId supports the '=' and 'IN' comparisons.
  • ShipmentStatus supports the '='and 'IN' comparisons.
  • MarketplaceId supports the '=' comparison.
  • LastUpdatedDate supports the '=', '<', '>', '<=', '>=' comparisons.
For example, the following query is processed server side:
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'

Columns

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.

Pseudo-Columns

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.

CData Cloud

InboundTransportationOptions

Retrieves all transportation options for a shipment.

Columns

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.

CData Cloud

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.

Select

The Cloud 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 Cloud.

Note: Attributes 'GranularityType' and 'GranularityId' are required to query the view. You must set GranularityId to the MarketplaceId from the API matching your region.

  • SellerSKU supports the '=', 'IN' comparisons.
  • GranularityType supports the '='comparison.
  • GranularityId supports the '=' comparison.
  • MarketplaceId supports the '=' comparison.
  • StartDateTime supports the '=', '<', '>', '<=', '>=' comparisons.

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'

Columns

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.

Pseudo-Columns

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.

CData Cloud

ItemOffers

Returns the lowest priced offers for a single item based on ASIN.

Columns

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

CData Cloud

ListingOffers

Generated schema file.

Columns

Name Type References Description
SellerSKU 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.

CData Cloud

ListingsItemsIssues

Returns details about a listings item issues for a selling partner.

The following filter is required:

  • SellerId: You can specify SellerId either as a criteria condition in WHERE filters or in the connection string.
Some example queries:
SELECT * FROM ListingsItemsIssues WHERE SellerId = 'XXXXXXXXXXXXXX'

Columns

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

SellerId String A selling partner identifier, such as a merchant account or vendor code.

CData Cloud

ListingsItemsOffers

Returns details about a listings item offers for a selling partner.

The following filter is required:

  • SellerId: You can specify SellerId either as a criteria condition in WHERE filters or in the connection string.
Some example queries:
SELECT * FROM ListingsItemsOffers WHERE SellerId = 'XXXXXXXXXXXXXX'

Columns

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 Decimal Purchase price amount of the listings item.
PriceCurrency String Purchase price currency of the listings item.
Points Integer 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).
SellerId String A selling partner identifier, such as a merchant account or vendor code.

CData Cloud

ListingsItemsSummaries

Returns details about a listings item summaries for a selling partner.

The following filter is required:

  • SellerId: You can specify SellerId either as a criteria condition in WHERE filters or in the connection string.
Some example queries:
SELECT * FROM ListingsItemsSummaries WHERE SellerId = 'XXXXXXXXXXXXXX'

Columns

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.
SellerId String A selling partner identifier, such as a merchant account or vendor code.

CData Cloud

OrderItems

Returns order items based on the Amazon Order Id that you specify.

Select

The Cloud 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 Cloud. OrderItems table supports server side filtering with = and IN operators for AmazonOrderId field.

  • AmazonOrderId supports the '=' comparison.
For example, the following query is processed server side:
SELECT * FROM OrderItems WHERE AmazonOrderId = '503-9993250-1405404'

Columns

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

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
LastUpdateDate Datetime The last time the order is updated.

CData Cloud

OrderMetrics

Returns aggregated order metrics for a given interval, broken down by granularity, for a given buyer type.

Columns

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.

Pseudo-Columns

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.

CData Cloud

Orders

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.

Select

The Cloud 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 Cloud.

  • AmazonOrderId supports the '=' comparison.
  • SellerOrderId supports the '=' comparison.
  • PurchaseDate supports the '=', '<', '>', '<=', '>=' comparison.
  • LastUpdateDate supports the '=', '<', '>', '<=', '>=' comparison.
  • OrderStatus supports the '=', 'IN' comparison.
  • FulfillmentChannel supports the '=', 'IN' comparison.
  • PaymentMethod supports the '=', 'IN' comparison.
  • MarketplaceId supports the '=' comparison.
  • BuyerEmail supports the '=' comparison.
  • IsISPU supports the '=' comparison.
For example, the following query is processed server side:
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'

Columns

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.

CData Cloud

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.

Columns

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.

CData Cloud

OutboundFulfillmentOrderItems

Returns the fulfillment order items indicated by the specified order identifier.

Columns

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.

CData Cloud

OutboundFulfillmentsPreview

Returns a list of fulfillment order previews based on shipping criteria that you specify.

Columns

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.

CData Cloud

OutboundPackageTracking

Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.

Columns

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.
EarliestDelivery Datetime The earliest time the package will be delivered.
LatestDelivery Datetime The latest time the package will be delivered

CData Cloud

OutboundReturnItems

An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.

Columns

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.

CData Cloud

OutboundReturnReasons

Returns a list of return reason codes for a seller SKU in a given marketplace.

Columns

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.

CData Cloud

ProductPricing

Generated schema file.

Columns

Name Type References Description
ASIN 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

CData Cloud

ReportList

Returns report details for the reports that match the filters that you specify.

Select

The Cloud 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 Cloud.

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.

  • ReportId supports the '=' comparison.
  • ReportType supports the '=', 'IN' comparisons.
  • MarketplaceIds supports the '=', 'IN' comparisons.
  • ProcessingStatus supports the '=', 'IN' comparisons.
  • CreatedTime supports the '=', '<', '>', '<=', '>=' comparisons.

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.

Columns

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.
IsRestrictedReport Boolean Boolean value indicating whether the report is restricted (report containing PII).

CData Cloud

ReportTypes

Returns report details for the reports that match the filters that you specify.

Select

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

Columns

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.

CData Cloud

ShippingDocuments

Returns the shipping documents associated with a package in a shipment.

Columns

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.

CData Cloud

ShippingRates

Returns the available shipping service offerings.

Columns

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.

CData Cloud

ShippingTracking

Returns tracking information for a purchased shipment.

Columns

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 Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Amazon Marketplace の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAmazon Marketplace から関連するレスポンスデータを返します。

CData Cloud - Amazon Marketplace ストアドプロシージャ

Name Description
CancelFeed The CancelFeed cancels feed submission for the given FeedId
CancelFulfillmentOrder Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. You cannot cancel a fulfillment order with a status of Processing, Complete, or CompletePartialled.
CancelInboundPlan Cancels an Inbound Plan.
CancelReport CancelReport operation cancels report request for the given ReportId.
CancelSelfShipAppointment Cancels a self-ship appointment slot against a shipment.
CancelShipment Cancels a purchased shipment.
ConfirmDeliveryWindowOptions Confirms the delivery window option for chosen shipment within an inbound plan.
ConfirmPackingOption Confirms the packing option for an inbound plan.
ConfirmPlacementOption Confirms the placement option for an inbound plan.
ConfirmShipment The ConfirmShipment operation updates the shipment confirmation status for a specified order.
ConfirmShipmentContentUpdatePreview Confirm a shipment content update preview and accept the changes in transportation cost.
ConfirmTransportationOptions Confirms all the transportation options for an inbound plan.
CreateFulfillmentReturn Creates a fulfillment return.
CreateMarketplaceItemLabels For a given marketplace - creates labels for a list of mskus.
CreateProductReviewAndSellerFeedbackSolicitation Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.
CreateReportSchema Creates a schema file based on the specified report.
CreateScheduledPackage Schedules an Easy Ship order
CreateScheduledPackageBulk The ConfirmShipment operation updates the shipment confirmation status for a specified order.
CreateTransportationOption Create a transportation option.
GetAdditionalInputsSchema Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering.
GetFeedProcessingReport Creates and/or returns data for a specific report.
GetInboundShipmentBillOfLading Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.
GetInboundShipmentLabel Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.
GetReport Creates and/or returns data for a specific report.
GetScheduledPackage Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status.
GetSolicitationActionsForOrder Returns a list of solicitation types that are available for an order that you specify.
ListHandoverSlots Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies.
PurchaseShipment Purchases a shipping service and returns purchase related details and documents.
RequestReport The RequestReport operation creates a report request.
ScheduleSelfShipAppointment Confirms or reschedules a self-ship appointment slot against a shipment.
SetPackingInformation Sets packing information for an inbound plan.
SubmitCartonContentFeed Submits carton content information for FBA inbound shipments.
SubmitFulfillmentOrderStatus Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint.
SubmitOrderAcknowledgementFeed The Order Acknowledgment feed allows you to acknowledge your success or failure with downloading an order.
SubmitOrderAdjustmentFeed The Order Adjustment feed allows you to issue a refund (adjustment) for an order. You must provide a reason for the adjustment, such as Customer Return, and the adjustment amount, broken down by price component (principle, shipping, tax, and so on).
SubmitOrderFulfillmentFeed The Order Fulfillment feed allows your system to update Amazon's system with order fulfillment information.
SubmitSourcingOnDemandFeed Usage information for the operation SubmitSourcingOnDemandFeed.rsb.
SubmitVATInvoiceFeed Submit a VAT invoice against a shipment. The invoice must be a PDF document. Note that UPLOAD_VAT_INVOICE is only available in the EU marketplace (VAT program). The throttling limit for the Invoicing Feed is one invoice upload every three seconds. This type is permitted by the Tax Invoicing (Restricted) role.
UpdateScheduledPackages Updates the time slot for handing over the package indicated by the specified scheduledPackageId. You can get the new slotId value for the time slot by calling the listHandoverSlots operation before making another patch call.
UpdateShipmentStatus Update the shipment status for a specific order. Intended to be used with sellers who are participating in the In-store Pickup program.
UpdateShipmentTrackingDetails Updates a shipment's tracking details.

CData Cloud

CancelFeed

The CancelFeed cancels feed submission for the given FeedId

Input

Name Type Required Description
FeedId String True Required. The identifier for the feed. This identifier is unique only in combination with a seller ID.

Result Set Columns

Name Type Description
Success Boolean Whether the CancelFeed operation successful or not

CData Cloud

CancelFulfillmentOrder

Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier. You cannot cancel a fulfillment order with a status of Processing, Complete, or CompletePartialled.

Input

Name Type Required Description
SellerFulfillmentOrderId String True The fulfillment order identifier.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.

CData Cloud

CancelInboundPlan

Cancels an Inbound Plan.

Input

Name Type Required Description
InboundPlanId String False Identifier of an inbound plan.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

CancelReport

CancelReport operation cancels report request for the given ReportId.

Input

Name Type Required Description
ReportId String True Required. The identifier for the report. This identifier is unique only in combination with a seller ID.

Result Set Columns

Name Type Description
Success Boolean Whether the CancelReport operation successful or not.

CData Cloud

CancelSelfShipAppointment

Cancels a self-ship appointment slot against a shipment.

Input

Name Type Required Description
ShipmentId String True Identifier of a shipment. A shipment contains the boxes and units being inbounded.
InboundPlanId String True Identifier of an inbound plan.
ReasonComment String True Reason for cancelling or rescheduling a self-ship appointment.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

CancelShipment

Cancels a purchased shipment.

Input

Name Type Required Description
ShipmentId String True The unique shipment identifier provided by a shipping service.
ShippingBusinessId String True Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.

CData Cloud

ConfirmDeliveryWindowOptions

Confirms the delivery window option for chosen shipment within an inbound plan.

Input

Name Type Required Description
ShipmentId String False The shipment to confirm the delivery window option for.
DeliveryWindowOptionId String False The id of the delivery window option to be confirmed.
InboundPlanId String False Identifier of an inbound plan.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

ConfirmPackingOption

Confirms the packing option for an inbound plan.

Input

Name Type Required Description
PackingOptionId String False Identifier of a packing option.
InboundPlanId String False Identifier of an inbound plan.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

ConfirmPlacementOption

Confirms the placement option for an inbound plan.

Input

Name Type Required Description
InboundPlanId String False Identifier of an inbound plan.
PlacementOptionId String False The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

ConfirmShipment

The ConfirmShipment operation updates the shipment confirmation status for a specified order.

Input

Name Type Required Description
AmazonOrderId String True Required. An Amazon-defined order identifier, in 3-7-7 format.
MarketplaceId String True Required. The unobfuscated marketplace identifier.
CodCollectionMethod String False The cod collection method, support in JP only.
PackageReferenceId String True Required. A seller-supplied identifier that uniquely identifies a package within the scope of an order. Note that only a positive numeric value is supported.
CarrierCode String False The code of the carrier.
CarrierName String False The name of the carrier.
ShippingMethod String False The shipping method of the order.
TrackingNumber String True Required. The tracking number of the order.
ShipDate Datetime True Required. The shipping date of the order.
ShipFromSupplySourceId String False The supply source id of the order.
OrderItems String True Required. The list of order items, quantities and transparency codes to be updated. Aggregate field.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.

CData Cloud

ConfirmShipmentContentUpdatePreview

Confirm a shipment content update preview and accept the changes in transportation cost.

Input

Name Type Required 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.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

ConfirmTransportationOptions

Confirms all the transportation options for an inbound plan.

Input

Name Type Required Description
InboundPlanId String False Identifier of an inbound plan.
Name String True The contact's name.
ShipmentId String True Shipment ID that the transportation Option is for.
PhoneNumber String True The phone number.
Email String False The email address.
TransportationOptionId String True Transportation option being selected for the provided shipment.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

CreateFulfillmentReturn

Creates a fulfillment return.

Input

Name Type Required Description
SellerFulfillmentOrderId String True The fulfillment order identifier.
SellerReturnItemId String True An identifier assigned by the seller to the return item.
SellerFulfillmentOrderItemId String True The identifier assigned to the item by the seller when the fulfillment order was created.
AmazonReturnReasonCode String True The return reason code that the Amazon fulfillment center assigned to the return item.
AmazonShipmentId String True The identifier for the shipment that is associated with the return item.
ReturnComment String False An optional comment about the return item.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.
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.
AmazonRmaId String The return merchandise authorization (RMA) that Amazon needs to process the return.
InvalidItemReasonCode String A code for why the item is invalid for return.
InvalidItemReasonDescription String A human readable description of the invalid item reason code.
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.
SellerReturnItemId String An identifier assigned by the seller to the return item.
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.

CData Cloud

CreateMarketplaceItemLabels

For a given marketplace - creates labels for a list of mskus.

Input

Name Type Required Description
Height Decimal False The height of the item label.
LabelPrintType String True Indicates the type of print type for a given label.
MskuQuantities String True Represents the quantity of an MSKU to print item labels for.
ItemLabelPageType String False The page type to use to print the labels. Possible values: 'A4_21', 'A4_24', 'A4_24_64x33', 'A4_24_66x35', 'A4_24_70x36', 'A4_24_70x37', 'A4_24i', 'A4_27', 'A4_40_52x29', 'A4_44_48x25', 'Letter_30'.
Width Decimal False The width of the item label.
LocaleCode String False The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of country codes separated by an underscore character.
MarketplaceId String True The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
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`.
Uri String Uniform resource identifier to identify where the document is located.

CData Cloud

CreateProductReviewAndSellerFeedbackSolicitation

Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.

Input

Name Type Required Description
AmazonOrderId String True Required. An Amazon order identifier. This specifies the order for which you want a list of available solicitation types.
MarketplaceId String True Required. A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

Result Set Columns

Name Type Description
Success Boolean Whether the GetSolicitationActionsForOrder operation successful or not

CData Cloud

CreateReportSchema

Creates a schema file based on the specified report.

CreateReportSchema

CreateReportSchema creates a schema file based on the specified report. This schema adds a table to your existing list that corresponds with the results of your report, which can then be queried like other tables. (Reports from the Amazon Marketplace are not modeled by Cloud as queryable tables by default.)

The generated schema file outlines the metadata for the report, such as columns and column data types. You can edit the file to adjust data types, rename columns, and include or exclude columns.

Updating a Report Schema

In the following example, the SP CreateReportSchema creates a new report using TestReportTest1 as a base template. It appends new columns to TestReportTest1 and creates a new report, named TestReport2. The new report is saved as ...\\TestReportTest2.rsd.
EXECUTE [CreateReportSchema] 
    [ReportName] = "TestReportTest2",
    [CustomFieldIdsPrimitive] = "1459925,1459928",
    [CustomFieldIdsDropdown] = "1469785",
    [CustomDimensionKeyIds] = "13539564",
    [BaseReportName] = "TestReportTest1", 
    [FileName] = "...\\TestReportTest2.rsd"

Input

Name Type Required Description
TableName String True The name for the new table.
ReportId String True The report document id.
ReportName String True The name or type of the report.
FileName String False The full file path and name of the schema to generate. Begin by choosing a parent directory (this parent directory should be set in the Location property). Complete the filepath by adding a directory corresponding to the schema used (SellerCentral), followed by a .rsd file with a name corresponding to the desired table name. For example : 'C:\\Users\\User\\Desktop\\AmazonMarketplace\\SellerCentral\\Filters.rsd'
Description String False An optional description for the table.
WriteToFile String False Whether to write the contents of the generated schema to a file or not. The input defaults to true. Set it to false to write to FileStream or FileData.

Result Set Columns

Name Type Description
Success String Whether or not the schema was created successfully.
FileData String The generated schema encoded in base64. Only returned if FileName is not set.

CData Cloud

CreateScheduledPackage

Schedules an Easy Ship order

Input

Name Type Required Description
AmazonOrderID String True An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
MarketplaceId String True A string of up to 255 characters.
PackageItems String False A time window to hand over an Easy Ship package to Amazon Logistics.
SlotId String True TAn Amazon-defined identifier for a time slot.
StartTime Datetime True The start date and time of the time slot.
EndTime Datetime True The end date and time of the time slot.
HandoverMethod String False The method by which a seller will hand a package over to Amazon Logistics.

使用できる値は次のとおりです。Pickup, Dropoff

PackageIdentifier String False Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.

CData Cloud

CreateScheduledPackageBulk

The ConfirmShipment operation updates the shipment confirmation status for a specified order.

Input

Name Type Required Description
LabelFormat String True The file format in which the shipping label will be created.
MarketplaceId String True A string of up to 255 characters.
OrderScheduleDetailsList String True An array allowing users to specify orders to be scheduled.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.

CData Cloud

CreateTransportationOption

Create a transportation option.

Input

Name Type Required Description
InboundPlanId String False Identifier of an inbound plan.
ShipmentId String True Identifier of a shipment. A shipment contains the boxes and units being inbounded.
Amount Decimal False Decimal value of the currency.
Code String False ISO 4217 standard of a currency code.
Name String False The contact's name.
PhoneNumber String False The phone number.
Stackability String False Indicates whether pallets will be stacked when carrier arrives for pick-up.
Email String False The email address.
UnitOfMeasurement String False Unit of linear measure.
Start Datetime True The start date of the window. The time component must be zero.
FreightClass String False Freight class. Can be: NONE,FC_50,FC_55,FC_60,FC_65,FC_70,FC_77_5,FC_85,FC_92_5,FC_100,FC_110,FC_125,FC_150,FC_175,FC_200,FC_250,FC_300,FC_400,FC_500.
Height Decimal False The height of a package.
Unit String False Unit of the weight being measured.
Value Decimal False Value of a weight.
Width Decimal False The width of a package.
Length Decimal False The length of a package.
Quantity Int False The number of containers where all other properties like weight or dimensions are identical.
PlacementOptionId String False The placement option to generate transportation options for.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

GetAdditionalInputsSchema

Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering.

Input

Name Type Required Description
RequestToken String True The request token returned in the response to the getRates operation.
RateId String True The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
ShippingBusinessId String True Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.
Schema String The JSON schema to use to provide additional inputs when required to purchase a shipping offering.

CData Cloud

GetFeedProcessingReport

Creates and/or returns data for a specific report.

Execute

Use the GetFeedProcessingReport stored procedure to download the processing report of a feed based on feedDocumentId. FeedDocumentId can be retrieved from the Feeds view as 'ResultFeedDocumentId'.

  EXEC GetFeedProcessingReport
  @FeedDocumentId = '1234',
  @DownloadPath = 'C:\Tests\AmazonMarketplaceTest'

Input

Name Type Required Description
FeedDocumentId String True Unique ID of the feed processing report to download.
DownloadPath String False The File path to write the report data. If no path is specified, the file is kept in memory in the FileData output.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating the result of the operation.
URL String A unique identifier for the report.
FileData String The file data output, if the LocalPath input is empty.

CData Cloud

GetInboundShipmentBillOfLading

Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment.

Input

Name Type Required Description
ShipmentId String False Required. A shipment identifier originally returned by the createInboundShipmentPlan operation.

Result Set Columns

Name Type Description
Success Boolean Whether the operation was successful or not.
TransportStatus String URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds.

CData Cloud

GetInboundShipmentLabel

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.

Input

Name Type Required Description
ShipmentId String False Required. A shipment identifier originally returned by the createInboundShipmentPlan operation.
PageType String True Required. The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
LabelType String True Required. The type of labels requested.
NumberOfPackages Integer False The number of packages in the shipment.
PackageLabelsToPrint String False A list of identifiers that specify packages for which you want package labels printed.
NumberOfPallets Integer False The number of pallets in the shipment. This returns four identical labels for each pallet.
PageSize Integer False The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
PageStartIndex Integer False The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments.

Result Set Columns

Name Type Description
Success Boolean Whether the operation was successful or not.
TransportStatus String URL to download the label for the package. Note: The URL will only be valid for 15 seconds.

CData Cloud

GetReport

Creates and/or returns data for a specific report.

Execute

To create and download a report in which case you must at least set ReportType, StartDate and DownloadPath attributes. The stored procedure will wait until the report is processed server side.
  EXEC GetReport
  @ReportDocumentId = '1234',
  @DownloadPath = 'C:\Tests\AmazonMarketplaceTest'

Input

Name Type Required Description
ReportDocumentId String True Unique ID of the report to download.
DownloadPath String False The File path to write the report data. If no path is specified, the file is kept in memory in the FileData output.
IsRestrictedReport Boolean False Boolean indicating whether the specified report ID is a restricted report (report containing PII).

デフォルト値はfalseです。

Result Set Columns

Name Type Description
Success Boolean Boolean indicating the result of the operation.
Url String A unique identifier for the report.
FileData String The file data output, if the LocalPath input is empty.

CData Cloud

GetScheduledPackage

Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status.

Input

Name Type Required Description
AmazonOrderID String True An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
MarketplaceId String True An identifier for the marketplace in which the seller is selling.

Result Set Columns

Name Type Description
AmazonOrderId String An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
PackageId String An Amazon-defined identifier for the scheduled package.
DimensionLength Decimal The length dimension.
DimensionWidth Decimal The width dimension.
DimensionHeight Decimal The height dimension.
DimensionUnit String The unit of measurement used to measure the length.
DimensionIdentifier String Identifier for custom package dimensions.
WeightValue Decimal The weight of the package.
WeightUnit String The unit of measurement used to measure the weight.
PackageItems String A list of items contained in the package.
SlotId String An Amazon-defined identifier for a time slot.
StartTime Datetime The start date and time of the time slot.
EndTime Datetime The end date and time of the time slot.
HandoverMethod String The method by which a seller will hand a package over to Amazon Logistics.
PackageIdentifier String Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.
InvoiceNumber String The invoice number.
InvoiceDate Datetime The date that the invoice was generated.
PackageStatus String The status of the package.
TrackingId String The tracking identifier for the scheduled package.

CData Cloud

GetSolicitationActionsForOrder

Returns a list of solicitation types that are available for an order that you specify.

Input

Name Type Required Description
AmazonOrderId String True Required. An Amazon order identifier. This specifies the order for which you want a list of available solicitation types.
MarketplaceId String True Required. A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

Result Set Columns

Name Type Description
Response String The response of the API call
Success Boolean Whether the GetSolicitationActionsForOrder operation successful or not

CData Cloud

ListHandoverSlots

Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies.

Input

Name Type Required Description
MarketplaceId String True A string of up to 255 characters.
AmazonOrderID String True An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
PackageDimensionLength Decimal True The length dimension.
PackageDimensionWidth Decimal True The width dimension.
PackageDimensionHeight Decimal True The height dimension.
PackageDimensionUnit String True The unit of measurement used to measure the length.

使用できる値は次のとおりです。Cm

PackageDimensionIdentifier String True Identifier for custom package dimensions.
PackageWeightValue Decimal True The weight of the package.
PackageWeightUnit String True The unit of measurement used to measure the weight.

使用できる値は次のとおりです。G

Result Set Columns

Name Type Description
SlotId String An Amazon-defined identifier for a time slot.
StartTime String The start date and time of the time slot.
EndTime Datetime The end date and time of the time slot.

CData Cloud

PurchaseShipment

Purchases a shipping service and returns purchase related details and documents.

Input

Name Type Required Description
RequestToken String False A unique token generated to identify a getRates operation.
RateId String False An identifier for the rate (shipment offering) provided by a shipping service provider.
RequestedDocumentFormat String False The file format of the document.

使用できる値は次のとおりです。PDF, PNG, ZPL

RequestedDocumentLength String False The length of the document measured in the units specified.
RequestedDocumentUnit String False The unit of measurement.
RequestedDocumentWidth String False The width of the document measured in the units specified.
RequestedDocumentDPI String False The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document.
RequestedDocumentPageLayout String False Indicates the position of the label on the paper. Should be the same value as returned in getRates response.
RequestedDocumentNeedFileJoining Boolean False When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false.
RequestedDocumentTypes String False A list of the document types requested.

使用できる値は次のとおりです。PACKSLIP, LABEL, RECEIPT, CUSTOM_FORM

RequestedValueAddedServices String False The value-added services to be added to a shipping service purchase.
AdditionalInputs String False The additional inputs required to purchase a shipping offering, in JSON format. Additional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation.
ShippingBusinessId String False Amazon shipping business to assume for this request. The default is AmazonShipping_UK. Refer X-amzn-shipping-business-id for other marketplaces.

デフォルト値はAmazonShipping_UKです。

IdempotencyKey String False A unique value which the server uses to recognize subsequent retries of the same request.

Result Set Columns

Name Type Description
ShipmentId String The unique shipment identifier provided by a shipping service.
PackageClientReferenceId String 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.
TrackingId String The carrier generated identifier for a package in a purchased shipment.
PromisedDeliveryStartTime Datetime The promised start time of delivery.
PromisedDeliveryEndTime Datetime The promised end time of delivery.
PromisedPickupStartTime Datetime The promised start time of pickup.
PromisedPickupEndTime Datetime The promised end time of pickup.

CData Cloud

RequestReport

The RequestReport operation creates a report request.

Input

Name Type Required Description
ReportType String True Required. Indicates the report type to request.
DataStartTime Datetime False The start date of the date range used to select the data to report.By default it is the current date. If specified, it must be before the current date.
DataEndTime Datetime False End date of the date range used to select the data to report. By default it is the current date. If specified, it must be before the current date.
ReportOptions String False Additional information to pass to the report. If the report accepts ReportOptions, the information is displayed in the report description in the ReportType enumerator section.
MarketplaceIds String True Required. A list of one or more marketplace IDs for the marketplace that registered the listing account.

Result Set Columns

Name Type Description
ReportId String A unique identifier for the report.
IsRestrictedReport Boolean Boolean value indicating whether the report is restricted (report containing PII).

CData Cloud

ScheduleSelfShipAppointment

Confirms or reschedules a self-ship appointment slot against a shipment.

Input

Name Type Required Description
ShipmentId String False Identifier of a shipment. A shipment contains the boxes and units being inbounded.
SlotId String False An identifier to a self-ship appointment slot.
InboundPlanId String False Identifier of an inbound plan.
ReasonComment String True Reason for cancelling or rescheduling a self-ship appointment.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
AppointmentId Long Identifier for appointment.
StartTime Datetime The start timestamp of the appointment in UTC.
EndTime Datetime The end timestamp of the appointment in UTC.
AppointmentStatus String Status of the appointment.

CData Cloud

SetPackingInformation

Sets packing information for an inbound plan.

Input

Name Type Required Description
InboundPlanId String False Identifier of an inbound plan.
PackingGroupId String False The ID of the `packingGroup` that packages are grouped according to. The `PackingGroupId` can only be provided before placement confirmation, and it must belong to the confirmed `PackingOption`. One of `ShipmentId` or `PackingGroupId` must be provided with every request.
ShipmentId String False The ID of the shipment that packages are grouped according to. The `ShipmentId` can only be provided after placement confirmation, and the shipment must belong to the confirmed placement option. One of `ShipmentId` or `PackingGroupId` must be provided with every request.
BoxInput String True Input information for a given box.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

SubmitCartonContentFeed

Submits carton content information for FBA inbound shipments.

Execute

The stored procedure accepts two aggregated formats: #TEMP tables and XML aggregate

For #TEMP tables

You must include in your query:

INSERT Item#TEMP (SKU, QuantityShipped, QuantityInCase) VALUES ('16510', 200, 1)

INSERT Carton#TEMP (CartonId, Item) VALUES ('28', 'Item#TEMP')

INSERT INTO ContentsRequestFeedAggregate#TEMP (ShipmentId, NumCartons, Carton) VALUES ('NY59', 1, 'Carton#TEMP')

Then you execute the procedure by specifying the value of CartonContentsRequestFeedAggregate with the name of #TEMP table used ContentsRequestFeedAggregate#TEMP.

EXEC SubmitCartonContentFeed CartonContentsRequestFeedAggregate = 'ContentsRequestFeedAggregate#TEMP', MarketplaceIds='11111'

*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

For XML aggregate

The XML aggregate must follow the API structure (https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/xsd/release_4_1/ProductImage.xsd):

    <Message>
        <MessageID>1</MessageID>
        <CartonContentsRequest>
            <ShipmentId>NY59</ShipmentId>
            <NumCartons>1</NumCartons>
            <Carton>
                <CartonId>28</CartonId>
                <Item>
                    <SKU>16510</SKU>
                    <QuantityShipped>200</QuantityShipped>
                    <QuantityInCase>1</QuantityInCase>
                </Item>
            </Carton>
        </CartonContentsRequest>
    </Message>

EXEC SubmitCartonContentFeed CartonContentsRequestFeedAggregate = '...(the above XML)...', MarketplaceIds='11111'

Input

Name Type Required Description
ShipmentId String False A shipment identifier originally returned by the createInboundShipmentPlan operation.
NumCartons Integer False The number of cartons in the feed.
CartonId String False A carton identifier.
SKU String False The seller SKU of the item.
QuantityShipped Integer False The item quantity that you are shipping.
QuantityInCase Integer False The item quantity in each case, for case-packed items. Note that QuantityInCase multiplied by the number of boxes in the inbound shipment equals QuantityShipped.

デフォルト値は1です。

ExpirationDate Date False The expiration date for the item, if there is any.
Item String False SKU and quantity information for the items in the shipment in XML format.
Carton String False Aggregate representing the carton. Can be in the form of XML or #TEMP table.
CartonContentsRequestFeedAggregate String False Carton content information for FBA inbound shipments in XML format.
MarketplaceIds String True Required. A list of one or more marketplace IDs for the marketplace that registered the listing account.

Result Set Columns

Name Type Description
FeedId String A unique identifier for the feed.
FeedType String The type of feed submitted.
SubmittedDate Datetime The date and time when the feed was submitted.
FeedProcessingStatus String The processing status of the feed submission.

CData Cloud

SubmitFulfillmentOrderStatus

Requests that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint.

Input

Name Type Required Description
SellerFulfillmentOrderId String True The fulfillment order identifier.
FulfillmentOrderStatus String True The current status of the fulfillment order.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.

CData Cloud

SubmitOrderAcknowledgementFeed

The Order Acknowledgment feed allows you to acknowledge your success or failure with downloading an order.

Execute

The stored procedure accepts two aggregated formats: #TEMP tables and XML aggregate

For #TEMP tables

You must include in your query:

INSERT INTO OrderAcknowledgementFeedAggregate#TEMP (AmazonOrderId, StatusCode, AmazonOrderItemCode, CancelReason) VALUES ('249-6070298-2783041', 'Failure', '25959136016214', 'NoInventory')

Then you execute the procedure by specifying the value of OrderAcknowledgementFeedAggregate with the name of #TEMP table used OrderAcknowledgementFeedAggregate#TEMP.

EXEC SubmitOrderAcknowledgementFeed OrderAcknowledgementFeedAggregate = 'OrderAcknowledgementFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'

*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

For XML aggregate

The XML aggregate must follow the API structure (https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/xsd/release_4_1/OrderAcknowledgement.xsd):

    <Message>
        <MessageID>1</MessageID>
        <OrderAcknowledgement>
          <AmazonOrderID>249-6070298-2783041</AmazonOrderID>
          <StatusCode>Failure</StatusCode>
		  <Item>
			<AmazonOrderItemCode>25959136016214</AmazonOrderItemCode>
			<CancelReason>NoInventory</CancelReason>
		  </Item>
        </OrderAcknowledgement>
      </Message>

EXEC SubmitOrderAcknowledgementFeed OrderAcknowledgementFeedAggregate = '...(the above XML)...', marketplaceids = 'A1VC38T7YXB528'

Input

Name Type Required Description
AmazonOrderID String False Amazon's unique identifier for an order, which identifies the entire order, regardless of the number of individual items in the order.
MerchantOrderID String False Optional seller-supplied order ID. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to the order.
StatusCode String False Allows you to acknowledge your success or failure with downloading an order. StatusCode can be either Success or Failure.
AmazonOrderItemCode String False Amazon's unique identifier for an item in an order.
MerchantOrderItemID String False Optional seller-supplied ID for an item in an order. If the MerchantOrderItemID is specified with the AmazonOrderItemCode, Amazon will map the two IDs and you can then use your own order item ID for subsequent feeds relating to that order item.
CancelReason String False Used only when sending a StatusCode of Failure.
ItemAggregate String False An aggregate representing an order Item. Can be in the form of XML or a #TEMP table. Use this field when multiple items in the order need to be acknowledged.
OrderAcknowledgementFeedAggregate String False An aggregate representing the feed. Can be in the form of XML or a #TEMP table.
MarketplaceIds String True Required. A list of one or more marketplace IDs for the marketplace that registered the listing account.

Result Set Columns

Name Type Description
FeedId String A unique identifier for the feed.
FeedType String The type of feed submitted.
SubmittedDate Datetime The date and time when the feed was submitted.
FeedProcessingStatus String The processing status of the feed submission.

CData Cloud

SubmitOrderAdjustmentFeed

The Order Adjustment feed allows you to issue a refund (adjustment) for an order. You must provide a reason for the adjustment, such as Customer Return, and the adjustment amount, broken down by price component (principle, shipping, tax, and so on).

Execute

The stored procedure accepts two aggregated formats: #TEMP tables and XML aggregate

For #TEMP tables

You must include in your query:

INSERT INTO ItemPriceAdjustmentsAggregate#TEMP (ItemPriceAdjustmentsComponentType, ItemPriceAdjustmentsComponentAmount, ItemPriceAdjustmentsComponentAmountCurrency) VALUES ('Shipping', '150', 'JPY')

INSERT INTO AdjustedItemAggregate#TEMP (AdjustedItemAmazonOrderItemCode, AdjustedItemAdjustmentReason, ItemPriceAdjustmentsAggregate) VALUES ('25959136016214', 'CustomerReturn', 'ItemPriceAdjustmentsAggregate#TEMP')

INSERT INTO OrderAdjustmentFeedAggregate#TEMP (AmazonOrderID, OperationType, AdjustedItemAggregate) VALUES ('503-0717426-9080645', 'Update', 'AdjustedItemAggregate#TEMP')

Then you execute the procedure by specifying the value of OrderAdjustmentFeedAggregate with the name of #TEMP table used OrderAdjustmentFeedAggregate#TEMP.

EXEC SubmitOrderAdjustmentFeed OrderAdjustmentFeedAggregate = 'OrderAdjustmentFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'

*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

For XML aggregate

The XML aggregate must follow the API structure (https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/xsd/release_4_1/OrderAdjustment.xsd):

    <Message>
        <MessageID>1</MessageID>
        <OperationType>Update</OperationType>
        <OrderAdjustment>
          <AmazonOrderID>503-0717426-9080645</AmazonOrderID>
          <AdjustedItem>
            <AmazonOrderItemCode>25959136016214</AmazonOrderItemCode>
            <AdjustmentReason>CustomerReturn</AdjustmentReason>
            <ItemPriceAdjustments>
              <Component>
                <Type>Shipping</Type>
                <Amount currency="JPY">150</Amount>
              </Component>
            </ItemPriceAdjustments>
          </AdjustedItem>
        </OrderAdjustment>
    </Message>

EXEC SubmitOrderAdjustmentFeed OrderAdjustmentFeedAggregate = '...(the above XML)...', marketplaceids = 'A1VC38T7YXB528'

Input

Name Type Required Description
AmazonOrderID String False Amazon's unique identifier for an order, which identifies the entire order regardless of the number of individual items in the order.
OperationType String False Required if AdjustedItemAggregate is empty. Used to specify the type of operation (Update or Delete) to be performed on the data.
MerchantOrderID String False Optional seller-supplied order ID. The first step is to establish the MerchantOrderID in the acknowledgment feed. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to that order. See the base XSD for the definition.
AdjustedItemQuantityCancelled Integer False Quantity of items being canceled. Used only for partial cancellations.
AdjustedItemAmazonOrderItemCode String False Amazon's unique ID for an item in an order.
AdjustedItemMerchantOrderItemID String False Optional seller-supplied ID for an item in an order. It can be used in order processing if the pairing was established in the acknowledgment feed.
AdjustedItemMerchantAdjustmentItemID String False Optional seller-supplied unique ID for the adjustment (not used by Amazon).
AdjustedItemAdjustmentReason String False Reason for the adjustment.
ItemPriceAdjustmentsComponentType String False The Type of price adjustment for the item. Values include: Principal, Shipping, Tax, ShippingTax, RestockingFee, RestockingFeeTax, GiftWrap, GiftWrapTax, Surcharge, ReturnShipping, Goodwill, ExportCharge, COD, CODTax, Other, FreeReplacementReturnShipping
ItemPriceAdjustmentsComponentAmount Decimal False The Amount of the adjustment.
ItemPriceAdjustmentsComponentAmountCurrency String False The Currency for the Amount.
ItemPriceAdjustmentsAggregate String False An aggregate representing the Amount the buyer is to be refunded for the item. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple item price adjustments need to be applied.
PromotionAdjustmentsPromotionClaimCode String False The ClaimCode for the Promotion Adjustment.
PromotionAdjustmentsMerchantPromotionID String False The Promotion Id for the Promotion Adjustment.
PromotionAdjustmentsComponentType String False The Type of price adjustment for the promotion.
PromotionAdjustmentsComponentAmount Decimal False The Amount of price adjustment for the promotion.
PromotionAdjustmentsComponentAmountCurrency String False The Currency for the Amount.
PromotionAdjustmentsComponentAggregate String False An aggregate representing the Amount the buyer is to be refunded for the promotion, broken down by type. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple promotion price adjustments need to be applied.
PromotionAdjustmentsAggregate String False An aggregate representing the promotion. Child Elements include PromotionClaimCode, MerchantPromotionID, ComponentAggregate (Type, Amount and Amount@Currency). Use this field if multiple promotions need to be applied.
AdjustedItemAggregate String False An aggregate representing order adjustment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field if multiple items need adjusting in 1 order.
OrderAdjustmentFeedAggregate String False An aggregate representing the feed. Can be in the form of XML or a #TEMP table.
MarketplaceIds String True Required. A list of one or more marketplace IDs for the marketplace that registered the listing account.

Result Set Columns

Name Type Description
FeedId String A unique identifier for the feed.
FeedType String The type of feed submitted.
SubmittedDate Datetime The date and time when the feed was submitted.
FeedProcessingStatus String The processing status of the feed submission.

CData Cloud

SubmitOrderFulfillmentFeed

The Order Fulfillment feed allows your system to update Amazon's system with order fulfillment information.

Execute

The stored procedure accepts two aggregated formats: #TEMP tables and XML aggregate

For #TEMP tables

You must include in your query:

INSERT INTO ItemAggregate#TEMP (ItemAmazonOrderItemCode, ItemQuantity) VALUES ('25959136016214', '1');

INSERT INTO OrderFulfillmentFeedAggregate#TEMP (AmazonOrderID, FulfillmentDate, FulfillmentDataCarrierName, FulfillmentDataShippingMethod, FulfillmentDataShipperTrackingNumber, ItemAggregate) VALUES ('249-6070298-2783041', '2017-02-01T00:00:00Z', 'CData Delivery Company', 'Normal Delivery', '1223525345234', 'ItemAggregate#TEMP')

Then you execute the procedure by specifying the value of OrderFulfillmentFeedAggregate with the name of #TEMP table used OrderFulfillmentFeedAggregate#TEMP.

EXEC SubmitOrderFulfillmentFeed OrderFulfillmentFeedAggregate = 'OrderFulfillmentFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'

*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

For XML aggregate

The XML aggregate must follow the API structure (https://images-na.ssl-images-amazon.com/images/G/01/rainier/help/xsd/release_4_1/OrderFulfillment.xsd):

    <Message>
    <MessageID>1</MessageID>
    <OrderFulfillment>
        <AmazonOrderID>249-6070298-2783041</AmazonOrderID>
        <FulfillmentDate>2017-02-01T00:00:00Z</FulfillmentDate>
        <FulfillmentData>
            <CarrierName>CData Delivery Company</CarrierName>
            <ShippingMethod>Normal Delivery</ShippingMethod>
            <ShipperTrackingNumber>1223525345234</ShipperTrackingNumber>
        </FulfillmentData>
        <Item>
            <AmazonOrderItemCode>25959136016214</AmazonOrderItemCode>
            <Quantity>1</Quantity>
        </Item>
    </OrderFulfillment>
</Message>

EXEC SubmitOrderFulfillmentFeed OrderFulfillmentFeedAggregate = '...(the above XML)...', marketplaceids = 'A1VC38T7YXB528'

Input

Name Type Required Description
AmazonOrderID String False Amazon's unique identifier for an order, which identifies the entire order regardless of the number of individual items in the order.
MerchantOrderID String False Optional seller-supplied order ID. The first step is to establish the MerchantOrderID in the acknowledgment feed. Amazon will map the MerchantOrderID to the AmazonOrderID, and you can then use your own order ID (MerchantOrderID) for subsequent feeds relating to that order. See the base XSD for the definition.
OperationType String False Required if OrderFulfillmentFeedAggregate is empty. Used to specify the type of operation (Update or Delete) to be performed on the data.
MerchantFulfillmentID Integer False Seller-supplied unique identifier for the shipment (not used by Amazon).
FulfillmentDate Datetime False The date the item was actually shipped or picked up, depending on the fulfillment method specified in the order.
FulfillmentDataCarrierCode String False The shipping carrier code.
FulfillmentDataCarrierName String False The shipping carrier name.
FulfillmentDataShippingMethod String False The shipping method used to deliver the item.
FulfillmentDataShipperTrackingNumber String False The tracking number for the shipment.
CODCollectionMethod String False Cash on delivery collection mode of an order.
ItemAmazonOrderItemCode String False Amazon's unique ID for an item in an order.
ItemMerchantOrderItemID String False The shipping Optional seller-supplied ID for an item in an order.
ItemMerchantFulfillmentItemID String False Seller-supplied unique identifier for an item in the shipment (not used by Amazon).
ItemQuantity Integer False The quantity of an item shipped.
ItemAggregate String False An aggregate representing order-fulfillment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field when multiple Items need to be included in the feed.
FulfillmentDataAggregate String False An aggregate representing order-fulfillment information for a specific item. Can be in the form of XML, JSON, or a #TEMP table. Use this field when multiple Items need to be included in the feed.
OrderFulfillmentFeedAggregate String False An aggregate representing the feed. Can be in the form of XML, JSON, or a #TEMP table.
MarketplaceIds String True Required. A list of one or more marketplace IDs for the marketplace that registered the listing account.
ShipFromSourceId String False An identifier from where the order should be shipped.

Result Set Columns

Name Type Description
FeedId String A unique identifier for the feed.
FeedType String The type of feed submitted.
SubmittedDate Datetime The date and time when the feed was submitted.
FeedProcessingStatus String The processing status of the feed submission.

CData Cloud

SubmitSourcingOnDemandFeed

Usage information for the operation SubmitSourcingOnDemandFeed.rsb.

Execute

The stored procedure accepts two aggregated formats: #TEMP tables and XML aggregate

For #TEMP tables

You must include in your query:

INSERT INTO OrderSourcingOnDemandFeedAggregate#TEMP (AmazonOrderID, SKU, EstimatedShipDate) VALUES ('250-4747727-9303810', '15700', '2018-12-08T00:00:00Z');

Then you execute the procedure by specifying the value of OrderSourcingOnDemandFeedAggregate with the name of #TEMP table used OrderSourcingOnDemandFeedAggregate#TEMP.

EXEC SubmitSourcingOnDemandFeed OrderSourcingOnDemandFeedAggregate = 'OrderSourcingOnDemandFeedAggregate#TEMP', marketplaceids = 'A1VC38T7YXB528'

*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

For XML aggregate

The XML aggregate must follow the API structure (https://m.media-amazon.com/images/G/01/rainier/help/xsd/release_4_1/OrderSourcingOnDemand._CB475945388_.xsd):

    <Message>
        <MessageID>1</MessageID>
        <OrderSourcingOnDemand>
            <AmazonOrderID>250-4747727-9303810</AmazonOrderID>
            <SKU>15700</SKU>
            <EstimatedShipDate>2018-12-08T00:00:00Z</EstimatedShipDate>
        </OrderSourcingOnDemand>
      </Message>

EXEC SubmitSourcingOnDemandFeed OrderSourcingOnDemandFeedAggregate = '...(the above XML)...', marketplaceids = 'A1VC38T7YXB528'

Input

Name Type Required Description
AmazonOrderID String False Amazon Order ID.
SKU String False Required. Used to identify an individual product. Each product must have a SKU, and each SKU must be unique.
EstimatedShipDate Datetime False Required. Estimated ship date.
OrderSourcingOnDemandFeedAggregate String False An aggregate representing the feed. Can be in the form of XML or a #TEMP table.
MarketplaceIds String True Required. A list of one or more marketplace IDs for the marketplace that registered the listing account.

Result Set Columns

Name Type Description
FeedId String A unique identifier for the feed.
FeedType String The type of feed submitted.
SubmittedDate Datetime The date and time when the feed was submitted.
FeedProcessingStatus String The processing status of the feed submission.

CData Cloud

SubmitVATInvoiceFeed

Submit a VAT invoice against a shipment. The invoice must be a PDF document. Note that UPLOAD_VAT_INVOICE is only available in the EU marketplace (VAT program). The throttling limit for the Invoicing Feed is one invoice upload every three seconds. This type is permitted by the Tax Invoicing (Restricted) role.

Input

Name Type Required Description
MarketplaceIds String True Required. A list of one or more marketplace IDs for the marketplace that registered the listing account.
OrderId String False Required if ShippingId is not specified. The identifier of the order for which the invoice is being submitted.
ShippingId String False Required if OrderId is not specified. The identifier of the shipment for which the invoice is being submitted.
TotalAmount Decimal False Optional but recommended. The total amount on the invoice. This is VAT-inclusive prices on items, gift wrap, and shipping, minus the VAT on all promotions. If the total amount specified does not match Amazon's total amount for this shipment, to two decimal places, then the invoice upload will be rejected.
TotalVATAmount Decimal False Optional but recommended. The total VAT amount on the invoice. This is the VAT on the items, gift wrap, and shipping, minus the VAT on all promotions. If the VAT amount provided here does not match the VAT amount calculated by Amazon for this shipment, to two decimal places, then the invoice upload will be rejected.
InvoiceNumber String True Required. The invoice number used in the invoice. This invoice number will be shared with customers. Sellers must ensure the same invoice number appears on the invoice.
DocumentType String True Required. Possible values include Invoice and CreditNote. Use Invoice if you are uploading an invoice. Use CreditNote if you are uploading a credit note for a refund or a return.

使用できる値は次のとおりです。Invoice, CreditNote

TransactionId String False Required only if DocumentType=CreditNote.
LocalPath String False Full path of the invoice you want to upload.

Result Set Columns

Name Type Description
FeedId String A unique identifier for the feed.
FeedType String The type of feed submitted.
SubmittedDate Datetime The date and time when the feed was submitted.
FeedProcessingStatus String The processing status of the feed submission.

CData Cloud

UpdateScheduledPackages

Updates the time slot for handing over the package indicated by the specified scheduledPackageId. You can get the new slotId value for the time slot by calling the listHandoverSlots operation before making another patch call.

Input

Name Type Required Description
MarketplaceId String True A string of up to 255 characters.
UpdatePackageDetailsList String True A list of package update details.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.

CData Cloud

UpdateShipmentStatus

Update the shipment status for a specific order. Intended to be used with sellers who are participating in the In-store Pickup program.

Execute

The Driver uses #TEMP tables as fields for aggregate information entered.

First, create an OrderItems temporary table for the OrderItems input:

INSERT INTO orderItems#TEMP (OrderItemId, Quantity) VALUES ('123-1234567-1234567', 1);
INSERT INTO orderItems#TEMP (OrderItemId, Quantity) VALUES ('321-1234567-1234567', 2)

After the necessary temporary table has been created, execute the stored procedure as shown in the example below:

EXECUTE UpdateShipmentStatus
		OrderId        =   '123-1234567-1234567',
		ShipmentStatus =   'PickedUp',
		OrderItems     =   'orderItems#TEMP';

*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

OrderItems temporary table schema info:

Column NameTypeRequired
OrderItemId string true
Quantity integer true

Input

Name Type Required Description
OrderId String True An Amazon-defined order identifier, in 3-7-7 format.
ShipmentStatus String True The shipment status to apply.

使用できる値は次のとおりです。ReadyForPickup, PickedUp, RefusedPickup

MarketplaceId String False The unobfuscated marketplace identifier.
OrderItems String False For partial shipment status updates, the list of order items and quantities to be updated. Aggregate field.

Result Set Columns

Name Type Description
Success String

CData Cloud

UpdateShipmentTrackingDetails

Updates a shipment's tracking details.

Input

Name Type Required Description
ShipmentId String False Identifier of a shipment. A shipment contains the boxes and units being inbounded.
BoxId String False 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.
TrackingId String False The tracking Id associated with each box in a non-Amazon partnered Small Parcel Delivery (SPD) shipment. The seller must provide this information.
BillOfLadingNumber String False The number of the carrier shipment acknowledgement document.
FreightBillNumber String False Number associated with the freight bill.
InboundPlanId String False Identifier of an inbound plan.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
OperationId String UUID for the given operation.

CData Cloud

Vendor Central データモデル

CData Cloud は、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' の同じフィルタを使用してクエリを実行すると、新しいレポートが作成される代わりに、以前に作成されたレポートがダウンロードされます。

CData Cloud

テーブル

Cloud はAmazon Marketplace のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Amazon Marketplace テーブル

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

CData Cloud

Destinations

Returns information about all destinations.

Columns

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

CData Cloud

ListingsItems

Returns details about a listings item for a selling partner.

Columns

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.

CData Cloud

ListingsItemsAttributes

Returns details about a listings item attributes for a selling partner.

Columns

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.

CData Cloud

Subscriptions

Returns information about subscriptions of the specified notification type.

Columns

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.

CData Cloud

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.

Select

The following fields are filtered server-side:
  • PurchaseOrderNumber supports the '=' comparison
  • CreatedDate supports all the >, >=, =, <=, < comparisons

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

When inserting, you can also use temp tables in order to insert fields for aggregate objects, as shown in the example below:
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.

Container temporary table schema info:

Column NameTypeRequiredDescription
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.

PackedItems temporary table schema info:

Column NameTypeRequiredDescription
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.

TaxRegistrationDetails temporary table schema info:

Column NameTypeRequiredDescription
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.

Address temporary table schema info:

Column NameType RequiredDescription
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.

Columns

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

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
CreatedDate String

Containers String

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Amazon Marketplace ビュー

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.
DirectFulfillmentOrderItems Returns a list of order items from purchase orders created during the time frame that you specify.
DirectFulfillmentOrders Returns a list of purchase orders created during the time frame that you specify.
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.
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.
VendorOrderItems Returns a purchase order based on the `purchaseOrderNumber` value that you specify.
VendorOrders The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
VendorOrderStatus Returns purchase order statuses based on the filters that you specify.
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.

CData Cloud

CatalogItems

The Catalog Items table helps you retrieve item details for items in the catalog.

The following filters are required:

  • MarketplaceId
  • One of the following: Query, SellerSKU, UPC, EAN, ISBN, JAN
For example:
SELECT * FROM CatalogItems WHERE MarketplaceID = 'XXXXXXXXXXXXX' AND ISBN = 'XXXXXXXXXXXXX'

SELECT * FROM CatalogItems WHERE MarketplaceID = 'XXXXXXXXXXXXX' AND IncludedData = 'attributes'

Columns

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. To include attribute data in results, IncludedData='attributes' must be specified as a filter in the query.
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 Deprecated. Use MarketplaceASIN instead. 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.
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.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ClassificationIds String A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers.

CData Cloud

CatalogItemsClassifications

The Catalog Items Classifications table helps you retrieve classification details for items in the catalog.

Columns

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.

CData Cloud

DirectFulfillmentOrderItems

Returns a list of order items from purchase orders created during the time frame that you specify.

Columns

Name Type References Description
ItemSequenceNumber [KEY] String Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
PurchaseOrderNumber [KEY] String The purchase order number for this order. Formatting Notes: alpha-numeric code.
BuyerProductId String Buyer's standard identification number (ASIN) of an item.
CurrencyCode String Three digit currency code in ISO 4217 format. String of length 3.
CustomUrl String A Base 64 encoded URL using the UTF-8 character set. The URL provides the location of the zip file that specifies the types of customizations or configurations allowed by the vendor, along with types and ranges for the attributes of their products.
DeliveryServiceType String Scheduled delivery service type.
EarliestDeliveryDate Datetime Earliest nominated delivery date for the scheduled delivery.
GiftMessage String Gift message to be printed in shipment.
GiftWrapId String Gift wrap identifier for the gift wrapping, if any.
ItemTitle String Title for the item.
LatestDeliveryDate Datetime Latest nominated delivery date for the scheduled delivery.
NetPrice String A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
OrderDate Datetime The date the order was placed.
OrderedAmount Int Acknowledged quantity. This value should not be zero.
OrderStatus String Current status of the order.
ShipFromId String The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
TaxLineItem String The tax details for the order.
TotalPrice String A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
UnitOfMeasure String Unit of measure for the acknowledged quantity.
VendorProductId String The vendor selected product identification of the item.

CData Cloud

DirectFulfillmentOrders

Returns a list of purchase orders created during the time frame that you specify.

Columns

Name Type References Description
PurchaseOrderNumber [KEY] String The purchase order number for this order. Formatting Notes: alpha-numeric code.
BillToPartyAddressLine1 String First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyAddressLine2 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyAddressLine3 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyAttention String The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyCity String The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyCountryCode String The two digit country code. In ISO 3166-1 alpha-2 format.
BillToPartyCounty String The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyDistrict String The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyId String Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
BillToPartyName String The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyPhone String The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyPostalCode String The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
BillToPartyStateOrRegion String The state or region where person, business or institution is located.
BillToPartyTaxRegAddressLine1 String First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegAddressLine2 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegAddressLine3 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegAttention String The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegCity String The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegCountryCode String The two digit country code. In ISO 3166-1 alpha-2 format.
BillToPartyTaxRegCounty String The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegDistrict String The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegMessages String Tax registration message that can be used for additional tax related details.
BillToPartyTaxRegName String The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegNumber String Tax registration number for the party. For example, VAT ID.
BillToPartyTaxRegPhone String The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
BillToPartyTaxRegPostalCode String The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
BillToPartyTaxRegStateOrRegion String The state or region where person, business or institution is located.
BillToPartyTaxRegType String Tax registration type for the entity.
CustomerMessage String Message to customer for order status.
CustomerOrderNum String The customer order number.
IsGift Bool When true, the order contain a gift. Include the gift message and gift wrap information.
IsPriority Bool When true, this is a priority shipment.
IsScheduledDelivery Bool When true, this order is part of a scheduled delivery program.
IsSlipRequired Bool When true, a packing slip is required to be sent to the customer.
OrderDate Datetime The date the order was placed.
OrderStatus String Current status of the order.
OrderItems String A JSON aggregate containing the line items included in this purchase order.
OrderTaxDetails String The tax details for the order.
PromisedDate Datetime Delivery date promised to the Amazon customer.
RequiredDate Datetime Time by which the vendor is required to ship the order.
SellingPartyAddressLine1 String First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyAddressLine2 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyAddressLine3 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyAttention String The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyCity String The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyCountryCode String The two digit country code. In ISO 3166-1 alpha-2 format.
SellingPartyCounty String The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyDistrict String The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyId String Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
SellingPartyName String The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyPhone String The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyPostalCode String The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyStateOrRegion String The state or region where person, business or institution is located.
SellingPartyTaxRegMessages String Tax registration message that can be used for additional tax related details.
SellingPartyTaxRegNumber String Tax registration number for the party. For example, VAT ID.
SellingPartyTaxRegType String Tax registration type for the entity.
ShipFromId String The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
ShipMethod String Ship method to be used for shipping the order. Amazon defines ship method codes indicating the shipping carrier and shipment service level.
ShippingPartyAddressLine1 String First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyAddressLine2 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyAddressLine3 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyAttention String The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyCity String The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyCountryCode String The two digit country code. In ISO 3166-1 alpha-2 format.
ShippingPartyCounty String The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyDistrict String The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyName String The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyPhone String The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyPostalCode String The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
ShippingPartyStateOrRegion String The state or region where person, business or institution is located.
ShippingPartyTaxRegAddressLine1 String First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegAddressLine2 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegAddressLine3 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegAttention String The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegCity String The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegCountryCode String The two digit country code. In ISO 3166-1 alpha-2 format.
ShippingPartyTaxRegCounty String The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegDistrict String The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegMessages String Tax registration message that can be used for additional tax related details.
ShippingPartyTaxRegName String The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegNumber String Tax registration number for the party. For example, VAT ID.
ShippingPartyTaxRegPhone String The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShippingPartyTaxRegPostalCode String The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
ShippingPartyTaxRegStateOrRegion String The state or region where person, business or institution is located.
ShippingPartyTaxRegType String Tax registration type for the entity.
ShipToAddressLine1 String First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToAddressLine2 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToAddressLine3 String Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToAttention String The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToCity String The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToCountryCode String The two digit country code. In ISO 3166-1 alpha-2 format.
ShipToCounty String The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToDistrict String The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToName String The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToPhone String The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipToPostalCode String The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
ShipToStateOrRegion String The state or region where person, business or institution is located.

CData Cloud

ListingsItemsIssues

Returns details about a listings item issues for a selling partner.

Columns

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

SellerId String A selling partner identifier, such as a merchant account or vendor code.

CData Cloud

ListingsItemsOffers

Returns details about a listings item offers for a selling partner.

Columns

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 Decimal Purchase price amount of the listings item.
PriceCurrency String Purchase price currency of the listings item.
Points Integer 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).
SellerId String A selling partner identifier, such as a merchant account or vendor code.

CData Cloud

ListingsItemsSummaries

Returns details about a listings item summaries for a selling partner.

Columns

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.
SellerId String A selling partner identifier, such as a merchant account or vendor code.

CData Cloud

ReportList

Returns report details for the reports that match the filters that you specify.

Columns

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.
IsRestrictedReport Boolean Boolean value indicating whether the report is restricted (report containing PII).

CData Cloud

ReportTypes

Returns report details for the reports that match the filters that you specify.

Columns

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.

CData Cloud

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.

Select

The following fields are filtered server-side:
  • PurchaseOrderNumber supports the '=' comparison
  • CreatedDate supports all the >, >=, =, <=, < comparisons

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'

Columns

Name Type References Description
PurchaseOrderNumber [KEY] String This field will contain the Purchase Order Number for this order.
Content String The Base64encoded customer invoice.

Pseudo-Columns

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.

CData Cloud

VendorOrderItems

Returns a purchase order based on the `purchaseOrderNumber` value that you specify.

Columns

Name Type References Description
PurchaseOrderNumber [KEY] String The purchase order number for this order.
ItemSequenceNumber [KEY] String Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
PurchaseOrderState String The current state of the purchase order.

使用できる値は次のとおりです。New, Acknowledged, Closed

SellerPartyId String Assigned identification for the party. For example, warehouse code or vendor code.
VendorProductIdentifier String The vendor selected product identification of the item.
AmazonProductIdentifier String Amazon Standard Identification Number (ASIN) of an item.
OrderedQuantityUnitOfMeasure String Unit of measure for the acknowledged quantity.
OrderedQuantityAmount Decimal Acknowledged quantity. This value should not be zero.
OrderedQuantityUnitSize Int The case size, in the event that we ordered using cases.
ListPriceUnitOfMeasure String Unit of measure for the acknowledged quantity.
ListPriceAmount Decimal Acknowledged quantity. This value should not be zero.
ListPriceCurrencyCode String Three digit currency code in ISO 4217 format. String of length 3.
NetCostUnitOfMeasure String Unit of measure for the acknowledged quantity.
NetCostAmount Decimal Acknowledged quantity. This value should not be zero.
NetCostCurrencyCode String Three digit currency code in ISO 4217 format. String of length 3.
IsBackOrderAllowed Bool When true, we will accept backorder confirmations for this item.
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.

CData Cloud

VendorOrders

The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.

Select

The Cloud 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 Cloud.

  • PurchaseOrderNumber supports the '=' comparison.
  • PurchaseOrderState supports the '='comparison.
  • PurchaseOrderDate supports the '<', '>' comparisons and ORDER BY clause.
  • PurchaseOrderChangedDate supports the '<', '>' comparisons.
  • SellerPartyId supports the '=' comparison.

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'

Columns

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.

CData Cloud

VendorOrderStatus

Returns purchase order statuses based on the filters that you specify.

Columns

Name Type References Description
PurchaseOrderNumber [KEY] String Provides purchase order status for the specified purchase order number.
ItemSequenceNumber [KEY] String Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
PurchaseOrderStatus String Buyer has received all of the items in the purchase order.
PurchaseOrderDate String The date the purchase order was placed. Must be in ISO-8601 date/time format.
BuyerProductIdentifier String Buyer's Standard Identification Number (ASIN) of an item.
CurrencyCode String Three digit currency code in ISO 4217 format for the listed price. String of length 3.
Amount String Acknowledged quantity for the listed price. This value should not be zero.
VendorProductIdentifier String The vendor selected product identification of the item.
OrderedQuantityAmount Decimal Acknowledged quantity. This value should not be zero.
OrderedQuantityUnitMeasure String Unit of measure for the acknowledged quantity.
OrderedQuantityUnitSize Int The case size, in the event that we ordered using cases.
ItemReceiveStatus String Receive status of the line item.
ItemReceiveAmount Decimal Acknowledged quantity. This value should not be zero.
ItemReceiveUnitMeasure String Unit of measure for the acknowledged quantity.
ItemReceiveUnitSize Int The case size, in the event that we ordered using cases.
ItemReceiveDate Datetime The date when the purchase order was last received. Must be in ISO-8601 date/time format.
ItemConfirmationStatus String Confirmation status of line item.
ItemConfirmationAmount Decimal Acknowledged quantity. This value should not be zero.
ItemConfirmationUnitMeasure String Unit of measure for the acknowledged quantity.
ItemConfirmationUnitSize Int The case size, in the event that we ordered using cases.
ItemRejectionAmount Decimal Acknowledged quantity. This value should not be zero.
ItemRejectionUnitMeasure String Unit of measure for the acknowledged quantity.
ItemRejectionUnitSize Int The case size, in the event that we ordered using cases.
SellingPartyId String Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
SellingPartyTaxRegistrationNumber String Tax registration number for the entity. For example, VAT ID.
SellingPartyTaxRegistrationType String Tax registration type for the entity.
SellingPartyPostalCode String The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyAddressLine1 String First line of the address.
SellingPartyAddressLine2 String Additional address information, if required.
SellingPartyAddressLine3 String Additional address information, if required.
SellingPartyCountryCode String The two digit country code. In ISO 3166-1 alpha-2 format.
SellingPartyCounty String The county where person, business or institution is located.
SellingPartyCity String The city where the person, business or institution is located.
SellingPartyDistrict String The district where person, business or institution is located.
SellingPartyName String The name of the person, business or institution at that address.
SellingPartyStateOrRegion String The state or region where person, business or institution is located.
SellingPartyPhone String The phone number of the person, business or institution located at that address.
ShipToPartyId String Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
ShipToPartyTaxRegistrationNumber String Tax registration number for the entity. For example, VAT ID.
ShipToPartyTaxRegistrationType String Tax registration type for the entity.
ShipToPartyPostalCode String The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
ShipToPartyAddressLine1 String First line of the address.
ShipToPartyAddressLine2 String Additional address information, if required.
ShipToPartyAddressLine3 String Additional address information, if required.
ShipToPartyCountryCode String The two digit country code. In ISO 3166-1 alpha-2 format.
ShipToPartyCounty String The county where person, business or institution is located.
ShipToPartyCity String The city where the person, business or institution is located.
ShipToPartyDistrict String The district where person, business or institution is located.
ShipToPartyName String The name of the person, business or institution at that address.
ShipToPartyStateOrRegion String The state or region where person, business or institution is located.
ShipToPartyPhone String The phone number of the person, business or institution located at that address.
LastUpdatedDate Datetime The date when the purchase order was last updated. Must be in ISO-8601 date/time format.
OrderedQuantityDetails String Details of item quantity ordered.
AcknowledgementStatusDetails String Details of item quantity ordered.

CData Cloud

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.

Select

The following fields are filtered server-side:
  • PurchaseOrderNumber supports the '=' comparison
  • CreatedDate supports all the >, >=, =, <=, < comparisons

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'

Columns

Name Type References Description
PurchaseOrderNumber [KEY] String This field will contain the Purchase Order Number for this order.
Content String A Base64encoded string of the packing slip PDF.
ContentType String The format of the file such as PDF, JPEG etc

Pseudo-Columns

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

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Amazon Marketplace の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAmazon Marketplace から関連するレスポンスデータを返します。

CData Cloud - Amazon Marketplace ストアドプロシージャ

Name Description
AcknowledgeDirectFulfillmentOrder Submits an acknowledgement for a purchase order.
AcknowledgeDirectFulfillmentOrderBatch Submits acknowledgements for one or more purchase orders.
CancelReport CancelReport operation cancels report request for the given ReportId.
CheckDirectFulfillmentTransaction Returns the status of the transaction indicated by the specified transactionId.
CheckVendorTransactionStatus Returns the status of the transaction that you specify.
ConfirmDirectFulfillmentShipment Submits one shipment confirmation for vendor orders.
ConfirmDirectFulfillmentShipmentBatch Submits one or more shipment confirmations for vendor orders.
CreateDirectFulfillmentContainer Creates a container (pallet) label for the associated shipment package.
CreateReportSchema Creates a schema file based on the specified report.
GetReport Creates and/or returns data for a specific report.
RequestReport The RequestReport operation creates a report request.
SubmitDirectFulfillmentShippingLabel Creates a shipping label for a purchase order and returns a `transactionId` for reference.
SubmitDirectFulfillmentShippingLabelBatch Creates shipping labels for a purchase order and returns a `transactionId` for reference.
SubmitVendorOrderAcknowledgement Submits acknowledgements for one purchase order.
SubmitVendorPayments Submit new invoices to Amazon Marketplace for a vendor's direct fulfillment orders.
SubmitVendorShipmentConfirmations Submits shipment confirmations for vendor orders.
UpdateDirectFulfillmentInventory Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.
UpdateDirectFulfillmentShipmentStatus This operation is only to be used by Vendor-Own-Carrier (VOC) vendors to update a shipment status.
UpdateDirectFulfillmentShipmentStatusBatch This operation is only to be used by Vendor-Own-Carrier (VOC) vendors to update multiple shipment statuses in the same operation execution.

CData Cloud

AcknowledgeDirectFulfillmentOrder

Submits an acknowledgement for a purchase order.

Input

Name Type Required Description
AcknowledgementDate Datetime True The date and time when the order is acknowledged, in ISO-8601 date/time format. For example: 2018-07-16T23:00:00Z / 2018-07-16T23:00:00-05:00 / 2018-07-16T23:00:00-08:00.
ShipFromTaxRegistrationAddressLine1 String True First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromTaxRegistrationAddressLine2 String False Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromTaxRegistrationAddressLine3 String False Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromAddressLine1 String True First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromAddressLine2 String False Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromAddressLine3 String False Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromAttention String False The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromCity String False The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromCountryCode String True The two digit country code. In ISO 3166-1 alpha-2 format.
ShipFromCounty String False The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromDistrict String False The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromName String True The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromPhone String False The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromPostalCode String False The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
ShipFromStateOrRegion String True The state or region where person, business or institution is located.
ShipFromTaxRegistrationAttention String False The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromTaxRegistrationCity String False The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
Code String True Acknowledgement code is a unique two digit value which indicates the status of the acknowledgement. For a list of acknowledgement codes that Amazon supports, see the Vendor Direct Fulfillment APIs Use Case Guide.
ShipFromTaxRegistrationCountryCode String True The two digit country code. In ISO 3166-1 alpha-2 format.
ShipFromTaxRegistrationCounty String False The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
Description String True Reason for the acknowledgement code.
ShipFromTaxRegistrationDistrict String False The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromTaxRegistrationName String True The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
OrderItemAcknowledgements String True Details of an individual item within the order being acknowledged.
ShipFromPartyId String True Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
ShipFromTaxRegistrationPhone String False The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
ShipFromTaxRegistrationPostalCode String False The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
PurchaseOrderNumber String True The purchase order number for this order. Formatting Notes: alpha-numeric code.
ShipFromTaxRegistrationStateOrRegion String True The state or region where person, business or institution is located.
ShipFromTaxRegistrationMessages String False Tax registration message that can be used for additional tax related details.
ShipFromTaxRegistrationNumber String True Tax registration number for the party. For example, VAT ID.
ShipFromTaxRegistrationType String False Tax registration type for the entity.
VendorOrderNumber String True The vendor's order number for this order.
SellingPartyAddressLine1 String True First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyAddressLine2 String False Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyAddressLine3 String False Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyAttention String False The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyCity String False The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyCountryCode String True The two digit country code. In ISO 3166-1 alpha-2 format.
SellingPartyCounty String False The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyDistrict String False The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyName String True The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyId String True Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details.
SellingPartyPhone String False The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyPostalCode String False The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyStateOrRegion String True The state or region where person, business or institution is located.
SellingPartyTaxRegistrationAddressLine1 String True First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationAddressLine2 String False Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationAddressLine3 String False Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationAttention String False The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationCity String False The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationCountryCode String True The two digit country code. In ISO 3166-1 alpha-2 format.
SellingPartyTaxRegistrationCounty String False The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationDistrict String False The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationName String True The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationPhone String False The phone number of the person, business or institution located at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
SellingPartyTaxRegistrationPostalCode String False The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyTaxRegistrationStateOrRegion String False The state or region where person, business or institution is located.
SellingPartyTaxRegistrationMessages String False Tax registration message that can be used for additional tax related details.
SellingPartyTaxRegistrationNumber String False Tax registration number for the party. For example, VAT ID.
SellingPartyTaxRegistrationType String False Tax registration type for the entity.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

AcknowledgeDirectFulfillmentOrderBatch

Submits acknowledgements for one or more purchase orders.

Input

Name Type Required Description
OrderAcknowledgementItems String True Details of an individual order being acknowledged.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

CancelReport

CancelReport operation cancels report request for the given ReportId.

Input

Name Type Required Description
ReportId String True Required. The identifier for the report. This identifier is unique only in combination with a seller ID.

Result Set Columns

Name Type Description
Success Boolean Whether the CancelReport operation successful or not.

CData Cloud

CheckDirectFulfillmentTransaction

Returns the status of the transaction indicated by the specified transactionId.

Input

Name Type Required Description
TransactionId String True The unique identifier sent in the 'transactionId' field in response to the post request of a specific transaction.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
Status String Current processing status of the transaction.
TransactionId String The unique identifier sent in the 'transactionId' field in response to the post request of a specific transaction.

CData Cloud

CheckVendorTransactionStatus

Returns the status of the transaction that you specify.

Execute

Below you can find an example query for executing this stored procedure:

EXECUTE CheckVendorTransactionStatus TransactionId = '1b2ba545-d325-4fc6-bdf1-93ff967cb964'

Input

Name Type Required Description
TransactionId String True The GUID provided by Amazon in the 'transactionId' field in response to the post request of a specific transaction.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.
Status String Current processing status of the transaction. Values: Failure, Processing, Success.

CData Cloud

ConfirmDirectFulfillmentShipment

Submits one shipment confirmation for vendor orders.

Input

Name Type Required Description
ShipFromAddressLine1 String True First line of the address.
ShipFromAddressLine2 String False Additional street address information, if required.
ShipFromAddressLine3 String False Additional street address information, if required.
ShipFromCity String False The city where the person, business or institution is located.
Containers String False A container used for shipping and packing items.
ShipFromCountryCode String True The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
ShipFromCounty String False The county where person, business or institution is located.
ShipFromDistrict String False The district where person, business or institution is located.
EstimatedDeliveryDate Datetime False The date on which the shipment is expected to reach the buyer's warehouse. The date is estimated based on the average transit time between the ship-from location and the destination. Usually, the exact appointment time is unknown when creating the shipment confirmation and is later provided by the buyer.
IsPriorityShipment Bool False Provide the priority of the shipment.
ShipmentItems String True Details of the items being shipped.
ShipFromName String False The name of the person, business or institution at that address.
ShipFromPartyId String True The identifier of the party.
ShipFromPhone String False The phone number of the person, business or institution located at that address.
ShipFromPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
PurchaseOrderNumber String True Purchase order number corresponding to the shipment.
ShipmentStatus String True The shipment status.
ShippedDate Datetime True The date of the shipment's departure from vendor's location. Vendors send ASNs within 30 minutes of departure from their warehouse/distribution center or six hours prior to the appointment time at the Amazon destination warehouse. The shipped date mentioned in the shipment confirmation cannot be in the future.
ShipFromStateOrRegion String False The state or region where person, business or institution is located.
ShipFromTaxRegistrationDetails String False Tax registration details of the entity.
VendorOrderNumber String False The vendor order number is a unique identifier generated by a vendor for their reference.
SellingPartyAddressLine1 String True First line of the address.
SellingPartyAddressLine2 String False Additional street address information, if required.
SellingPartyAddressLine3 String False Additional street address information, if required.
SellingPartyCity String False The city where the person, business or institution is located.
SellingPartyCountryCode String True The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
SellingPartyCounty String False The county where person, business or institution is located.
SellingPartyDistrict String False The district where person, business or institution is located.
SellingPartyName String True The name of the person, business or institution at that address.
SellingPartyId String True The identifier of the party.
SellingPartyPhone String False The phone number of the person, business or institution located at that address.
SellingPartyPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyStateOrRegion String False The state or region where person, business or institution is located.
SellingPartyTaxRegistrationDetails String False Tax registration details of the entity.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

ConfirmDirectFulfillmentShipmentBatch

Submits one or more shipment confirmations for vendor orders.

Input

Name Type Required Description
ShipmentConfirmations String True Represents the confirmation details of a shipment, including the purchase order number and other shipment details.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

CreateDirectFulfillmentContainer

Creates a container (pallet) label for the associated shipment package.

Input

Name Type Required Description
ShipFromPartyAddressLine1 String False First line of the address.
ShipFromPartyAddressLine2 String False Additional street address information, if required.
ShipFromPartyAddressLine3 String False Additional street address information, if required.
ShipFromPartyCarrierId String False The unique carrier code for the carrier for whom container labels are requested.
ShipFromPartyCity String False The city where the person, business or institution is located.
ShipFromPartyCountryCode String False The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
ShipFromPartyCounty String False The county where person, business or institution is located.
ShipFromPartyDistrict String False The district where person, business or institution is located.
ShipFromPartyName String False The name of the person, business or institution at that address.
ShipFromPartyPackages String False An array of package objects in a container.
ShipFromPartyPartyId String False The identifier of the party.
ShipFromPartyPhone String False The phone number of the person, business or institution located at that address.
ShipFromPartyPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
ShipFromPartyStateOrRegion String False The state or region where person, business or institution is located.
ShipFromPartyTaxRegistrationDetails String False Tax registration details of the entity.
ContainerId String False The unique, vendor-provided identifier for the container.
SellingPartyAddressLine1 String False First line of the address.
SellingPartyAddressLine2 String False Additional street address information, if required.
SellingPartyAddressLine3 String False Additional street address information, if required.
SellingPartyCity String False The city where the person, business or institution is located.
SellingPartyCountryCode String False The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
SellingPartyCounty String False The county where person, business or institution is located.
SellingPartyDistrict String False The district where person, business or institution is located.
SellingPartyName String False The name of the person, business or institution at that address.
SellingPartyPartyId String False The identifier of the party.
SellingPartyPhone String False The phone number of the person, business or institution located at that address.
SellingPartyPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyStateOrRegion String False The state or region where person, business or institution is located.
SellingPartyTaxRegistrationDetails String False Tax registration details of the entity.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
ContainerTrackingNumber String The container (pallet) tracking identifier from the shipping carrier.
Content String The container label content encoded into a Base64 string.
Format String The format of the container label.

CData Cloud

CreateReportSchema

Creates a schema file based on the specified report.

CreateReportSchema

CreateReportSchema creates a schema file based on the specified report. This schema adds a table to your existing list that corresponds with the results of your report, which can then be queried like other tables. (Reports from the Amazon Marketplace are not modeled by Cloud as queryable tables by default.)

The generated schema file outlines the metadata for the report, such as columns and column data types. You can edit the file to adjust data types, rename columns, and include or exclude columns.

Updating a Report Schema

In the following example, the SP CreateReportSchema creates a new report using TestReportTest1 as a base template. It appends new columns to TestReportTest1 and creates a new report, named TestReport2. The new report is saved as ...\\TestReportTest2.rsd.
EXECUTE [CreateReportSchema] 
    [ReportName] = "TestReportTest2",
    [CustomFieldIdsPrimitive] = "1459925,1459928",
    [CustomFieldIdsDropdown] = "1469785",
    [CustomDimensionKeyIds] = "13539564",
    [BaseReportName] = "TestReportTest1", 
    [FileName] = "...\\TestReportTest2.rsd"

Input

Name Type Required Description
TableName String True The name for the new table.
ReportId String True The report document id.
ReportName String True The name or type of the report.
FileName String False The full file path and name of the schema to generate. Begin by choosing a parent directory (this parent directory should be set in the Location property). Complete the filepath by adding a directory corresponding to the schema used (VendorCentral), followed by a .rsd file with a name corresponding to the desired table name. For example : 'C:\\Users\\User\\Desktop\\AmazonMarketplace\\VendorCentral\\Filters.rsd'
Description String False An optional description for the table.
WriteToFile String False Whether to write the contents of the generated schema to a file or not. The input defaults to true. Set it to false to write to FileStream or FileData.

Result Set Columns

Name Type Description
Success String Whether or not the schema was created successfully.
FileData String The generated schema encoded in base64. Only returned if FileName is not set.

CData Cloud

GetReport

Creates and/or returns data for a specific report.

Input

Name Type Required Description
ReportDocumentId String True Unique ID of the report to download.
DownloadPath String False The File path to write the report data. If no path is specified, the file is kept in memory in the FileData output.
IsRestrictedReport Boolean False Boolean indicating whether the specified report ID is a restricted report (report containing PII).

デフォルト値はfalseです。

Result Set Columns

Name Type Description
Success Boolean Boolean indicating the result of the operation.
Url String A unique identifier for the report.
FileData String The file data output, if the LocalPath input is empty.

CData Cloud

RequestReport

The RequestReport operation creates a report request.

Input

Name Type Required Description
ReportType String True Required. Indicates the report type to request.
DataStartTime Datetime False The start date of the date range used to select the data to report.By default it is the current date. If specified, it must be before the current date.
DataEndTime Datetime False End date of the date range used to select the data to report. By default it is the current date. If specified, it must be before the current date.
ReportOptions String False Additional information to pass to the report. If the report accepts ReportOptions, the information is displayed in the report description in the ReportType enumerator section.
MarketplaceIds String True Required. A list of one or more marketplace IDs for the marketplace that registered the listing account.

Result Set Columns

Name Type Description
ReportId String A unique identifier for the report.
IsRestrictedReport Boolean Boolean value indicating whether the report is restricted (report containing PII).

CData Cloud

SubmitDirectFulfillmentShippingLabel

Creates a shipping label for a purchase order and returns a `transactionId` for reference.

Input

Name Type Required Description
ShipFromAddressLine1 String True First line of the address.
ShipFromAddressLine2 String False Additional street address information, if required.
ShipFromAddressLine3 String False Additional street address information, if required.
ShipFromCity String False The city where the person, business or institution is located.
Containers String False A container used for shipping and packing items.
ShipFromCountryCode String True The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
ShipFromCounty String False The county where person, business or institution is located.
ShipFromDistrict String False The district where person, business or institution is located.
ShipFromName String True The name of the person, business or institution at that address.
ShipFromPartyId String True The identifier of the party.
ShipFromPhone String False The phone number of the person, business or institution located at that address.
ShipFromPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
PurchaseOrderNumber String True The purchase order number of the order for which to create a shipping label.
ShipFromStateOrRegion String False The state or region where person, business or institution is located.
ShipFromTaxRegistrationDetails String False Tax registration details of the entity.
SellingPartyAddressLine1 String True First line of the address.
SellingPartyAddressLine2 String False Additional street address information, if required.
SellingPartyAddressLine3 String False Additional street address information, if required.
SellingPartyCity String False The city where the person, business or institution is located.
SellingPartyCountryCode String True The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
SellingPartyCounty String False The county where person, business or institution is located.
SellingPartyDistrict String False The district where person, business or institution is located.
SellingPartyName String True The name of the person, business or institution at that address.
SellingPartyId String True The identifier of the party.
SellingPartyPhone String False The phone number of the person, business or institution located at that address.
SellingPartyPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyStateOrRegion String False The state or region where person, business or institution is located.
SellingPartyTaxRegistrationDetails String False Tax registration details of the entity.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

SubmitDirectFulfillmentShippingLabelBatch

Creates shipping labels for a purchase order and returns a `transactionId` for reference.

Input

Name Type Required Description
ShippingLabels String True Represents the request payload for creating a shipping label, containing the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

SubmitVendorOrderAcknowledgement

Submits acknowledgements for one purchase order.

Execute

The Driver Uses #TEMP tables as fields for aggregate information entered

You must include in your query information for both OrderAcknowledgement and OrderItemAcknowledgement.

First we create an OrderItemAcknowledgements temporary table for the OrderAcknowledgement number 1:

INSERT INTO itemAck1#TEMP (AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
      VALUES ('Accepted', 100, 'Cases', 10, '2022-02-02T12:00:00Z', '2022-02-10T15:00:00Z', 'TemporarilyUnavailable')
INSERT INTO itemAck1#TEMP (AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
      VALUES ('Accepted', 100, 'Cases', 20, '2022-03-02T12:00:00Z', '2022-03-10T15:00:00Z', 'InvalidProductIdentifier')
INSERT INTO itemAck1#TEMP (AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
      VALUES ('Rejected', 100, 'Cases', 30, '2022-04-02T12:00:00Z', '2022-04-10T15:00:00Z', 'ObsoleteProduct')
INSERT INTO itemAck1#TEMP (AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
      VALUES ('Rejected', 101, 'Cases', 30, '2022-04-02T12:00:00Z', '2022-04-10T15:00:00Z', 'ObsoleteProduct') 

Then we create another OrderItemAcknowledgements temporary table for the OrderAcknowledgement number 2:

INSERT INTO itemAck2#TEMP (AcknowledgementCode, AcknowledgedAmount, AcknowledgedUnit, AcknowledgedUnitSize, ScheduledShipDate, ScheduledDeliveryDate, RejectionReason)
      VALUES ('Accepted', 99, 'Cases', 9, '2022-09-09T12:00:00Z', '2022-08-8T15:00:00Z', 'ObsoleteProduct') 

After that we have to create another temporary table referencing previously created temporary tables itemAck1#TEMP and itemAck2#TEMP

INSERT INTO orderAck#TEMP (ItemSequenceNumber, AmazonProductIdentifier, VendorProductIdentifier, OrderedAmount, OrderedUnit, OrderedUnitSize, NetCostCurrencyCode, NetCostAmount, ListPriceCurrencyCode, ListPriceAmount, DiscountMultiplier, ItemAcknowledgements)
      VALUES ('seq1', 'id1', 'vendId1', 100, 'Cases', 2, 'ALL', 999, 'ALL', 999, 'discount_multiplier_123', 'itemAck1#TEMP')
      
INSERT INTO orderAck#TEMP (ItemSequenceNumber, AmazonProductIdentifier, VendorProductIdentifier, OrderedAmount, OrderedUnit, OrderedUnitSize, NetCostCurrencyCode, NetCostAmount, ListPriceCurrencyCode, ListPriceAmount, DiscountMultiplier, ItemAcknowledgements)
      VALUES ('seq2', 'id2', 'vendId2', 200, 'Cases', 4, 'ALL', 992, 'ALL', 992, 'discount_multiplier_456', 'itemAck2#TEMP')

After we have created necessary temporary tables we can execute the stored procedure, as shown in the example below:

EXECUTE SubmitVendorOrderAcknowledgement
		PurchaseOrderNumber = 'PurchaseOrderNumber1',
		SellerPartyId = '123',
		SellerTaxRegistrationType = 'VAT',
		SellerTaxRegistrationNumber = '123456',
		AcknowledgementDate = '2022-01-01T10:00:00.000',
		Items = 'orderAck#TEMP';

OrderAcknowledgement temporary table schema info:

Column NameTypeRequiredDescription
ItemSequenceNumber string false Line item sequence number for the item.
AmazonProductIdentifier string false Amazon Standard Identification Number (ASIN) of an item.
VendorProductIdentifier string false The vendor selected product identification of the item. Should be the same as was sent in the purchase order.
OrderedAmount integer true Ordered quantity. This value should not be zero.
OrderedUnit string true Unit of measure for the ordered quantity.
OrderedUnitSize integer true The case size, in the event that we ordered using cases.
NetCostCurrencyCode string false Three digit currency code in ISO 4217 format.
NetCostAmount string false A decimal number with no loss of precision.
ListPriceCurrencyCode string false Three digit currency code in ISO 4217 format.
ListPriceAmount string false A decimal number with no loss of precision.
DiscountMultiplier string false The discount multiplier that should be applied to the price if a vendor sells books with a list price.
ItemAcknowledgements string true This is used to indicate acknowledged quantity. Should be specified using a #TEMP table.

OrderItemAcknowledgement temporary table schema info:

Column NameTypeRequiredDescription
AcknowledgementCode string true This indicates the acknowledgement code.
AcknowledgedAmount integer true Ordered quantity. This value should not be zero.
AcknowledgedUnit string true Unit of measure for the ordered quantity.
AcknowledgedUnitSize integer false The case size, in the event that we ordered using cases.
ScheduledShipDate datetime false Estimated ship date per line item. Must be in ISO-8601 date/time format.
ScheduledDeliveryDate datetime false Estimated delivery date per line item. Must be in ISO-8601 date/time format.
RejectionReason string false Indicates the reason for rejection.

Input

Name Type Required Description
PurchaseOrderNumber String True The purchase order number
SellerPartyId String True Assigned identification for the party. For example, warehouse code or vendor code.
SellerTaxRegistrationNumber String False Tax registration number for the entity. For example, VAT ID.
SellerTaxRegistrationType String False Tax registration type for the entity.

使用できる値は次のとおりです。VAT, GST

SellerAddressAddressLine1 String False First line of the address.
SellerAddressAddressLine2 String False Additional address information, if required.
SellerAddressAddressLine3 String False Additional address information, if required.
SellerAddressCity String False The city where the person, business or institution is located.
SellerAddressCountryCode String False The two digit country code in ISO 3166-1 alpha-2 format.
SellerAddressCounty String False The county where person, business or institution is located.
SellerAddressDistrict String False The district where person, business or institution is located.
SellerAddressName String False The name of the address of the person, business or institution.
SellerAddressPhone String False The phone number of the person, business or institution located at that address.
SellerAddressPostalCode String False The postal code of that address. It contains a series of letters or digits or both.
SellerAddressStateOrRegion String False The state or region where person, business or institution is located.
Items String True An aggregate representation items. Can be in the form of #TEMP table.
AcknowledgementDate Datetime False The date and time when the purchase order is acknowledged, in ISO-8601 date/time format.

Result Set Columns

Name Type Description
Success String
TransactionId String

CData Cloud

SubmitVendorPayments

Submit new invoices to Amazon Marketplace for a vendor's direct fulfillment orders.

Execute

This stored procedure has a few Aggregate inputs which can be specified as either JSON, XML or #TEMP tables. In the following example we are going to use temp tables as demonstration.

First, we are going to create temp tables shipAddr, tax and invoiceItems according to Address, TaxDetails and InvoiceItem table schemas respectively.

INSERT INTO shipAddr#TEMP (  Name,     AddressLine1,          City,           County, CountryCode)
                  VALUES ('Name', 'Fayettville NC', 'Fayettville', 'North Carolina',        'NC');

INSERT INTO tax#TEMP (TaxRate,   Type, TaxAmount, TaxCurrencyCode)
             VALUES ( '1.51', 'CGST',    '1.51',           'EUR');

INSERT INTO invoiceItems#TEMP (ItemSequenceNumber, ItemSequenceNumber, AmazonProductIdentifier, PurchaseOrderNumber, InvoicedQuantityAmount, InvoicedQuantityUnit, NetCostAmount, NetCostCurrencyCode)
                      VALUES (             '111',              '222',                   '333',               '444',                     10,              'Cases',          '97',               'EUR');

After the necessary temporary table have been created, execute the stored procedure by providing the temp table name for aggregate inputs, as shown in the example below:

EXECUTE SubmitVendorPayments
        Id                 = '123',
        InvoiceType        = 'Invoice',
        Date               = '2022',
        TotalAmount        = '100',
        TotalCurrencyCode  = 'EUR',
        RemitToPartyId     = '456',
        ShipToPartyId      = '789',
        ShipToPartyAddress = 'shipAddr#TEMP',
        TaxDetails         = 'tax#TEMP',
        Items              = 'invoiceItems#TEMP';

*The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

InvoiceItem temporary table schema info:

Column Name Type Required Description
ItemSequenceNumber Integer True Unique number related to this line item.
AmazonProductIdentifier String False Amazon Standard Identification Number (ASIN) of an item.
VendorProductIdentifier String False The vendor selected product identifier of the item. Should be the same as was provided in the purchase order.
PurchaseOrderNumber String False The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when invoiceType is Invoice.
HsnCode String False HSN Tax code. The HSN number cannot contain alphabets.
InvoicedQuantityAmount Integer True Quantity of an item. This value should not be zero.
InvoicedQuantityUnit String True Unit of measure for the quantity. Allowed values are:
  • Cases: Packing of individual items into a case.
  • Eaches: Individual items.
InvoicedQuantityUnitSize Integer False The case size, if the unit of measure value is Cases.
NetCostAmount String True A decimal number with no loss of precision.
NetCostCurrencyCode String True Three-digit currency code in ISO 4217 format.
CreditNoteReferenceInvoiceNumber String False Original Invoice Number when sending a credit note relating to an existing invoice. One Invoice only to be processed per Credit Note. This is mandatory for AP Credit Notes.
CreditNoteDebitNoteNumber String False Debit Note Number as generated by Amazon. Recommended for Returns and COOP Credit Notes.
CreditNoteReturnsReferenceNumber String False Identifies the Returns Notice Number. Mandatory for all Returns Credit Notes.
CreditNoteGoodsReturnDate Datetime False Defines a date and time according to ISO8601.
CreditNoteRmaId String False Identifies the Returned Merchandise Authorization ID, if generated.
CreditNoteCoopReferenceNumber String False Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the Debit Note number may lead to a rejection of the Credit Note.
CreditNoteConsignorsReferenceNumber String False Identifies the consignor reference number (VRET number), if generated by Amazon.
TaxDetails Aggregate False Individual tax details per line item.
ChargeDetails Aggregate False Individual charge details per line item.
AllowanceDetails Aggregate False Individual allowance details per line item.

TaxDetails temporary table schema info:

Column Name Type RequiredDescription
Type String True Type of the tax applied. Allowed values are:
  • CGST: Central Goods and Services Tax (CGST) is levied by the Indian government for intrastate movement of goods and services.
  • SGST: State Goods and Services Tax (SGST) is an indirect tax levied and collected by a State Government in India on the intra-state supplies.
  • CESS: A CESS is a form of tax levied by the government on tax with specific purposes till the time the government gets enough money for that purpose.
  • UTGST: Union Territory Goods and Services Tax in India.
  • IGST: Integrated Goods and Services Tax (IGST) is a tax levied on all Inter-State supplies of goods and/or services in India.
  • MwSt.: Mehrwertsteuer, MwSt, is German for value-added tax.
  • PST: A provincial sales tax (PST) is imposed on consumers of goods and particular services in many Canadian provinces.
  • TVA: Taxe sur la Valeur Ajoutee (TVA) is French for value-added tax.
  • VAT: Value-added tax.
  • GST: Tax levied on most goods and services sold for domestic consumption.
  • ST: Sales tax.
  • Consumption: Tax levied on consumption spending on goods and services.
  • MutuallyDefined: Tax component that was mutually agreed upon between Amazon and vendor.
  • DomesticVAT: Domestic value-added tax.
TaxRate String False A decimal number with no loss of precision.
TaxAmount String True A decimal number with no loss of precision.
TaxCurrencyCode String True Three-digit currency code in ISO 4217 format.
TaxableAmount String False A decimal number with no loss of precision.
TaxableCurrencyCode String False Three-digit currency code in ISO 4217 format.

TaxRegistration temporary table schema info:

Column Name Type RequiredDescription
RegistrationType String True The tax registration type for the entity. Allowed values are:
  • VAT: Value-added tax.
  • GST: Goods and services tax.
RegistrationNumber String True The tax registration number for the entity. For example, VAT ID.

ChargeDetails temporary table schema info:

Column Name Type RequiredDescription
Type String True Type of the charge applied. Allowed values are:
  • Freight: Freight charges.
  • Packing: Packing fee.
  • Duty: Duty charges.
  • Service: Service fee.
  • SmallOrder: Small order fee.
  • InsurancePlacementCost: Insurance placement cost.
  • InsuranceFee: Insurance fee.
  • SpecialHandlingService: Special handling service fee.
  • CollectionAndRecyclingService: Collection and recycling service fee.
  • EnvironmentalProtectionService: Environmental protection service fee.
  • TaxCollectedAtSource: Tax collected at source.
Description String FalseDescription of the charge.
ChargeAmount String True A decimal number with no loss of precision.
ChargeCurrencyCode String True Three-digit currency code in ISO 4217 format.
TaxDetails Aggregate FalseTax amount details applied on this charge. See: TaxDetails table schema.

AllowanceDetails temporary table schema info:

Column Name Type RequiredDescription
Type String True Type of the allowance applied. Allowed values are:
  • Discount: Discount allowance.
  • DiscountIncentive: Discount incentive allowance.
  • Defective: Allowance applied for defective item.
  • Promotional: Promotional allowance.
  • UnsaleableMerchandise: Allowance applied due to unsaleable merchandise.
  • Special: Special allowances.
Description String False Description of the allowance.
AllowanceAmount String True A decimal number with no loss of precision.
AllowanceCurrencyCode String True Three-digit currency code in ISO 4217 format.
TaxDetails Aggregate False Tax amount details applied on this allowance. See: TaxDetails table schema.

AdditionalDetails temporary table schema info:

Column NameType RequiredDescription
Type String True The type of the additional information provided by the selling party. Allowed values are:
  • SUR: An additional tax on something already taxed, such as a higher rate of tax on incomes above a certain level.
  • OCR: OCR.
  • CartonCount: The total number of cartons invoiced.
Detail String True The detail of the additional information provided by the selling party.
LanguageCode String False The language code of the additional information detail.

Address temporary table schema info:

Column NameType RequiredDescription
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.

Input

Name Type Required Description
InvoiceNumber String True The unique invoice number.
ReferenceNumber String False An additional unique reference number used for regulatory or other purposes.
Date Datetime True Defines a date and time according to ISO8601.
TotalAmount String True A decimal number with no loss of precision.
TotalCurrencyCode String True Three-digit currency code in ISO 4217 format.
PaymentTermsCode String False The payment terms for the invoice.
RemitToPartyId String True Assigned identification for the party.
RemitToPartyAddress String False A physical address.
RemitToPartyTaxDetails String False Tax registration details of the party.
ShipToCountryCode String False Ship-to country code.
ShipFromPartyId String False Assigned identification for the party.
ShipFromPartyAddress String False A physical address.
ShipFromPartyTaxDetails String False Tax registration details of the party.
BillToPartyId String False Assigned identification for the party.
BillToPartyAddress String False A physical address.
BillToPartyTaxDetails String False Tax registration details of the party.
TaxTotals String False Total tax amount details for all line items.
AdditionalDetails String False Additional details provided by the selling party, for tax related or other purposes.
ChargeDetails String False Total charge amount details for all line items.
Items String False The list of invoice items.

Result Set Columns

Name Type Description
Success String
TransactionId String

CData Cloud

SubmitVendorShipmentConfirmations

Submits shipment confirmations for vendor orders.

Execute

The Driver uses #TEMP tables as fields for aggregate information entered.

Below is an example where the usage of all #TEMP tables is covered. The following stored procedure inputs take a temp table: SellingPartyAddress, ShipFromPartyAddress, ShipToPartyAddress, ShippedItems, Cartons, and Pallets. Furthermore, the Cartons and Pallets temp table schemas, have the following inputs that also take temp tables: CartonIdentifiers/PalletIdentifiers and Items.

First, create a ShipFromPartyAddress temporary table for the ShipFromPartyAddress input:

INSERT INTO ShipFromPartyAddress#TEMP (Name, AddressLine1, City, CountryCode) VALUES ('ABC electronics warehouse', 'DEF 1st street', 'Berlin', 'DE')

Then, create a ShippedItems temporary table for the ShippedItems input:

INSERT INTO ShippedItems#TEMP (ItemSequenceNumber, VendorProductIdentifier, ShippedQuantityAmount, ShippedQuantityUnit) VALUES ('001', '9782700001659', 100, 'Eaches')

The Cartons input has a more complex structure. Two of its inputs, CartonIdentifiers and Items need to be built from the CartonIdentifiers#TEMP and CartonItems#TEMP tables respectively:

INSERT INTO CartonIdentifiers#TEMP (ContainerIdentificationType, ContainerIdentificationNumber) VALUES ('SSCC', '00102234567123698888')
INSERT INTO CartonItems#TEMP (ItemReference, ShippedQuantityAmount, ShippedQuantityUnit, ShippedQuantityUnitSize) VALUES ('001', 25, 'Eaches', 1)
INSERT INTO Cartons#TEMP (CartonIdentifiers, CartonSequenceNumber, Items) VALUES ('CartonIdentifiers#TEMP', '001', 'CartonItems#TEMP')

Then, add another row to the Cartons input:

INSERT INTO CartonIdentifiers2#TEMP (ContainerIdentificationType, ContainerIdentificationNumber) VALUES ('SSCC', '00102234567123699999')
INSERT INTO CartonItems2#TEMP (ItemReference, ShippedQuantityAmount, ShippedQuantityUnit, ShippedQuantityUnitSize) VALUES ('002', 50, 'Eaches', 1)
INSERT INTO Cartons#TEMP (CartonIdentifiers, CartonSequenceNumber, Items) VALUES ('CartonIdentifiers2#TEMP', '002', 'CartonItems2#TEMP')

The Pallets input has a similar structure compared to the Cartons one:

INSERT INTO PalletIdentifiers#TEMP (ContainerIdentificationType, ContainerIdentificationNumber) VALUES ('SSCC', '00102234567898098745')
INSERT INTO Pallets#TEMP (PalletIdentifiers, Tier, Block, CartonCount, CartonReferenceNumbers) VALUES ('PalletIdentifiers#TEMP', 2, 2, 4, '001,002,003,004')

After the necessary temporary tables have been created, execute the stored procedure as shown in the example below:

EXECUTE SubmitVendorShipmentConfirmations
		ShipmentIdentifier = '00050003',
		ShipmentConfirmationType = 'Original',
		ShipmentType = 'LessThanTruckLoad',
		ShipmentConfirmationDate = '2022-08-07T19:56:45.632Z',
		SellingPartyId = 'VENDORCODE',
		ShipFromPartyId = 'VENDORWAREHOUSECODE',
		ShipFromPartyAddress = 'ShipFromPartyAddress#TEMP',
		ShipToPartyId = 'AMZWAREHOUSECODE',
		ShippedItems = 'ShippedItems#TEMP',
		Cartons = 'Cartons#TEMP',
		Pallets = 'Pallets#TEMP';

SellingPartyAddress temporary table schema info:

Column NameTypeRequiredDescription
Name String TrueThe seller's name.
AddressLine1 String TrueThe first line of the selling party's address.
AddressLine2 String FalseAdditional address information (if it is required).
AddressLine3 String FalseAdditional address information (if it is required).
City String FalseThe city where the selling party is located.
County String FalseThe county where the selling party is located.
District String FalseThe district where the selling party is located.
StateOrRegion String FalseThe state or region where the selling party is located.
PostalCode String FalseThe postal code for the address. This code consists of a series of letters, digits, or both.
PostalOrZipCode String FalseThe postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
CountryCode String FalseThe two-digit country code in ISO 3166-1 alpha-2 format.
Phone String FalseThe phone number for the selling party that is located at that address.

ShipFromPartyAddress temporary table schema info:

Column NameTypeRequiredDescription
Name String TrueThe shipper's name.
AddressLine1 String TrueThe first line of the shipper's address.
AddressLine2 String FalseAdditional address information (if it is required).
AddressLine3 String FalseAdditional address information (if it is required).
City String FalseThe city where the shipper is located.
County String FalseThe county where the shipper is located.
District String FalseThe district where the shipper is located.
StateOrRegion String FalseThe state or region where the shipper party is located.
PostalCode String FalseThe postal code for the shipper's address. This code consists of a series of letters, digits, or both.
PostalOrZipCode String FalseThe postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
CountryCode String FalseThe two-digit country code in ISO 3166-1 alpha-2 format.
Phone String FalseThe shipper's phone number.

ShipToPartyAddress temporary table schema info:

Column NameTypeRequiredDescription
Name String TrueThe ship-to party's name.
AddressLine1 String TrueThe first line of the ship-to party's address.
AddressLine2 String FalseAdditional address information (if it is required).
AddressLine3 String FalseAdditional address information (if it is required).
City String FalseThe city where the ship-to party is located.
County String FalseThe county where the ship-to party is located.
District String FalseThe district where the ship-to party is located.
StateOrRegion String FalseThe state or region where the ship-to party is located.
PostalCode String FalseThe postal code for the ship-to address. This code consists of a series of letters, digits, or both.
PostalOrZipCode String FalseThe postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
CountryCode String FalseThe two-digit country code in ISO 3166-1 alpha-2 format.
Phone String FalseThe phone number for the ship-to party that is located at that address.

ShippedItems temporary table schema info:

Column NameTypeRequiredDescription
ItemSequenceNumber String TrueThe line-item sequence number for the item.
AmazonProductIdentifier String FalseThe Amazon Standard Identification Number (ASIN) of an item.
VendorProductIdentifier String FalseThe vendor-selected product identification of the item.
ShippedQuantityAmount Integer TrueThe shipped quantity. This value should not be zero.
ShippedQuantityUnit String TrueThe unit of measure for the shipped quantity.
ShippedQuantityUnitSize Integer FalseThe unit size for the shipped quantity.
PurchaseOrderNumber String FalseThe Amazon purchase order (PO) number for the shipped item that is being confirmed. The PO number should be formatted as an eight-character, alphanumeric code.
LotNumber String FalseThe lot number of the shipped quantity.
ExpiryManufacturerDate Datetime FalseThe production, packaging, or assembly date that is determined by the manufacturer. This date's meaning is determined based on the trade-item context.
ExpiryDate Datetime FalseThe date that determines the limit of consumption or use of a product. This date's meaning is determined based on the trade item context.
ExpiryAfterDurationUnit Datetime FalseThe unit for the duration after the manufacturing date during which the product is valid for consumption.
ExpiryAfterDurationValue Integer FalseThe value for the duration in terms of the duration unit.
MaximumRetailPriceCurrencyCode String FalseThe three-digit currency code, in ISO 4217 format, for the maximum retail prices.
MaximumRetailPriceAmount String FalseThe maximum retail price for the shipped items as a decimal number with no loss of precision.
HandlingCode String FalseThe code that identifies the instructions about how the specified item, carton, or pallet should be handled.

Cartons temporary table schema info:

Column NameTypeRequiredDescription
CartonIdentifiers String FalseA list of carton identifiers.
CartonSequenceNumber String TrueThe sequence number for the carton. The first carton is numbered 001, the second 002, and so on. This number is used as a reference to refer to the carton from the pallet level.
DimensionsLength String FalseThe length of the container.
DimensionsWidth String FalseThe width of the container.
DimensionsHeight String FalseThe height of the container.
DimensionsUnit String FalseThe unit of measure for dimensions (In, Ft, Meter, Yard).
WeightValue String FalseThe weight measurement value for the container as a decimal number with no loss of precision.
WeightUnit String FalseThe unit of measure for the weight of the container.
TrackingNumber String FalseThe tracking number for the container. This number is required for every carton in the small-parcel shipments.
Items String TrueA list of container item details.

Cartons/CartonIdentifiers temporary table schema info:

Column NameTypeRequiredDescription
ContainerIdentificationType String TrueThe container identification type.
ContainerIdentificationNumber String TrueThe container identification number that adheres to the definition of the container identification type.

Cartons/CartonsItems temporary table schema info:

Column NameTypeRequiredDescription
ItemReference String TrueThe reference number for the item. Be sure to provide the item sequence number from the items segment to refer to that item's details here.
ShippedQuantityAmount Integer TrueThe number of units that are shipped for a specific item at a shipment level. If the item is present only in certain cartons within the shipment, provide this at the appropriate carton level.
ShippedQuantityUnit String TrueThe unit of measure for the shipped quantity.
ShippedQuantityUnitSize Integer FalseThe case size (if product is ordered by the case). Otherwise, the value is 1.
PurchaseOrderNumber String FalseThe Amazon purchase order (PO) number for the shipment that is being confirmed. If the items in this shipment belong to multiple PO numbers that are in particular carton within the shipment, then provide the PO number at the carton level. The PO numbers should be formatted as an eight-character, alphanumeric code.
LotNumber String FalseThe batch or lot number for the cartons. This number associates cartons with information that the manufacturer considers relevant for traceability of the cartons to which the element string is applied. The data might refer to the itself or to items within the carton. This field is mandatory for all perishable items.
ExpiryManufacturerDate Datetime FalseThe production, packaging, or assembly date that is determined by the manufacturer. This date's meaning is determined based on the trade-item context.
ExpiryDate Datetime FalseThe date that determines the limit of consumption or use of a product. This date's meaning is determined based on the trade item context.
ExpiryAfterDurationUnit String FalseThe unit for the duration after the manufacturing date during which the product is valid for consumption.
ExpiryAfterDurationValue Integer FalseThe value for the duration in terms of the duration unit.
MaximumRetailPriceCurrencyCode String FalseThe three-digit currency code, in ISO 4217 format, for the maximum retail prices.
MaximumRetailPriceAmount String FalseThe maximum retail price for the shipped items as a decimal number with no loss of precision.
HandlingCode String FalseA code that identifies the instructions about how the specified carton should be handled.

Pallets temporary table schema info:

Column NameTypeRequiredDescription
PalletIdentifiers String TrueA list of pallet identifiers.
Tier Integer FalseThe number of layers per pallet.
Block Integer FalseThe number of cartons per layer on the pallet.
DimensionsLength String FalseThe length of the pallet.
DimensionsWidth String FalseThe width of the pallet.
DimensionsHeight String FalseThe height of the pallet.
DimensionsUnit String FalseThe unit of measure for the dimensions of the pallet.
WeightValue String FalseThe weight measurement value for pallet as a decimal number with no loss of precision.
WeightUnit String FalseThe unit of measure for the weight of the pallet.
CartonCount Integer FalseThe number of cartons that are present in the shipment. Provide the carton count only for unpalletized shipments.
CartonReferenceNumbers String FalseAn array of reference numbers for the cartons that are part of this pallet and shipment. Provide the carton sequence number from the cartons segment to refer to that carton's details here.
Items String FalseA list of pallet item details.

Pallets/PalletIdentifiers temporary table schema info:

Column NameTypeRequiredDescription
ContainerIdenticationType String TrueThe container identification type. Allowed values are SSCC, AMZNCC, GTIN, BPS, and CID.
ContainerIdentificationNumber String TrueContainer identification number that adheres to the definition of the container identification type.

Pallets/PalletsItems temporary table schema info:

Column NameTypeRequiredDescription
ItemReference String TrueThe reference number for the item. Provide the item sequence number from the items segment to refer to that item's details here.
ShippedQuantityAmount Integer TrueThe number of units that are shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, provide this at the appropriate carton or pallet level.
ShippedQuantityUnit String TrueThe unit of measure for the shipped quantity.
ShippedQuantityUnitSize Integer FalseThe case size (if product is ordered by the case). Otherwise, the value is 1.
PurchaseOrderNumber String FalseThe Amazon purchase order (PO) number for the shipment that is being confirmed. If the items in this shipment belong to multiple PO numbers that are in particular pallet within the shipment, then provide the PO number at the pallet level. The PO numbers should be formatted as an eight-character, alphanumeric code.
LotNumber String FalseThe batch or lot number for the pallet. This number associates a pallet with information that the manufacturer considers relevant for traceability of the pallet to which the element string is applied. The data might refer to the pallet itself or to items within the pallet. This field is mandatory for all perishable items.
ExpiryManufacturerDate Datetime FalseThe production, packaging, or assembly date that is determined by the manufacturer. This date's meaning is determined based on the trade-item context.
ExpiryDate Datetime FalseThe date that determines the limit of consumption or use of a product. This date's meaning is determined based on the trade item context.
ExpiryAfterDurationUnit String FalseThe unit for the duration after the manufacturing date during which the product is valid for consumption.
ExpiryAfterDurationValue Integer FalseThe value for the duration in terms of the duration unit.
MaximumRetailPriceCurrencyCode String FalseThe three-digit currency code, in ISO 4217 format, for the maximum retail prices.
MaximumRetailPriceAmount String FalseThe maximum retail price for the shipped items as a decimal number with no loss of precision.
HandlingCode String FalseA code that identifies the instructions about how the specified pallet should be handled.

Input

Name Type Required Description
ShipmentIdentifier String True The unique shipment ID.
ShipmentConfirmationType String True The shipment confirmation type. This parameter indicates whether this shipment confirmation is the initial confirmation or whether it is intended to replace a shipment confirmation that is already posted.

使用できる値は次のとおりです。Original, Replace

ShipmentType String False The type of shipment.

使用できる値は次のとおりです。TruckLoad, LessThanTruckLoad, SmallParcel

ShipmentStructure String False The shipment hierarchical structure.

使用できる値は次のとおりです。PalletizedAssortmentCase, LooseAssortmentCase, PalletOfItems, PalletizedStandardCase, LooseStandardCase, MasterPallet, MasterCase

TransportationDetailsCarrierScac String False The code that identifies the carrier for the shipment.
TransportationDetailsCarrierShipmentReferenceNumber String False A unique number that is assigned by the carrier. This field is also known as PRO number.
TransportationDetailsTransportationMode String False The mode of transportation for this shipment.

使用できる値は次のとおりです。Road, Air, Ocean

TransportationDetailsBillOfLadingNumber String False The Bill Of Lading (BOL) number. This number is the unique number that is assigned by the vendor.
AmazonReferenceNumber String False The Amazon Reference Number. This number is a unique identifier that is generated by Amazon for all Collect/WePay shipments.
ShipmentConfirmationDate Datetime True The date on which the shipment confirmation is submitted.
ShippedDate Datetime False The date and time of the departure of the shipment from the vendor’s location.
EstimatedDeliveryDate Datetime False The date and time by which the shipment is expected to reach the buyer’s warehouse.
SellingPartyId String True The assigned identification for the selling party.
SellingPartyAddress String False An aggregate representation of the address, which can be in the form of a #TEMP table.
SellingPartyTaxRegistrationType String False The tax registration type for the entity.

使用できる値は次のとおりです。VAT, GST

SellingPartyTaxRegistrationNumber String False The tax registration number for the entity (for example, the VAT Id).
ShipFromPartyId String True The assigned identification for the ship-from party.
ShipFromPartyAddress String False The identification of the shipper, by address. This is an aggregate representation of the address, which can be in the form of a #TEMP table.
ShipFromPartyTaxRegistrationType String False The tax registration type for the entity.

使用できる値は次のとおりです。VAT, GST

ShipFromPartyTaxRegistrationNumber String False The tax registration number for the entity (for example, the VAT Id).
ShipToPartyId String True The assigned identification for the ship-to party.
ShipToPartyAddress String False The identification of the ship-to party, by address. This is an aggregate representation of the address, which can be in the form of a #TEMP table.
ShipToPartyTaxRegistrationType String False The tax registration type for the ship-to party.

使用できる値は次のとおりです。VAT, GST

ShipToPartyTaxRegistrationNumber String False The tax registration number for the ship-to party (for example, the VAT Id).
ShipmentMeasurements String False The JSON aggregate representation of the shipment measurement details.
ImportDetails String False The JSON aggregate representation of the import details.
ShippedItems String True An aggregate representation of the items in this shipment, which can be in the form of a #TEMP table.
Cartons String False An aggregate representation of the cartons in this shipment, which can be in the form of a #TEMP table.
Pallets String False An aggregate representation of the pallets in this shipment, which can be in the form of a #TEMP table.

Result Set Columns

Name Type Description
Success String Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID to identify this transaction. This value can be used with the CheckVendorTransactionStatus stored procedure to return the status of this transaction.

CData Cloud

UpdateDirectFulfillmentInventory

Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.

Input

Name Type Required Description
IsFullUpdate Boolean True When true, this request contains a full feed. Otherwise, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an update to inventory. The status of other items will remain unchanged.
ItemDetails String True Updated inventory details for an item.
SellingPartyId String True Assigned identification for the party.
WarehouseId String True Identifier for the warehouse for which to update inventory.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

UpdateDirectFulfillmentShipmentStatus

This operation is only to be used by Vendor-Own-Carrier (VOC) vendors to update a shipment status.

Input

Name Type Required Description
ShipFromAddressLine1 String False First line of the address.
ShipFromAddressLine2 String False Additional street address information, if required.
ShipFromAddressLine3 String False Additional street address information, if required.
ShipFromCity String False The city where the person, business or institution is located.
ShipFromCountryCode String False The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
ShipFromCounty String False The county where person, business or institution is located.
ShipFromDistrict String False The district where person, business or institution is located.
ShipFromName String False The name of the person, business or institution at that address.
ShipFromPhone String False The phone number of the person, business or institution located at that address.
ShipFromPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
ShipFromStateOrRegion String False The state or region where person, business or institution is located.
ApptWindowEndDateTime Datetime False The date and time at the end of the appointment window when the shipment is expected to be delivered. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
ApptWindowStartDateTime Datetime False The date and time at the start of the appointment window when the shipment is expected to be delivered. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
EstimatedDeliveryDateTime Datetime False Date on which the shipment is expected to reach the customer delivery location. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
ShipFromPartyId String False The identifier of the party.
PurchaseOrderNumber String False Purchase order number of the shipment for which to update the shipment status.
ReasonCode String False Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
StatusCode String False Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
StatusDateTime Datetime False The date and time when the shipment status was updated. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
ShipFromTaxRegistrationDetails String False Tax registration details of the entity.
TrackingNumber String False The shipment tracking number is required for every package and should match the `trackingNumber` sent for the shipment confirmation.
SellingPartyAddressLine1 String False First line of the address.
SellingPartyAddressLine2 String False Additional street address information, if required.
SellingPartyAddressLine3 String False Additional street address information, if required.
SellingPartyCity String False The city where the person, business or institution is located.
SellingPartyCountryCode String False The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
SellingPartyCounty String False The county where person, business or institution is located.
SellingPartyDistrict String False The district where person, business or institution is located.
SellingPartyName String False The name of the person, business or institution at that address.
SellingPartyId String False The identifier of the party.
SellingPartyPhone String False The phone number of the person, business or institution located at that address.
SellingPartyPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
SellingPartyStateOrRegion String False The state or region where person, business or institution is located.
StatusLocationAddressLine1 String False First line of the address.
StatusLocationAddressLine2 String False Additional street address information, if required.
StatusLocationAddressLine3 String False Additional street address information, if required.
StatusLocationCity String False The city where the person, business or institution is located.
StatusLocationCountryCode String False The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
StatusLocationCounty String False The county where person, business or institution is located.
StatusLocationDistrict String False The district where person, business or institution is located.
StatusLocationName String False The name of the person, business or institution at that address.
StatusLocationPhone String False The phone number of the person, business or institution located at that address.
StatusLocationPostalCode String False The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
StatusLocationStateOrRegion String False The state or region where person, business or institution is located.
SellingPartyTaxRegistrationDetails String False Tax registration details of the entity.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

UpdateDirectFulfillmentShipmentStatusBatch

This operation is only to be used by Vendor-Own-Carrier (VOC) vendors to update multiple shipment statuses in the same operation execution.

Input

Name Type Required Description
ShipmentStatuses String True Represents an update to the status of a shipment.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating whether the stored procedure was successfully executed.
TransactionId String GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Amazon Marketplace のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Orders テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Orders' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、SampleProcedure ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのAmazon Marketplace プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Orders テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Orders' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
SchemaThe type of schema to use.
MarketplaceThe Marketplace region that you are registered to sell in.
AWSRoleARNThe Amazon Resource Name of the role to use when authenticating.
AppIdApplication Id for Selling Partner app you created.
AWSSessionTokenAWS Session Token for Selling Partner app you created.
AWSAccessKeyYour AWS access key.
AWSSecretKeyYour AWS secret key.
IncludeRestrictedDataDetermines if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).
UseSandboxA boolean determining if the connection should be made to the Selling Partner sandbox account.
AWSRegionAmazon Web サービスのホスティングリージョン。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
OAuthAppStatusSpecifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
IncludeReportsSet 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 を含まないクエリで返される最大行数を指定します。
ProcedurePoolingWhether or not to get feed results after an execution of a stored procedure.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ReportTypesSet this connection property to one or more report types to filter reports.
RowScanDepthThe maximum number of rows to scan to look for the columns datatype in a report.
SellerIdThe Seller ID or merchant identifier you received when creating the account.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
TypeDetectionSchemeSpecifies how to determine the data types of columns when selecting from Reports.
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを指定します。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
SchemaThe type of schema to use.
MarketplaceThe Marketplace region that you are registered to sell in.
AWSRoleARNThe Amazon Resource Name of the role to use when authenticating.
AppIdApplication Id for Selling Partner app you created.
AWSSessionTokenAWS Session Token for Selling Partner app you created.
AWSAccessKeyYour AWS access key.
AWSSecretKeyYour AWS secret key.
IncludeRestrictedDataDetermines if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).
UseSandboxA boolean determining if the connection should be made to the Selling Partner sandbox account.
AWSRegionAmazon Web サービスのホスティングリージョン。
CData Cloud

Schema

The type of schema to use.

Possible Values

SellerCentral, VendorCentral

データ型

string

デフォルト値

"SellerCentral"

解説

The available schemas are SellerCentral and VendorCentral.

CData Cloud

Marketplace

The Marketplace region that you are registered to sell in.

Possible Values

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

データ型

string

デフォルト値

"United States"

解説

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.

CData Cloud

AWSRoleARN

The Amazon Resource Name of the role to use when authenticating.

データ型

string

デフォルト値

""

解説

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

CData Cloud

AppId

Application Id for Selling Partner app you created.

データ型

string

デフォルト値

""

解説

Application Id for Selling Partner app you created.

CData Cloud

AWSSessionToken

AWS Session Token for Selling Partner app you created.

データ型

string

デフォルト値

""

解説

AWS Session Token can be obtained from AssumeRole request to AWS. AWSAccessKey and AWSSecretKey should also be provided when setting AWSSessionToken.

CData Cloud

AWSAccessKey

Your AWS access key.

データ型

string

デフォルト値

""

解説

This is the Access Key tied to the AWS user that is associated with the the OAuthClientId.

CData Cloud

AWSSecretKey

Your AWS secret key.

データ型

string

デフォルト値

""

解説

This is the Secret Key tied to the AWS user that is associated with the the OAuthClientId.

CData Cloud

IncludeRestrictedData

Determines if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).

データ型

bool

デフォルト値

false

解説

Determines if Restricted Data Tokens (RDT) should be used to retrieve Personally Identifiable Information (PII).

CData Cloud

UseSandbox

A boolean determining if the connection should be made to the Selling Partner sandbox account.

データ型

bool

デフォルト値

false

解説

A boolean determining if the connection should be made to the Selling Partner sandbox account.

CData Cloud

AWSRegion

Amazon Web サービスのホスティングリージョン。

Possible Values

OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, TAIPEI, HYDERABAD, JAKARTA, MALAYSIA, MELBOURNE, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, THAILAND, TOKYO, CENTRAL, CALGARY, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, SPAIN, STOCKHOLM, ZURICH, TELAVIV, MEXICOCENTRAL, BAHRAIN, UAE, SAOPAULO, GOVCLOUDEAST, GOVCLOUDWEST, ISOLATEDUSEAST, ISOLATEDUSEASTB, ISOLATEDUSEASTF, ISOLATEDUSSOUTHF, ISOLATEDUSWEST, ISOLATEDEUWEST

データ型

string

デフォルト値

"NORTHERNVIRGINIA"

解説

Amazon Web サービスのホスティングリージョン。利用可能な値は、OHIO、NORTHERNVIRGINIA、NORTHERNCALIFORNIA、OREGON、CAPETOWN、HONGKONG、TAIPEI、HYDERABAD、JAKARTA、MALAYSIA、MELBOURNE、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、THAILAND、TOKYO、CENTRAL、CALGARY、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、SPAIN、STOCKHOLM、ZURICH、TELAVIV、MEXICOCENTRAL、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST、ISOLATEDUSEAST、ISOLATEDUSEASTB、ISOLATEDUSEASTF、ISOLATEDUSSOUTHF、ISOLATEDUSWEST、およびISOLATEDEUWEST です。

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
OAuthAppStatusSpecifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthAppStatus

Specifies whether the specified SellingPartner OAuth App is in Draft status or Published Status.

Possible Values

Published, Draft

データ型

string

デフォルト値

"Published"

解説

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.

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

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

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
IncludeReportsSet 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 を含まないクエリで返される最大行数を指定します。
ProcedurePoolingWhether or not to get feed results after an execution of a stored procedure.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ReportTypesSet this connection property to one or more report types to filter reports.
RowScanDepthThe maximum number of rows to scan to look for the columns datatype in a report.
SellerIdThe Seller ID or merchant identifier you received when creating the account.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
TypeDetectionSchemeSpecifies how to determine the data types of columns when selecting from Reports.
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを指定します。
CData Cloud

IncludeReports

Set this connection property to true to expose already created reports as views, this property is avaible for both schemas (SellerCentral and VendorCentral).

データ型

bool

デフォルト値

false

解説

Set this connection property to true to expose already created reports as views, this property is avaible for both schemas (SellerCentral and VendorCentral).

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

ProcedurePooling

Whether or not to get feed results after an execution of a stored procedure.

データ型

bool

デフォルト値

true

解説

Set this to False if you do not want to wait to get the results of a stored procedure.

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

ReportTypes

Set this connection property to one or more report types to filter reports.

データ型

string

デフォルト値

""

解説

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.

CData Cloud

RowScanDepth

The maximum number of rows to scan to look for the columns datatype in a report.

データ型

int

デフォルト値

100

解説

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.

CData Cloud

SellerId

The Seller ID or merchant identifier you received when creating the account.

データ型

string

デフォルト値

""

解説

The Seller ID or merchant identifier you received when creating the account.

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

TypeDetectionScheme

Specifies how to determine the data types of columns when selecting from Reports.

Possible Values

None, RowScan

データ型

string

デフォルト値

"RowScan"

解説

When IncludeReports is set to True, this property specifies how to determine the data types.

NoneSetting TypeDetectionScheme to None will return all columns as the string type.
RowScanSetting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type.

CData Cloud

UseSimpleNames

テーブルとカラムに簡略名を使用するかどうかを指定します。

データ型

bool

デフォルト値

false

解説

Amazon Marketplace テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、Cloud を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をTrue に設定すると、返されるカラム名をシンプルにします。 表示されるカラム名において、アルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。

Notes:

  • 英数字以外の文字はアンダースコアに置き換えられます。
  • カラム名やテーブル名が128 文字を超える場合は、SQL Server 標準に準拠するために128文字に切り詰められます。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434