TDV Adapter for Amazon Marketplace

Build 24.0.9060

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

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

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.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060