Amazon Selling Partner API Jobs Templates

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefix in their names.

AWDInboundShipments

AWD Inbound Shipments
Parameter
<shipmentId> (optional): ID for the shipment
<shipmentStatus> (optional): Filter by boundinbound shipment status: CREATED, SHIPPED, IN_TRANSIT, RECEIVING, DELIVERED, CLOSED, CANCELLED
<initialDate> (optional): Date from which we receive data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
createdAt	timestamp	Timestamp when the shipment was created
externalReferenceId	string	Optional client-provided reference ID
orderId	string	The AWD inbound order ID that this inbound shipment belongs to
shipmentId	string	A unique shipment ID
shipmentStatus	string	Possible shipment statuses used by shipments
updatedAt	timestamp	Timestamp when the shipment was updated
carrierCodeType	string	Denotes the carrier type
carrierCodeValue	string	Value of the carrier code
destinationAddress_addressLine1	string	DestinationAddress: first line of the address text
destinationAddress_addressLine2	string	DestinationAddress: second line of the address text
destinationAddress_addressLine3	string	DestinationAddress: third line of the address text
destinationAddress_city	string	DestinationAddress: city where this address is located
destinationAddress_countryCode	string	DestinationAddress: country code where this address is located
destinationAddress_county	string	DestinationAddress: county where this address is located
destinationAddress_district	string	DestinationAddress: district where this address is located
destinationAddress_name	string	DestinationAddress: name of the person, business, or institution at this address
destinationAddress_phoneNumber	string	DestinationAddress: phone number for an available contact at this address
destinationAddress_postalCode	string	DestinationAddress: postal code where this address is located
destinationAddress_stateOrRegion	string	DestinationAddress: state or region where this address is located
originAddress_addressLine1	string	OriginAddress: first line of the address text
originAddress_addressLine2	string	OriginAddress: second line of the address text
originAddress_addressLine3	string	OriginAddress: third line of the address text
originAddress_city	string	OriginAddress: city where this address is located
originAddress_countryCode	string	OriginAddress: country code where this address is located
originAddress_county	string	OriginAddress: county where this address is located
originAddress_district	string	OriginAddress: district where this address is located
originAddress_name	string	OriginAddress: name of the person, business, or institution at this address
originAddress_phoneNumber	string	OriginAddress: phone number for an available contact at this address
originAddress_postalCode	string	OriginAddress: postal code where this address is located
originAddress_stateOrRegion	string	OriginAddress: state or region where this address is located
shipBy	timestamp	Timestamp when the shipment will be shipped
trackingId	string	Carrier-unique tracking ID for this shipment
warehouseReferenceId	string	An AWD-provided reference ID that you can use to interact with the warehouse

Example

SQL

CREATE VIEW amazon_sp_examples.example_AWDInboundShipments AS 
	SELECT * 
	FROM (
		CALL amazon_sp.AWDInboundShipments (
			preview => true
		)
	) AS x;;

AWDInventory

AWD inventory
Parameter
<details> (optional): Set to SHOW to return summaries with additional inventory details, defaults to HIDE
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
reportDate	date	Report date
sku	string	The seller or merchant SKU
totalInboundQuantity	long	Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center
totalOnhandQuantity	long	Total quantity that is present in AWD distribution centers
inventoryDetails_availableDistributableQuantity	long	Quantity that is available for downstream channel replenishment
inventoryDetails_reservedDistributableQuantity	long	Quantity that is reserved for a downstream channel replenishment order that is being prepared for shipment

Example

SQL

CREATE VIEW amazon_sp_examples.example_AWDInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.AWDInventory (
			preview => true
		)
	) AS x;;

Account

Verify if the current account is valid
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
accountId	string	This is the Amazon Shipping account id generated during the Amazon Shipping onboarding process

Example

SQL

CREATE VIEW amazon_sp_examples.example_Account AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Account ()
	) AS x

Attributes

Attributes related to an order. This includes buyer preferences
Parameter
<amazonOrderId> (required): An Amazon order identifier. This specifies the order for which a message is sent
<MarketplaceIds> (optional): A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. Max count : 1
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The identifier of the marketplace
locale	string	The buyer's language of preference, indicated with a locale-specific language tag. Examples: "en-US", "zh-CN", and "en-GB"

Example

SQL

CREATE VIEW amazon_sp_examples.example_Attributes AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Attributes (
			marketplaceIds => 'ATVPDKIKX0DER',
			amazonOrderId => '123-1234567-1234567'
		)
	) AS x

BillOfLading

Bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment
Parameter
<shipmentId> (required): A shipment identifier originally returned by the createInboundShipmentPlan operation
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
DownloadURL	string	URL to download the bill of lading for the package. Note: The URL will only be valid for 15 seconds

Example

SQL

CREATE VIEW amazon_sp_examples.example_BillOfLading AS 
	SELECT * 
	FROM (
		CALL amazon_sp.BillOfLading (
			shipmentId => 'shipmentId'
		)
	) AS x

CatalogCategories

Parent categories to which an item belongs, based on the specified ASIN or SellerSKU
Parameter
<ASIN> (optional): The Amazon Standard Identification Number (ASIN) of the item or CSV list of them
<ASIN_table> (optional): Source table having column: ASIN
<SellerSKU> (optional): Used to identify items in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit
<MarketplaceId> (optional): A marketplace identifier. Specifies the marketplace for the item
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The identifier of the marketplace
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item
ProductCategoryId	string	The identifier for the product category (or browse node)
ProductCategoryName	string	The name of the product category (or browse node)
parent	string	The parent product category

Example

SQL

CREATE VIEW amazon_sp_examples.example_CatalogCategories AS 
	SELECT * 
	FROM (
		CALL amazon_sp.CatalogCategories (
			MarketplaceId => 'ATVPDKIKX0DER',
			ASIN => 'B08SG2QJGH'
		)
	) AS x;;

CatalogItemAttributes

Retrieves details for an item in the Amazon catalog
Parameter
<asin> (required): The Amazon Standard Identification Number (ASIN) of the item
<locale> (optional): Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace
<marketplaceIds> (optional): A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces
<label> (optional): Multi-tenancy label

Attribute	Type	Description
asin	string	Amazon Standard Identification Number (ASIN) is the unique identifier for an item in the Amazon catalog
attribute	string	Attribute
currency	string	Currency
height_unit	string	Height unit
height_value	bigdecimal	Height
language_tag	string	Language tag
length_unit	string	Length unit
length_value	bigdecimal	Length
marketplace_id	string	Marketplace
source	string	Source
type	string	Type
unit	string	Unit
value	string	Value
value_with_tax	string	Value with tax
width_unit	string	Width unit
width_value	bigdecimal	Height

Example

SQL

CREATE VIEW amazon_sp_examples.example_CatalogItemAttributes AS 
	SELECT * 
	FROM (
		CALL amazon_sp.CatalogItemAttributes (
			marketplaceIds => 'A1PA6795UKMFR9',
			locale => 'nl_NL',
			asin => '1439199191'
		)
	) AS x

CatalogItems

Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.
Parameter
<identifiers> (optional): A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords
<identifiers_table> (optional): A table with a list of product identifiers (name of the column coincides with parameter: identifiersType) to search the Amazon catalog for. Note: Cannot be used with keywords
<identifiersType> (optional): Type of product identifiers to search the Amazon catalog for (ASIN, EAN, GTIN, ISBN, JAN, MINSAN, SKU, UPC). Note: Required when identifiers are provided
<sellerId> (optional): A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU
<includedData> (optional): A comma-delimited list of data sets to include in the response. Possible values: attributes,classifications,dimensions,identifiers,images,productTypes,relationships,salesRanks,summaries,vendorDetails
<brandNames> (optional): A comma-delimited list of brand names to limit the search for keywords -based queries. Note: Cannot be used with identifiers
<classificationIds> (optional): A comma-delimited list of classification identifiers to limit the search for keywords -based queries. Note: Cannot be used with identifiers
<keywords> (optional): A comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with identifiers
<keywordsLocale> (optional): The language of the keywords provided for keywords -based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers
<locale> (optional): Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace
<marketplaceIds> (optional): A comma-delimited list of Amazon marketplace identifiers for the request
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
asin	string	Amazon Standard Identification Number (ASIN) is the unique identifier for an item in the Amazon catalog
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
browseClassification_classificationId	string	Identifier of the classification (browse node identifier)
browseClassification_displayName	string	Display name for the classification
color	string	Name of the color associated with an Amazon catalog item
contributors	string	Individual contributors to the creation of an item, such as the authors or actors
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
marketplaceId	string	Amazon marketplace identifier
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	date	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

Examples

SQL

CREATE VIEW amazon_sp_examples.example_CatalogItem AS 
	SELECT * 
	FROM (
		CALL amazon_sp.CatalogItems (
			MarketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x;;

SQL

CREATE VIEW amazon_sp_examples.example_CatalogItems AS 
	SELECT * 
	FROM (
		CALL amazon_sp.CatalogItems(
			identifiers => 'B00PQY7TJA,059035342X,B0CKVC5HRC,B08T1JK2JJ',
			identifiersType => 'ASIN',
			includedData => 'attributes,dimensions,identifiers,images,productTypes,relationships,salesRanks,summaries',
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x;;

CatalogItemsSearch

Search for and return a list of Amazon catalog items and associated information
Parameter
<brandNames> (optional): A comma-delimited list of brand names to limit the search to
<classificationIds> (optional): A comma-delimited list of classification identifiers to limit the search to
<includedData> (optional): A comma-delimited list of data sets to include in the response
<keywords> (required): A comma-delimited list of words or item identifiers to search the Amazon catalog for
<keywordsLocale> (optional): The language the keywords are provided in. Defaults to the primary locale of the marketplace
<locale> (optional): Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace
<marketplaceIds> (optional): A comma-delimited list of Amazon marketplace identifiers for the request
<asin> (optional): The Amazon Standard Identification Number (ASIN) of the item
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	Amazon marketplace identifier
asin	string	Amazon Standard Identification Number (ASIN) is the unique identifier for an item in the Amazon catalog
brandName	string	Name of the brand associated with an Amazon catalog item
browseNode	string	Identifier of the browse node associated with an 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

Example

SQL

CREATE VIEW amazon_sp_examples.example_CatalogItemsSearch AS 
	SELECT * 
	FROM (
		CALL amazon_sp.CatalogItemsSearch ( 
			locale => 'de_DE', 
			keywordsLocale => NULL, 
			keywords => 'hexagonal pencil 7B', 
			includedData => 'identifiers,images,productTypes,salesRanks,summaries,variations'
		) 
	) AS e

CompetitivePricing

Competitive pricing information for a seller's offer listings based on seller SKU or ASIN
Parameter
<Asins> (optional): A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace
<Skus> (optional): A list of up to twenty seller SKU values used to identify items in the given marketplace
<asin_table> (optional): A table that has asin column
<sku_table> (optional): A table that has sku column
<CustomerType> (optional): Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer
<MarketplaceId> (optional): A marketplace identifier. Specifies the marketplace for which prices are returned
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label

Attribute	Type	Description
MarketplaceId	string	The identifier of the marketplace
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item
AttributeSets	string	A list of product attributes if they are applicable to the product that is returned. An item
CompetitivePrices_belongsToRequester	boolean	Indicates whether or not the pricing information is for an offer listing that belongs to the requester. The requester is the seller associated with the SellerId that was submitted with the request. Possible values are: true and false
CompetitivePrices_CompetitivePriceId	string	The pricing model for each price that is returned. Possible values: 1 - New Buy Box Price; 2 - Used Buy Box Price;
CompetitivePrices_condition	string	Indicates the condition of the item whose pricing information is returned. Possible values are: New, Used, Collectible, Refurbished, or Club
CompetitivePrices_offerType	string	Indicates the type of customer that the offer is valid for. When the offer type is B2C in a quantity discount, the seller is winning the Buy Box because others do not have inventory at that quantity, not because they have a quantity discount on the ASIN. Values : B2C, B2B
CompetitivePrices_Price_LandedPrice_Amount	bigdecimal	The monetary value. The value calculated by adding ListingPrice + Shipping - Points. Note that if the landed price is not returned, the listing price represents the product with the lowest landed price
CompetitivePrices_Price_LandedPrice_CurrencyCode	string	The currency code in ISO 4217 format. The value calculated by adding ListingPrice + Shipping - Points. Note that if the landed price is not returned, the listing price represents the product with the lowest landed price
CompetitivePrices_Price_ListingPrice_Amount	bigdecimal	The monetary value. The value calculated by adding ListingPrice + Shipping - Points. Note that if the landed price is not returned, the listing price represents the product with the lowest landed price
CompetitivePrices_Price_ListingPrice_CurrencyCode	string	The currency code in ISO 4217 format. The value calculated by adding ListingPrice + Shipping - Points. Note that if the landed price is not returned, the listing price represents the product with the lowest landed price
CompetitivePrices_Price_Points_PointsMonetaryValue_Amount	bigdecimal	The monetary value. The monetary value of the points
CompetitivePrices_Price_Points_PointsMonetaryValue_CurrencyCode	string	The currency code in ISO 4217 format. The monetary value of the points
CompetitivePrices_Price_Points_PointsNumber	integer	The number of points
CompetitivePrices_Price_Shipping_Amount	bigdecimal	The monetary value. The value calculated by adding ListingPrice + Shipping - Points. Note that if the landed price is not returned, the listing price represents the product with the lowest landed price
CompetitivePrices_Price_Shipping_CurrencyCode	string	The currency code in ISO 4217 format. The value calculated by adding ListingPrice + Shipping - Points. Note that if the landed price is not returned, the listing price represents the product with the lowest landed price
CompetitivePrices_quantityDiscountType	string	Indicates the type of quantity discount this price applies to. Values : QUANTITY_DISCOUNT
CompetitivePrices_quantityTier	integer	Indicates at what quantity this price becomes active
CompetitivePrices_sellerId	string	The seller identifier for the offer
CompetitivePrices_subcondition	string	Indicates the subcondition of the item whose pricing information is returned. Possible values are: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other
NumberOfOfferListings	string	The number of active offer listings for the item that was submitted. The listing count is returned by condition, one for each listing condition value that is returned
Offers	string	A list of offers. An item
Relationships	string	A list that contains product variation information, if applicable. An item
SalesRankings	string	A list of sales rank information for the item, by category. An item
SellerSKU	string	The seller stock keeping unit (SKU) of the item
status	string	The status of the operation
TradeInValue_Amount	bigdecimal	The monetary value. The trade-in value of the item in the trade-in program
TradeInValue_CurrencyCode	string	The currency code in ISO 4217 format. The trade-in value of the item in the trade-in program

Example

SQL

CREATE VIEW amazon_sp_examples.example_CompetitivePricing AS 
	SELECT * 
	FROM (
		CALL amazon_sp.CompetitivePricing (
			Skus => NULL,
			MarketplaceId => 'A1PA6795UKMFR9',
			CustomerType => 'Business',
			Asins => 'B07TWSDZ76,B07V59XY8K,B07V591PL4,B07V6M4S3M,B07V7ZTVYG,B07VCG6Q68,B07Y88WBT9,B089QK1CHR,B089VYGQ2R,B089W8DB5P'
		)
	) AS x

ContentDocumentAsinRelations

ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document
Parameter
<asinSet> (optional): The set of ASINs
<contentReferenceKey> (required): The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier
<includedDataSet> (optional): The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata. Min count : 0
<marketplaceId> (optional): The identifier for the marketplace where the A+ Content is published
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The identifier of the marketplace
ASIN	string	The Amazon Standard Identification Number (ASIN)
title	string	The title for the ASIN in the Amazon catalog
badgeSet	string	The set of ASIN badges
contentReferenceKeySet	string	A set of content reference keys
imageUrl	string	The default image for the ASIN in the Amazon catalog
parent	string	The Amazon Standard Identification Number (ASIN)

Example

SQL

CREATE VIEW amazon_sp_examples.example_ContentDocumentAsinRelations AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ContentDocumentAsinRelations (
			marketplaceId => 'ATVPDKIKX0DER',
			includedDataSet => 'METADATA',
			contentReferenceKey => '84d1ece7-1f96-4a48-9e03-bcd6752168c2',
			asinSet => 'B08SG2QJGH'
		)
	) AS x

ContentDocuments

A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents
Parameter
<marketplaceId> (optional): The identifier for the marketplace where the A+ Content is published
<contentReferenceKey> (optional): The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
MarketplaceId	string	The identifier for the marketplace where the A+ Content is published
contentReferenceKey	string	The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier
contentMetadata_badgeSet	string	The set of content badges
contentMetadata_marketplaceId	string	The identifier for the marketplace where the A+ Content is published
contentMetadata_name	string	The A+ Content document name
contentMetadata_status	string	The submission status of the content document
contentMetadata_updateTime	timestamp	The approximate age of the A+ Content document and metadata

Example

SQL

CREATE VIEW amazon_sp_examples.example_ContentDocuments AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ContentDocuments (
			marketplaceId => 'ATVPDKIKX0DER'
		)
	) AS x

ContentPublishRecords

A+ Content publishing records, if available
Parameter
<asin> (required): The Amazon Standard Identification Number (ASIN)
<marketplaceId> (optional): The identifier for the marketplace where the A+ Content is published
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The identifier for the marketplace where the A+ Content is published
contentReferenceKey	string	A unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ content identifier
ASIN	string	The Amazon Standard Identification Number (ASIN)
contentSubType	string	The A+ Content document subtype. This represents a special-purpose type of an A+ Content document. Not every A+ Content document type will have a subtype, and subtypes may change at any time
contentType	string	The A+ Content document type
locale	string	The IETF language tag. This only supports the primary language subtag with one secondary language subtag. The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary subtags.

Example

SQL

CREATE VIEW amazon_sp_examples.example_ContentPublishRecords AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ContentPublishRecords (
			marketplaceId => 'ATVPDKIKX0DER',
			asin => 'B08SG2QJGH'
		)
	) AS x

DefinitionsProductTypeDetails

Retrieve an Amazon product type definition
Parameter
<locale> (optional): Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request
<marketplaceIds> (optional): A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time
<productType> (optional): The Amazon product type name
<productTypeVersion> (optional): The version of the Amazon product type to retrieve. Defaults to "LATEST",. Prerelease versions of product type definitions may be retrieved with "RELEASE_CANDIDATE". If no prerelease version is currently available, the "LATEST" live version will be provided
<requirements> (optional): The name of the requirements set to retrieve requirements for
<requirementsEnforced> (optional): Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates)
<sellerId> (optional): A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceIds	string	Amazon marketplace identifiers for which the product type definition is applicable
productType	string	The name of the Amazon product type that this product type definition applies to
propertyGroup	string
title	string	The display label of the property group
description	string	The description of the property group
propertyNames	string	The names of the schema properties for the property group
locale	string	Locale of the display elements contained in the product type definition
metaSchema_checksum	string	Checksum hash of the schema (Base64 MD5). Can be used to verify schema contents, identify changes between schema versions, and for caching
metaSchema_link_resource	string	URI resource for the link
metaSchema_link_verb	string	HTTP method for the link operation
productTypeVersion_latest	boolean	When true, the version indicated by the version identifier is the latest available for the Amazon product type
productTypeVersion_releaseCandidate	boolean	When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type
productTypeVersion_version	string	Version identifier
requirements	string	Name of the requirements set represented in this product type definition
requirementsEnforced	string	Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all of the required attributes being present (such as for partial updates)
schema_checksum	string	Checksum hash of the schema (Base64 MD5). Can be used to verify schema contents, identify changes between schema versions, and for caching
schema_link_resource	string	URI resource for the link
schema_link_verb	string	HTTP method for the link operation

Example

SQL

CREATE VIEW amazon_sp_examples.example_DefinitionsProductTypeDetails AS 
	SELECT * 
	FROM (
		CALL amazon_sp.DefinitionsProductTypeDetails (
			sellerId => 'A3088BAKABQE8B',
			requirementsEnforced => 'ENFORCED',
			requirements => 'LISTING',
			productTypeVersion => 'LATEST',
			productType => 'BATTERY',
			marketplaceIds => 'A1PA6795UKMFR9',
			locale => 'DEFAULT'
		)
	) AS x

DefinitionsProductTypes

Search for and return a list of Amazon product types that have definitions available
Parameter
<keywords> (optional): A comma-delimited list of keywords to search product types by
<marketplaceIds> (optional): A comma-delimited list of Amazon marketplace identifiers for the request
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceIds	string	The Amazon marketplace identifiers for which the product type definition is available
name	string	The name of the Amazon product type

Example

SQL

CREATE VIEW amazon_sp_examples.example_DefinitionsProductTypes AS 
	SELECT * 
	FROM (
		CALL amazon_sp.DefinitionsProductTypes (
			marketplaceIds => 'A1PA6795UKMFR9',
			keywords => NULL
		)
	) AS x

DeliveryChallanDocument

Delivery challan document for PCP transportation in IN marketplace
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<shipmentId> (optional): Identifier of a shipment. A shipment contains the boxes and units being inbounded
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38), shipmentIds of type string(100)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
downloadType	string	The type of download. Possible values: URL
expiration	date	The URI's expiration time
uri	string	Uniform resource identifier to identify where the document is located
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_DeliveryChallanDocument AS 
	SELECT * 
	FROM (
		CALL amazon_sp.DeliveryChallanDocument (
			inboundPlanId => NULL,
			shipmentId => NULL
		)
	) AS x;;

DeliveryWindowOptions

Delivery window options for a shipment
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<shipmentId> (optional): The shipment to get delivery window options for
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38), shipmentIds of type string(100)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
startDate	timestamp	The time at which this delivery window option starts
endDate	timestamp	The time at which this delivery window option ends
validUntil	timestamp	The time at which this window delivery option is no longer valid
availabilityType	string	Identifies type of Delivery Window Availability. Values: AVAILABLE, CONGESTED
deliveryWindowOptionId	string	Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_DeliveryWindowOptions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.DeliveryWindowOptions (
			inboundPlanId => NULL,
			shipmentId => NULL
		)
	) AS x;;

Destinations

Destinations. The getDestinations API is grantless. For more information, see "Grantless operations" in the Selling Partner API Developer Guide
Parameter
<destinationId> (optional): The identifier generated when you created the destination
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
destinationId	string	The identifier generated when you created the destination
name	string	The developer-defined name for this destination
resource_eventBridge_accountId	string	The identifier for the AWS account that is responsible for charges related to receiving notifications
resource_eventBridge_name	string	The name of the partner event source associated with the destination
resource_eventBridge_region	string	The AWS region in which you receive the notifications. For AWS regions that are supported in Amazon EventBridge, see https://docs.aws.amazon.com/general/latest/gr/ev.html
resource_sqs_arn	string	The Amazon Resource Name (ARN) associated with the SQS queue.

Example

SQL

CREATE VIEW amazon_sp_examples.example_Destinations AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Destinations ()
	) AS x

FeatureInventory

Inventory items that are eligible for the fulfillment feature you specify
Parameter
<featureName> (required): The name of the feature for which to return a list of eligible inventory
<marketplaceId> (optional): The marketplace for which to return a list of the inventory that is eligible for the specified feature
<sellerSku> (optional): 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
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
MarketplaceId	string	The marketplace for which to return a list of the inventory that is eligible for the specified feature
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item
featureName	string	The name of the feature for which to return a list of eligible inventory
fnSku	string	The unique SKU used by Amazon's fulfillment network
overlappingSkus	string	Other seller SKUs that are shared across the same inventory
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
skuCount	bigdecimal	The number of SKUs available for this service

Example

SQL

CREATE VIEW amazon_sp_examples.example_FeatureInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.FeatureInventory (
			marketplaceId => 'ATVPDKIKX0DER',
			featureName => 'TEST_FEATURE'
		)
	) AS x;;

Features

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
Parameter
<marketplaceId> (optional): The marketplace for which to return the list of features
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
MarketplaceId	string	The marketplace for which to return the list of features
featureDescription	string	The feature description
featureName	string	The feature name
sellerEligible	boolean	When true, indicates that the seller is eligible to use the feature

Example

SQL

CREATE VIEW amazon_sp_examples.example_Features AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Features (
			marketplaceId => 'ATVPDKIKX0DER'
		)
	) AS x

FeedDocument

Feed document's contents
Parameter
<feedDocumentId> (required): The identifier of the feed document
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
feedDocumentId	string	The identifier for the feed document. This identifier is unique only in combination with a seller ID
url	string	A presigned URL for the feed document. This URL expires after 5 minutes

Example

SQL

CREATE VIEW amazon_sp_examples.example_FeedDocument AS 
	SELECT * 
	FROM (
		CALL amazon_sp.FeedDocument (
			feedDocumentId => 'amzn1.tortuga.3.dff66fa7-b3e5-44d6-a16f-198f2ab7260a.T3JF9D6W685YLA'
		)
	) AS x

Feeds

Feed details for the feeds that match the filters that you specify
Parameter
<createdSince> (optional): The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days
<createdUntil> (optional): The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now
<feedTypes> (optional): A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Min count : 1 Max count : 10
<marketplaceIds> (optional): A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify
<processingStatuses> (optional): A list of processing statuses used to filter feeds. Min count : 1
<feedId> (optional): The identifier for the feed. This identifier is unique only in combination with a seller ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
createdTime	timestamp	The date and time when the feed was created, in ISO 8601 date time format
feedId	string	The identifier for the feed. This identifier is unique only in combination with a seller ID
feedType	string	The feed type
marketplaceIds	string	A list of identifiers for the marketplaces that the feed is applied to
processingEndTime	timestamp	The date and time when feed processing completed, in ISO 8601 date time format
processingStartTime	timestamp	The date and time when feed processing started, in ISO 8601 date time format
processingStatus	string	The processing status of the feed
resultFeedDocumentId	string	The identifier for the feed document. This identifier is unique only in combination with a seller ID

Example

SQL

CREATE VIEW amazon_sp_examples.example_Feeds AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Feeds (
			createdUntil => NULL,
			processingStatuses => 'DONE,CANCELLED,FATAL,IN_PROGRESS,IN_QUEUE',
			createdSince => TIMESTAMPADD (SQL_TSI_DAY, -89, CURDATE ()),
			marketplaceIds => 'A1PA6795UKMFR9,A13V1IB3VIYZZH,A1805IZSGTT6HS,A1F83G8C2ARO7P,A1RKKUPIHCS9HS,A2NODRKZP88ZB9,A33AVAJ2PDY3EV',
			feedTypes => 'POST_PRODUCT_DATA,JSON_LISTINGS_FEED,POST_INVENTORY_AVAILABILITY_DATA,POST_PRODUCT_OVERRIDES_DATA,POST_PRODUCT_PRICING_DATA,POST_PRODUCT_IMAGE_DATA,POST_FLAT_FILE_LISTINGS_DATA'
		)
	) AS x

FinancialEventGroups

Financial event groups for a given date range
Parameter
<FinancialEventGroupStartedAfter> (optional): A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted
<FinancialEventGroupStartedBefore> (optional): A date used for selecting financial event groups that opened before (but not at) a specified date and time, in ISO 8601 format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
TraceId	string	The trace identifier used by sellers to look up transactions externally
AccountTail	string	The account tail of the payment instrument
BeginningBalance_CurrencyAmount	bigdecimal	The monetary value
BeginningBalance_CurrencyCode	string	The three-digit currency code in ISO 4217 format
ConvertedTotal_CurrencyAmount	bigdecimal	The monetary value
ConvertedTotal_CurrencyCode	string	The three-digit currency code in ISO 4217 format
FinancialEventGroupEnd	timestamp	The date and time at which the financial event group is closed. In ISO 8601 date time format
FinancialEventGroupId	string	A unique identifier for the financial event group
FinancialEventGroupStart	timestamp	The date and time at which the financial event group is opened. In ISO 8601 date time format
FundTransferDate	timestamp	The date and time when the disbursement or charge was initiated. Only present for closed settlements. In ISO 8601 date time format
FundTransferStatus	string	The status of the fund transfer
OriginalTotal_CurrencyAmount	bigdecimal	The monetary value
OriginalTotal_CurrencyCode	string	The three-digit currency code in ISO 4217 format
ProcessingStatus	string	The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: Open; Closed;

Example

SQL

CREATE VIEW amazon_sp_examples.example_FinancialEventGroups AS 
	SELECT * 
	FROM (
		CALL amazon_sp.FinancialEventGroups (
			FinancialEventGroupStartedBefore => CAST ('2019-10-31' AS date),
			FinancialEventGroupStartedAfter => CAST ('2019-10-31' AS date)
		)
	) AS x

FinancialEvents

Financial events for the specified data range
Parameter
<PostedAfter> (optional): A date used for selecting financial events posted after (or at) a specified time
<PostedBefore> (optional): A date used for selecting financial events posted before (but not at) a specified time
<eventGroupId> (optional): The identifier of the financial event group to which the events belong
<orderId> (optional): An Amazon-defined order identifier, in 3-7-7 format
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
PostedDate	timestamp	The date and time when the financial event was posted
EventName	string
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item
AdjustmentAmount_CurrencyAmount	bigdecimal	The monetary value
AdjustmentAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
AdjustmentType	string	The type of adjustment. Possible values: FBAInventoryReimbursement - An FBA inventory reimbursement to a seller's account. This occurs if a seller's inventory is damaged; ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs when some money from a seller's account is held back; PostageBilling - The amount paid by a seller for shipping labels; PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded; LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller's account for a package that we lost or damaged; CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller's account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace; ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace; SellerRewards - An award credited to a seller's account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace;
AmazonOrderId	string	An Amazon-defined identifier for an order
AmountDescription	string	A short description of this payment event
BaseExpense_CurrencyAmount	bigdecimal	The monetary value
BaseExpense_CurrencyCode	string	The three-digit currency code in ISO 4217 format
BaseTax_CurrencyAmount	bigdecimal	The monetary value
BaseTax_CurrencyCode	string	The three-digit currency code in ISO 4217 format
BaseValue_CurrencyAmount	bigdecimal	The monetary value
BaseValue_CurrencyCode	string	The three-digit currency code in ISO 4217 format
BusinessObjectType	string	The type of business object
ChargeComponent_ChargeAmount_CurrencyAmount	bigdecimal
ChargeComponent_ChargeAmount_CurrencyCode	string
ChargeComponent_ChargeType	string
Charge_ChargeAmount_CurrencyAmount	bigdecimal
Charge_ChargeAmount_CurrencyCode	string
Charge_ChargeType	string
ClipOrRedemptionCount	long	The number of coupon clips or redemptions
CouponId	string	A coupon identifier
DealDescription	string	The internal description of the deal
DealId	string	The unique identifier of the deal
DebtRecoveryType	string	The debt recovery type. Possible values: DebtPayment; DebtPaymentFailure; DebtAdjustment;
EnrollmentId	string	An enrollment identifier
EventType	string	The type of event: SellerDealComplete
ExtensionLength	integer	The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events
FeeAmount_CurrencyAmount	bigdecimal	The monetary value
FeeAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
FeeComponent_FeeAmount_CurrencyAmount	bigdecimal	The monetary value
FeeComponent_FeeAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
FeeComponent_FeeType	string	The type of fee. For more information about Selling on Amazon fees, see Selling on Amazon Fee Schedule on Seller Central. For more information about Fulfillment by Amazon fees, see FBA features, services and fees on Seller Central
FeeDescription	string	A short description of the service fee event
FeeReason	string	A short description of the service fee reason
FeeType	string	The type of fee: RunLightningDealFee
FnSKU	string	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
FulfillmentChannel	string	The fulfillment channel. Possible values: AFN - Amazon Fulfillment Network (Fulfillment by Amazon); MFN - Merchant Fulfillment Network (self-fulfilled);
ImagingRequestBillingItemID	string	The identifier for the imaging services request
InvoiceId	string	Identifier for the invoice that the transaction appears in
LiquidationFeeAmount_CurrencyAmount	bigdecimal	The monetary value
LiquidationFeeAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
LiquidationProceedsAmount_CurrencyAmount	bigdecimal	The monetary value
LiquidationProceedsAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
LoanAmount_CurrencyAmount	bigdecimal	The monetary value
LoanAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
MarketplaceCountryCode	string	The two-letter country code of the country associated with the marketplace where the order was placed
MarketplaceId	string	An encrypted, Amazon-defined marketplace identifier
MarketplaceName	string	The name of the marketplace where the event occurred
NetCoTransactionID	string	The identifier for the network item swap
OriginalRemovalOrderId	string	The identifier for the original removal order
OverPaymentCredit_CurrencyAmount	bigdecimal	The monetary value
OverPaymentCredit_CurrencyCode	string	The three-digit currency code in ISO 4217 format
ParentASIN	string	The Amazon Standard Identification Number (ASIN) of the item that was enrolled in the Early Reviewer Program
PaymentAmountType	string	The type of payment. Possible values: Sales;
PaymentEventId	string	A payment event identifier
ProviderId	string	The Amazon-defined identifier of the solution provider
ProviderStoreName	string	The store name where the payment event occurred
ProviderTransactionType	string	The transaction type
ReasonCode	string	Indicates why the seller was reimbursed
RecoveryAmount_CurrencyAmount	bigdecimal	The monetary value
RecoveryAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
ReimbursedAmount_CurrencyAmount	bigdecimal	The monetary value
ReimbursedAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
RentalEventType	string	The type of rental event. Possible values: RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item; RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period; RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item; RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item; RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon; RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge; RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item;
RentalInitialValue_CurrencyAmount	bigdecimal	The monetary value
RentalInitialValue_CurrencyCode	string	The three-digit currency code in ISO 4217 format
RentalReimbursement_CurrencyAmount	bigdecimal	The monetary value
RentalReimbursement_CurrencyCode	string	The three-digit currency code in ISO 4217 format
RetrochargeEventType	string	The type of event. Possible values: Retrocharge; RetrochargeReversal;
SAFETClaimId	string	A SAFE-T claim identifier
SalesChannel	string	The sales channel for the transaction
SellerCouponDescription	string	The description provided by the seller when they created the coupon
SellerId	string	The Amazon-defined identifier of the seller
SellerOrderId	string	A seller-defined identifier for an order
SellerSKU	string	The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is included with every call to the Selling Partner API
SellerStoreName	string	The store name where the payment event occurred
ShippingTax_CurrencyAmount	bigdecimal	The monetary value
ShippingTax_CurrencyCode	string	The three-digit currency code in ISO 4217 format
SourceBusinessEventType	string	The type of event. Possible values: LoanAdvance; LoanPayment; LoanRefund;
StoreName	string	The store name where the event occurred
SwapReason	string	The reason for the network item swap
TaxAmount_CurrencyAmount	bigdecimal	The monetary value
TaxAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TaxExclusiveAmount_CurrencyAmount	bigdecimal	The monetary value
TaxExclusiveAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TaxTypeCGST_CurrencyAmount	bigdecimal	The monetary value
TaxTypeCGST_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TaxTypeIGST_CurrencyAmount	bigdecimal	The monetary value
TaxTypeIGST_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TaxTypeSGST_CurrencyAmount	bigdecimal	The monetary value
TaxTypeSGST_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TaxValue_CurrencyAmount	bigdecimal	The monetary value
TaxValue_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TotalAmount_CurrencyAmount	bigdecimal	The monetary value
TotalAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TotalExpense_CurrencyAmount	bigdecimal	The monetary value
TotalExpense_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TransactionAmount_CurrencyAmount	bigdecimal	The monetary value
TransactionAmount_CurrencyCode	string	The three-digit currency code in ISO 4217 format
TransactionCreationDate	timestamp	The date and time that the credit transaction was created, in ISO 8601 date time format
TransactionPostedDate	timestamp	The date and time when the payment transaction is posted. In ISO 8601 date time format
TransactionType	string	Indicates if the transaction is for a charge or a refund. Possible values: charge - Charge; refund - Refund;
TransactionValue_CurrencyAmount	bigdecimal	The monetary value
TransactionValue_CurrencyCode	string	The three-digit currency code in ISO 4217 format

Example

SQL

CREATE VIEW amazon_sp_examples.example_FinancialEvents AS 
	SELECT * 
	FROM (
		CALL amazon_sp.FinancialEvents (
			PostedBefore => NULL,
			PostedAfter => TIMESTAMPADD (SQL_TSI_DAY, -51, CURDATE ())
		)
	) AS x

FulfillmentOrders

Fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter
Parameter
<queryStartDate> (optional): 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
<sellerFulfillmentOrderId> (optional): The identifier assigned to the item by the seller when the fulfillment order was created. maxLength : 40
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The identifier for the marketplace the fulfillment order is placed against
displayableOrderId	string	A fulfillment order identifier submitted with the createFulfillmentOrder operation. Displays as the order identifier in recipient-facing materials such as the packing slip
deliveryWindow	string	The time range within which a Scheduled Delivery fulfillment order should be delivered
displayableOrderComment	string	A text block submitted with the createFulfillmentOrder operation. Displays in recipient-facing materials such as the packing slip
displayableOrderDate	timestamp	A date and time submitted with the createFulfillmentOrder operation. Displays as the order date in recipient-facing materials such as the packing slip
featureConstraints	string	A list of features and their fulfillment policies to apply to the order
fulfillmentAction	string	Specifies whether the fulfillment order should ship now or have an order hold put on it
fulfillmentOrderStatus	string	The current status of the fulfillment order
fulfillmentPolicy	string	The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation
notificationEmails	string	A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller
receivedDate	timestamp	The date and time that the fulfillment order was received by an Amazon fulfillment center
sellerFulfillmentOrderId	string	The identifier assigned to the item by the seller when the fulfillment order was created. maxLength : 40
shippingSpeedCategory	string	The shipping method used for the fulfillment order
statusUpdatedDate	timestamp	The date and time that the status of the fulfillment order last changed, in ISO 8601 date time format

Example

SQL

CREATE VIEW amazon_sp_examples.example_FulfillmentOrders AS 
	SELECT * 
	FROM (
		CALL amazon_sp.FulfillmentOrders (
			queryStartDate => (CALL UTILS.tryCastTimestamp (originalValue => '2020-01-01T19:46:45Z'))
		)
	) AS x

InboundPlan

The top level information about an inbound plan
Parameter
<status> (optional): Then status of the inbound plan
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier to an inbound plan
createdAt	timestamp	Timestamp that indicates the date and time that the plan was created
lastUpdatedAt	timestamp	Timestamp that indicates the date and time that the plan was updated
marketplaceIds	string	Marketplace IDs
contactInformation_email	string	The email address of the seller
contactInformation_name	string	The name belonging to the contact
contactInformation_phoneNumber	string	The phone number of the seller
sourceAddress_addressLine1	string	Street address information
sourceAddress_addressLine2	string	Additional street address information
sourceAddress_city	string	The city
sourceAddress_companyName	string	The name of the business
sourceAddress_countryCode	string	The country code
sourceAddress_name	string	The name of the individual or business
sourceAddress_postalCode	string	The postal code
sourceAddress_stateOrProvinceCode	string	The state or province code
name	string	Human-readable name of the inbound plan
status	string	Current status of the inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_InboundPlan AS 
	SELECT * 
	FROM (
		CALL amazon_sp.InboundPlan (
			preview => true
		)
	) AS x;;

InboundPlanBoxes

Box packages in an inbound plan
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
packageId	string	Primary key to uniquely identify a Package (Box or Pallet)
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
contentInformationSource	string	Indication of how box content is meant to be provided. Values : BOX_CONTENT_PROVIDED, MANUAL_PROCESS, BARCODE_2D. BOX_CONTENT_PROVIDED - Box contents have been provided by the seller MANUAL_PROCESS - Box contents will be manually processed during receive. This service incurs charges BARCODE_2D - Box contents information is provided by a barcode on the shipment. For more information, refer to Using 2D barcodes for box content information on Seller Central
destinationRegion_countryCode	string	ISO 3166 standard alpha-2 country code
destinationRegion_state	string	State
destinationRegion_warehouseId	string	An identifier for a warehouse, such as a FC, IXD, upstream storage
dimensions_height	bigdecimal	The height of a package
dimensions_length	bigdecimal	The length of a package
dimensions_unitOfMeasurement	string	Unit of linear measure. Values : IN, CM. IN - Inches CM - Centimeters
dimensions_width	bigdecimal	The width of a package
quantity	integer	The number of containers where all other properties like weight or dimensions are identical
templateName	string	Template name of the box
weight_unit	string	Unit of the weight being measured. Values : LB, KG. LB - Pounds KG - Kilograms
weight_value	bigdecimal	Value of a weight
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_InboundPlanBoxes AS 
	SELECT * 
	FROM (
		CALL amazon_sp.InboundPlanBoxes (
			inboundPlanId => NULL
		)
	) AS x;;

InboundPlanItems

Item packages in an inbound plan
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
asin	string	The Amazon Standard Identification Number (ASIN) of the item
expiration	date	The expiration date of the MSKU
fnsku	string	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
labelOwner	string	Specifies who will label the items. Options include AMAZON, SELLER, and NONE
manufacturingLotCode	string	The manufacturing lot code
msku	string	The merchant SKU, a merchant-supplied identifier of a specific SKU
quantity	integer	The number of the specified MSKU
error_message	string	Identifier of an inbound plan

SQL

CREATE VIEW amazon_sp_examples.example_InboundPlanItems AS 
	SELECT * 
	FROM (
		CALL amazon_sp.InboundPlanItems (
			inboundPlanId => NULL
		)
	) AS x;;

InboundPlans

Inbound plans with minimal information
Parameter
<status> (optional): One or more statuses of an inbound plan. Possible values: ACTIVE - an inbound plan that is being worked on; VOIDED - an inbound plan with all shipment cancelled and can no longer be modified; SHIPPED - a completed inbound plan. Only minor modifications can be made at this time
<inboundPlanId> (optional): Identifier of an inbound plan
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
marketplaceIds	string	A list of marketplace IDs
name	string	Human-readable name of the inbound plan
sourceAddress_addressLine1	string	Street address information
sourceAddress_addressLine2	string	Additional street address information
sourceAddress_city	string	The city
sourceAddress_companyName	string	The name of the business
sourceAddress_countryCode	string	The country code in two-character ISO 3166-1 alpha-2 format
sourceAddress_email	string	The email address
sourceAddress_name	string	The name of the individual who is the primary contact
sourceAddress_phoneNumber	string	The phone number
sourceAddress_postalCode	string	The postal code
sourceAddress_stateOrProvinceCode	string	The state or province code
status	string	The current status of the inbound plan. Possible values: ACTIVE , VOIDED , SHIPPED , ERRORED
createdAt	timestamp	The time at which the inbound plan was created
lastUpdatedAt	timestamp	The time at which the inbound plan was last updated

Example

SQL

CREATE VIEW amazon_sp_examples.example_InboundPlans AS 
	SELECT * 
	FROM (
		CALL amazon_sp.InboundPlans (
			status => NULL
		)
	) AS x;;

InboundPlansExtended

Information about an inbound plan
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
marketplaceIds	string	A list of marketplace IDs
name	string	Human-readable name of the inbound plan
packingOptions	string	Packing options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, only packing options for that placement option will be returned. If there are confirmed shipments, only packing options for those shipments will be returned. Query the packing option for more details
placementOptions	string	Placement options for the inbound plan. This property will be populated when it has been generated via the corresponding operation. If there is a chosen placement option, that will be the only returned option. Query the placement option for more details
shipments	string	A list of shipment IDs for the inbound plan. This property is populated when it has been generated with the confirmPlacementOptions operation. Only shipments from the chosen placement option are returned. Query the shipment for more details
sourceAddress_addressLine1	string	Street address information
sourceAddress_addressLine2	string	Additional street address information
sourceAddress_city	string	The city
sourceAddress_companyName	string	The name of the business
sourceAddress_countryCode	string	The country code in two-character ISO 3166-1 alpha-2 format
sourceAddress_email	string	The email address
sourceAddress_name	string	The name of the individual who is the primary contact
sourceAddress_phoneNumber	string	The phone number
sourceAddress_postalCode	string	The postal code
sourceAddress_stateOrProvinceCode	string	The state or province code
status	string	Current status of the inbound plan. Possible values: ACTIVE , VOIDED , SHIPPED , ERRORED
createdAt	timestamp	The time at which the inbound plan was created. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ssZ
lastUpdatedAt	timestamp	The time at which the inbound plan was last updated
error_message	string	Identifier of an inbound plan

CODE

1CREATE VIEW amazon_sp_examples.example_InboundPlans AS 
2	SELECT * 
3	FROM (
4		CALL amazon_sp.InboundPlans (
5			status => NULL
6		)
7	) AS x;;

InboundPlanShipments

The full details for a specific shipment within an inbound plan
Parameter
<inboundPlanId> (optional): Identifier to an inbound plan
<shipmentId> (optional): Identifier to a shipment
<inbound_shipment_table> (optional): Table that contains inbound plan Ids and shipment Ids
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier to an inbound plan
shipmentId	string	Identifier to a shipment
amazonReferenceId	string	A unique identifier created by Amazon that identifies this Amazon-partnered shipment
lastUpdatedAt	timestamp	Timestamp that indicates the date and time that the plan was updated
contactInformation_email	string	The email address of the seller
contactInformation_name	string	The name belonging to the contact
contactInformation_phoneNumber	string	The phone number of the seller
dates_deliveryWindow_editableUntil	timestamp	The timestamp at which this Window can no longer be edited
dates_deliveryWindow_end	timestamp	The end timestamp of the window
dates_deliveryWindow_start	timestamp	The start timestamp of the window
dates_readyToShipWindow_editableUntil	timestamp	The timestamp at which this Window can no longer be edited
dates_readyToShipWindow_end	timestamp	The end timestamp of the window
dates_readyToShipWindow_start	timestamp	The start timestamp of the window
destinationRegion_address_addressLine1	string	The address the shipment should be sent to: street address information
destinationRegion_address_addressLine2	string	The address the shipment should be sent to: additional street address information
destinationRegion_address_city	string	The address the shipment should be sent to: the city
destinationRegion_address_companyName	string	The address the shipment should be sent to: the name of the business
destinationRegion_address_countryCode	string	The address the shipment should be sent to: the country code
destinationRegion_address_name	string	The address the shipment should be sent to: the name of the individual or business
destinationRegion_address_postalCode	string	The address the shipment should be sent to: the postal code
destinationRegion_address_stateOrProvinceCode	string	The address the shipment should be sent to: the state or province code
destinationRegion_destinationType	string	The type of destination for this shipment
destinationRegion_warehouseId	string	The warehouse that the shipment should be sent to
name	string	The name of the shipment
placementOptionId	string	Identifier to a placement option
palletInformation_declaredValue_amount	bigdecimal	Decimal value of the currency
palletInformation_declaredValue_code	string	Currency code
palletInformation_freightClass	string	Freight class
palletInformation_pallets_dimensions_height	double	Height
palletInformation_pallets_dimensions_length	double	Length
palletInformation_pallets_dimensions_unitOfMeasurement	string	Unit of linear measure
palletInformation_pallets_dimensions_width	double	Width
palletInformation_pallets_quantity	integer	The number of containers where all other properties like weight or dimensions are identical
palletInformation_pallets_stackability	string	Indicates whether pallets will be stacked when carrier arrives for pick-up
palletInformation_pallets_weight_unit	string	Unit of the weight being measured
palletInformation_pallets_weight_value	double	Value of a weight
selectedTransportationOptionId	string	Identifier to a transportation option
shipmentConfirmationId	string	The confirmed shipment ID which shows up on labels
source_sourceType	string	The type of source for this shipment
source_address_addressLine1	string	The "ship from" address: street address information
source_address_addressLine2	string	The "ship from" address: additional street address information
source_address_city	string	The "ship from" address: the city
source_address_companyName	string	The "ship from" address: the name of the business
source_address_countryCode	string	The "ship from" address: the country code
source_address_name	string	The "ship from" address: the name of the individual or business
source_address_postalCode	string	The "ship from" address: the postal code
source_address_stateOrProvinceCode	string	The "ship from" address: the state or province code
status	string	The status of a shipment
trackingDetails_ltlTrackingDetail_billOfLadingNumber	string	LTL shipment tracking: the number of the carrier shipment acknowledgement document
trackingDetails_ltlTrackingDetail_freightBillNumber	string	LTL shipment tracking: the number associated with the freight bill
trackingDetails_spdTrackingDetail_billOfLadingNumber	string	SPD shipment tracking: the number of the carrier shipment acknowledgement document
trackingDetails_spdTrackingDetail_freightBillNumber	string	SPD shipment tracking: the number associated with the freight bill

Example

SQL

CREATE VIEW amazon_sp_examples.example_InboundPlanShipments AS 
	SELECT * 
	FROM (
		CALL amazon_sp.InboundPlanShipments (
			preview => true
		)
	) AS x;;

InboundPlanShipmentItems

Item packages in a shipment
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<shipmentId> (optional): Identifier of a shipment. A shipment contains the boxes and units being inbounded
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38), shipmentIds of type string(100)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
asin	string	The Amazon Standard Identification Number (ASIN) of the item
expiration	date	The expiration date of the MSKU
fnsku	string	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
labelOwner	string	Specifies who will label the items. Options include AMAZON, SELLER, and NONE
manufacturingLotCode	string	The manufacturing lot code
msku	string	The merchant SKU, a merchant-supplied identifier of a specific SKU
quantity	integer	The number of the specified MSKU
error_message	string	Identifier of an inbound plan

SQL

CREATE VIEW amazon_sp_examples.example_InboundPlanShipmentItems AS 
	SELECT * 
	FROM (
		CALL amazon_sp.InboundPlanShipmentItems (
			inboundPlanId => NULL,
			shipmentId => NULL
		)
	) AS x;;

ItemComplianceDetails

Inbound compliance details for MSKUs in a given marketplace
Parameter
<marketplaceId> (optional): The marketplace Id
<mskus> (optional): A list of merchant SKUs, a merchant-supplied identifier of a specific SKU
<msku_table> (optional): Table with msku containing column msku of type string(40)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The marketplace Id
asin	string	The Amazon Standard Identification Number, which identifies the detail page identifier
fnsku	string	The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition
msku	string	The merchant SKU, a merchant-supplied identifier for a specific SKU
taxDetails_declaredValue_amount	bigdecimal	Decimal value of the currency
taxDetails_declaredValue_code	string	ISO 4217 standard of a currency code
taxDetails_hsnCode	string	Harmonized System of Nomenclature code
taxDetails_taxRates	string	List of tax rates
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_ItemComplianceDetails AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ItemComplianceDetails (
			marketplaceId => 'A1PA6795UKMFR9',
			mskus => 'mskus example'
		)
	) AS x;;

PackingGroupBoxes

Boxes from a given packing group
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<packingGroupId> (optional): Identifier of a packing group
<packingGroup_table> (optional): Table with packingGroup containing columns: inboundPlanId and packingGroupId of types string(38)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
packingGroupId	string	Identifier of a packing group
packageId	string	Primary key to uniquely identify a Package (Box or Pallet)
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
contentInformationSource	string	Indication of how box content is meant to be provided. Values : BOX_CONTENT_PROVIDED, MANUAL_PROCESS, BARCODE_2D. BOX_CONTENT_PROVIDED - Box contents have been provided by the seller MANUAL_PROCESS - Box contents will be manually processed during receive. This service incurs charges BARCODE_2D - Box contents information is provided by a barcode on the shipment. For more information, refer to Using 2D barcodes for box content information on Seller Central
destinationRegion_countryCode	string	ISO 3166 standard alpha-2 country code
destinationRegion_state	string	State
destinationRegion_warehouseId	string	An identifier for a warehouse, such as a FC, IXD, upstream storage
dimensions_height	bigdecimal	The height of a package
dimensions_length	bigdecimal	The length of a package
dimensions_unitOfMeasurement	string	Unit of linear measure. Values : IN, CM. IN - Inches CM - Centimeters
dimensions_width	bigdecimal	The width of a package
quantity	integer	The number of containers where all other properties like weight or dimensions are identical
templateName	string	Template name of the box
weight_unit	string	Unit of the weight being measured. Values : LB, KG. LB - Pounds KG - Kilograms
weight_value	bigdecimal	Value of a weight

Example

SQL

CREATE VIEW amazon_sp_examples.example_PackingGroupBoxes AS 
	SELECT * 
	FROM (
		CALL amazon_sp.PackingGroupBoxes (
			inboundPlanId => NULL,
			packingGroupId => NULL
		)
	) AS x;;

PackingGroupItems

Items in a given packing group
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<packingGroupId> (optional): Identifier of a packing group
<packingGroup_table> (optional): Table with packingGroup containing columns: inboundPlanId and packingGroupId of types string(38)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
packingGroupId	string	Identifier of a packing group
asin	string	The Amazon Standard Identification Number (ASIN) of the item
expiration	date	The expiration date of the MSKU
fnsku	string	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
labelOwner	string	Specifies who will label the items. Options include AMAZON , SELLER , and NONE
manufacturingLotCode	string	The manufacturing lot code
msku	string	The merchant SKU, a merchant-supplied identifier of a specific SKU
quantity	integer	The number of the specified MSKU

Example

SQL

CREATE VIEW amazon_sp_examples.example_PackingGroupItems AS 
	SELECT * 
	FROM (
		CALL amazon_sp.PackingGroupItems (
			inboundPlanId => NULL,
			packingGroupId => NULL
		)
	) AS
	 x;;

PackingOptions

Packing options for an inbound plan
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
expiration	date	The time at which this packing option is no longer valid
packingGroups	string	Packing group IDs
packingOptionId	string	Identifier of a packing option
status	string	The status of the packing option. Possible values: OFFERED, ACCEPTED, EXPIRED
supportedShippingConfigurations	string	List of supported shipping modes
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_PackingOptions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.PackingOptions (
			inboundPlanId => NULL
		)
	) AS x;;

PlacementOptions

Placement options for an inbound plan
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
placementOptionId	string	The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs
expiration	date	The expiration date of the placement option
shipmentIds	string	Shipment ids
status	string	The status of a placement option. Possible values: OFFERED, ACCEPTED, EXPIRED
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_PlacementOptions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.PlacementOptions (
			inboundPlanId => NULL
		)
	) AS x;;

PrepDetails

Preparation details for a list of MSKUs in a specified marketplace
Parameter
<marketplaceId> (optional): The marketplace Id
<mskus> (optional): A list of merchant SKUs, a merchant-supplied identifier of a specific SKU
<msku_table> (optional): Table with msku containing column msku of type string(40)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The marketplace Id
allOwnersConstraint	string	A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints. Values : MUST_MATCH. MUST_MATCH - All owners must match
labelOwnerConstraint	string	A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable. Values : AMAZON_ONLY, NONE_ONLY, SELLER_ONLY. AMAZON_ONLY - Only AMAZON is accepted as an owner NONE_ONLY - Only NONE is accepted as an owner SELLER_ONLY - Only SELLER is accepted as an owner
msku	string	The merchant SKU, a merchant-supplied identifier for a specific SKU
prepCategory	string	The preparation category for shipping an item to Amazon's fulfillment network. Values : ADULT, BABY, FC_PROVIDED, FRAGILE, GRANULAR, HANGER, LIQUID, PERFORATED, SET, SHARP, SMALL, TEXTILE, UNKNOWN, NONE. ADULT - Displays potentially offensive material such as profanity or nudity BABY - Made for a child aged three years or younger, packaging with cutouts greater than one square inch FC_PROVIDED - A prep type has been defined by the Fulfillment Center. This value is provided by Amazon and cannot be used as an input FRAGILE - Glass or otherwise fragile, or a liquid in a glass container GRANULAR - Made of powder, pellets, or granular material HANGER - Made of cloth or fabric and intended to be put on a hanger LIQUID - Liquid or viscous without a double seal PERFORATED - In packaging that has a perforated opening SET - Multiple items that are sold as one unit SHARP - Sharp and easily exposed, not already contained in protective packaging SMALL - Longest side less than 2 1/8 inches (width of a credit card) TEXTILE - Made of cloth or fabric that could be damaged by dirt, dust, moisture, or liquid UNKNOWN - An unknown prep category was found and needs to be updated. This value is provided by Amazon and cannot be used as an input NONE - Does not require prep
prepOwnerConstraint	string	A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable. Values : AMAZON_ONLY, NONE_ONLY, SELLER_ONLY. AMAZON_ONLY - Only AMAZON is accepted as an owner NONE_ONLY - Only NONE is accepted as an owner SELLER_ONLY - Only SELLER is accepted as an owner
prepTypes	string	A list of preparation types associated with a preparation category. Values : ITEM_BLACK_SHRINKWRAP, ITEM_BLANKSTK, ITEM_BOXING, ITEM_BUBBLEWRAP, ITEM_CAP_SEALING, ITEM_DEBUNDLE, ITEM_HANG_GARMENT, ITEM_LABELING, ITEM_NO_PREP, ITEM_POLYBAGGING, ITEM_RMOVHANG, ITEM_SETCREAT, ITEM_SETSTK, ITEM_SIOC, ITEM_SUFFOSTK, ITEM_TAPING. ITEM_BLACK_SHRINKWRAP - The item requires black shrink wrapping ITEM_BLANKSTK - The item requires a blank sticker to obscure a bad barcode that cannot be covered by another sticker ITEM_BOXING - Products may require overboxing when there are safety concerns over sharp items, fragile items, hazardous liquids, and vinyl records. For items over 4.5 kg, use double-wall corrugated boxes ITEM_BUBBLEWRAP - The item requires bubble wrapping ITEM_CAP_SEALING - To prevent leakage, the product needs to have a secondary seal in one of the following types: Induction seal, safety ring, clips, heat shrink plastic band, or boxing ITEM_DEBUNDLE - The item requires taking apart a set of items labeled for individual sale. Remove tape or shrink wrap that groups multiple inventory units together ITEM_HANG_GARMENT - The item must be placed on a hanger ITEM_LABELING - The FNSKU label must be applied to the item ITEM_NO_PREP - The item does not require any prep ITEM_POLYBAGGING - The item requires polybagging ITEM_RMOVHANG - The item cannot be shipped on a hanger ITEM_SETCREAT - Units that are sets must be labeled as sets on their packaging. The barcodes on the individual items must not face outward and must not require covering ITEM_SETSTK - Products that are sets must be marked as sets on their packaging. Add a label to the unit that clearly states that the products must be received and sold as a single unit. For example, if a set of six unique toy cars is sold as one unit, the packaging for each car must indicate that it is part of the set ITEM_SIOC - The item ships in its original product packaging ITEM_SUFFOSTK - Poly bags with an opening of 12 cm or larger (measured when flat) must have a suffocation warning. This warning must be printed on the bag or attached as a label ITEM_TAPING - Indicates that taping is required
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_PlacementOptions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.PlacementOptions (
			inboundPlanId => NULL
		)
	) AS x;;

PrepDetails

Preparation details for a list of MSKUs in a specified marketplace
Parameter
<marketplaceId> (optional): The marketplace Id
<mskus> (optional): A list of merchant SKUs, a merchant-supplied identifier of a specific SKU
<msku_table> (optional): Table with msku containing column msku of type string(40)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The marketplace Id
allOwnersConstraint	string	A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints. Values : MUST_MATCH. MUST_MATCH - All owners must match
labelOwnerConstraint	string	A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable. Values : AMAZON_ONLY, NONE_ONLY, SELLER_ONLY. AMAZON_ONLY - Only AMAZON is accepted as an owner NONE_ONLY - Only NONE is accepted as an owner SELLER_ONLY - Only SELLER is accepted as an owner
msku	string	The merchant SKU, a merchant-supplied identifier for a specific SKU
prepCategory	string	The preparation category for shipping an item to Amazon's fulfillment network. Values : ADULT, BABY, FC_PROVIDED, FRAGILE, GRANULAR, HANGER, LIQUID, PERFORATED, SET, SHARP, SMALL, TEXTILE, UNKNOWN, NONE. ADULT - Displays potentially offensive material such as profanity or nudity BABY - Made for a child aged three years or younger, packaging with cutouts greater than one square inch FC_PROVIDED - A prep type has been defined by the Fulfillment Center. This value is provided by Amazon and cannot be used as an input FRAGILE - Glass or otherwise fragile, or a liquid in a glass container GRANULAR - Made of powder, pellets, or granular material HANGER - Made of cloth or fabric and intended to be put on a hanger LIQUID - Liquid or viscous without a double seal PERFORATED - In packaging that has a perforated opening SET - Multiple items that are sold as one unit SHARP - Sharp and easily exposed, not already contained in protective packaging SMALL - Longest side less than 2 1/8 inches (width of a credit card) TEXTILE - Made of cloth or fabric that could be damaged by dirt, dust, moisture, or liquid UNKNOWN - An unknown prep category was found and needs to be updated. This value is provided by Amazon and cannot be used as an input NONE - Does not require prep
prepOwnerConstraint	string	A constraint that can apply to an individual owner. If no constraint is specified, both AMAZON and SELLER are acceptable. Values : AMAZON_ONLY, NONE_ONLY, SELLER_ONLY. AMAZON_ONLY - Only AMAZON is accepted as an owner NONE_ONLY - Only NONE is accepted as an owner SELLER_ONLY - Only SELLER is accepted as an owner
prepTypes	string	A list of preparation types associated with a preparation category. Values : ITEM_BLACK_SHRINKWRAP, ITEM_BLANKSTK, ITEM_BOXING, ITEM_BUBBLEWRAP, ITEM_CAP_SEALING, ITEM_DEBUNDLE, ITEM_HANG_GARMENT, ITEM_LABELING, ITEM_NO_PREP, ITEM_POLYBAGGING, ITEM_RMOVHANG, ITEM_SETCREAT, ITEM_SETSTK, ITEM_SIOC, ITEM_SUFFOSTK, ITEM_TAPING. ITEM_BLACK_SHRINKWRAP - The item requires black shrink wrapping ITEM_BLANKSTK - The item requires a blank sticker to obscure a bad barcode that cannot be covered by another sticker ITEM_BOXING - Products may require overboxing when there are safety concerns over sharp items, fragile items, hazardous liquids, and vinyl records. For items over 4.5 kg, use double-wall corrugated boxes ITEM_BUBBLEWRAP - The item requires bubble wrapping ITEM_CAP_SEALING - To prevent leakage, the product needs to have a secondary seal in one of the following types: Induction seal, safety ring, clips, heat shrink plastic band, or boxing ITEM_DEBUNDLE - The item requires taking apart a set of items labeled for individual sale. Remove tape or shrink wrap that groups multiple inventory units together ITEM_HANG_GARMENT - The item must be placed on a hanger ITEM_LABELING - The FNSKU label must be applied to the item ITEM_NO_PREP - The item does not require any prep ITEM_POLYBAGGING - The item requires polybagging ITEM_RMOVHANG - The item cannot be shipped on a hanger ITEM_SETCREAT - Units that are sets must be labeled as sets on their packaging. The barcodes on the individual items must not face outward and must not require covering ITEM_SETSTK - Products that are sets must be marked as sets on their packaging. Add a label to the unit that clearly states that the products must be received and sold as a single unit. For example, if a set of six unique toy cars is sold as one unit, the packaging for each car must indicate that it is part of the set ITEM_SIOC - The item ships in its original product packaging ITEM_SUFFOSTK - Poly bags with an opening of 12 cm or larger (measured when flat) must have a suffocation warning. This warning must be printed on the bag or attached as a label ITEM_TAPING - Indicates that taping is required
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_PrepDetails AS 
	SELECT * 
	FROM (
		CALL amazon_sp.PrepDetails (
			marketplaceId => NULL,
			mskus => 'mskus example'
		)
	) AS x;;

Report_InventoryLedgerDetailedView

Inventory Ledger Report - Detailed View
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
Date	date	Date
FNSKU	string	Amazon''s Fulfillment network SKU identifier
ASIN	string	The Amazon Standard Identification Number of the item
MSKU	string	Unique identifier that you assign to products
Title	string	The title of your product
Event_Type	string	Type of event that caused a change in inventory (shipment, receipt, vendor return, warehouse transfer, adjustment, or customer return)
Reference_ID	string	Transaction ID (such as a shipment ID or adjustment ID)
Quantity	integer	The total number of units reimbursed for this line item
Fulfillment_Center	string	Fulfillment center where the inventory is stored
Disposition	string	The status of the unit
Reason	string	The downloaded report displays codes, while the online report shows descriptions. See the Adjustment types and reason codes table at the top of Inventory adjustments for a full list of codes and descriptions
Country	string	Country in which your products are stored

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_InventoryLedgerDetailedView AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_InventoryLedgerDetailedView (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_InventoryLedgerSummaryView

Inventory Ledger Report - Summary View
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<aggregateByTimePeriod> (optional): Specify the time period to aggregate Summary View data accordingly (for example, MONTHLY, WEEKLY, DAILY, etc.). Default: MONTHLY
<aggregateByLocation> (optional): Include Country to aggregate Summary View data by country. Include FC to aggregate Summary View data by fulfillment center. Default: COUNTRY
<FNSKU> (optional): Include FNSKU value to view report data for that particular FNSKU
<MSKU> (optional): Include MSKU value to view report data for all active FNSKU mappings of that MSKU
<ASIN> (optional): Include ASIN value to view report data for all active FNSKU mappings of that ASIN
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
Date	date	Date
FNSKU	string	Amazon''s Fulfillment network SKU identifier
ASIN	string	The Amazon Standard Identification Number of the item
MSKU	string	Unique identifier that you assign to products
Title	string	The title of your product
Disposition	string	The status of the unit
Starting_Warehouse_Balance	integer	Units available for this product in Amazon fulfillment centers at the start of the time period
Customer_Shipments	bigdecimal	Completed deliveries of customer orders that Amazon has fulfilled
Customer_Returns	bigdecimal	Units that have been returned to Amazon fulfillment centers by customers and that have been returned to your inventory
Vendor_Returns	bigdecimal	Vendor Returns are transactions that show what Items are shipped by you back to the Vendor
Warehouse_Transfer_In_Out	bigdecimal	Aggregated number of units transshipped in and out from Amazon fulfillment centers
Found	bigdecimal	Units that were missing but have been found and returned to your inventory
Lost	bigdecimal	Units that are missing from your inventory in Amazon fulfillment centers and that may be eligible for reimbursement or have already been reimbursed
Damaged	bigdecimal	Damaged
Disposed	bigdecimal	Units removed from your inventory and disposed of
Other_Events	bigdecimal	Units that were identified as damaged and that may be eligible for reimbursement or have already been reimbursed, as well as all other inventory dispositions that may not be covered under the other definitions
Ending_Warehouse_Balance	bigdecimal	Units available for this product in Amazon fulfillment centers at the end of the time period
Unknown_Events	bigdecimal	Units for which the specific event type is not known. This is primarily caused by parts of an event occurring across different reporting time periods. Expanding the reporting time period can reduce the number of unknown event units
Location	string	The country or fulfillment center where your inventory is located, depending on your selection for the Inventory location parameter
In_Transit_Between_Warehouses	bigdecimal	Units that are in transit between Amazon fulfillment centers
Receipts	bigdecimal	Units received in shipments to Amazon fulfillment centers

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_InventoryLedgerSummaryView AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_InventoryLedgerSummaryView (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

InventorySummaries

Inventory summaries. The summaries returned depend on the presence or absence of the startDateTime and sellerSkus parameters:
Parameter
<details> (optional): true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value)
<marketplaceIds> (optional): The marketplace ID for the marketplace for which to return inventory summaries. Max count : 1
<sellerSkus> (optional): A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. Max count : 50
<startDateTime> (optional): 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 date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
MarketplaceId	string	The identifier of the marketplace
ASIN	string	The Amazon Standard Identification Number (ASIN) of an item
condition	string	The condition of the item as described by the seller (for example, New Item)
fnSku	string	Amazon's fulfillment network SKU identifier
granularityId	string	The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId
granularityType	string	The granularity type for the inventory aggregation level
inventoryDetails_fulfillableQuantity	integer	The item quantity that can be picked, packed, and shipped
inventoryDetails_futureSupplyQuantity_futureSupplyBuyableQuantity	integer	The future item quantity that can be picked, packed, and shipped
inventoryDetails_futureSupplyQuantity_reservedFutureSupplyQuantity	integer	The reserved item quantity that can be picked, packed, and shipped
inventoryDetails_inboundReceivingQuantity	integer	The number of units that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed
inventoryDetails_inboundShippedQuantity	integer	The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number
inventoryDetails_inboundWorkingQuantity	integer	The number of units in an inbound shipment for which you have notified Amazon
inventoryDetails_researchingQuantity_researchingQuantityBreakdown	string	A list of quantity details for items currently being researched
inventoryDetails_researchingQuantity_totalResearchingQuantity	integer	The total number of units currently being researched in Amazon's fulfillment network
inventoryDetails_reservedQuantity_fcProcessingQuantity	integer	The number of units that have been sidelined at the fulfillment center for additional processing
inventoryDetails_reservedQuantity_pendingCustomerOrderQuantity	integer	The number of units reserved for customer orders
inventoryDetails_reservedQuantity_pendingTransshipmentQuantity	integer	The number of units being transferred from one fulfillment center to another
inventoryDetails_reservedQuantity_totalReservedQuantity	integer	The total number of units in Amazon's fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes
inventoryDetails_unfulfillableQuantity_carrierDamagedQuantity	integer	The number of units in carrier damaged disposition
inventoryDetails_unfulfillableQuantity_customerDamagedQuantity	integer	The number of units in customer damaged disposition
inventoryDetails_unfulfillableQuantity_defectiveQuantity	integer	The number of units in defective disposition
inventoryDetails_unfulfillableQuantity_distributorDamagedQuantity	integer	The number of units in distributor damaged disposition
inventoryDetails_unfulfillableQuantity_expiredQuantity	integer	The number of units in expired disposition
inventoryDetails_unfulfillableQuantity_totalUnfulfillableQuantity	integer	The total number of units in Amazon's fulfillment network in unsellable condition
inventoryDetails_unfulfillableQuantity_warehouseDamagedQuantity	integer	The number of units in warehouse damaged disposition
lastUpdatedTime	timestamp	The date and time that any quantity was last updated
productName	string	The localized language product title of the item within the specific marketplace
sellerSku	string	The seller SKU of the item
totalQuantity	integer	The total number of units in an inbound shipment or in Amazon fulfillment centers

Example

SQL

CREATE VIEW amazon_sp_examples.example_InventorySummaries AS 
	SELECT * 
	FROM (
		CALL amazon_sp.InventorySummaries (
			startDateTime => NULL,
			sellerSkus => NULL,
			marketplaceIds => 'ATVPDKIKX0DER',
			details => true
		)
	) AS x

ItemEligibilityPreview

Eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item's eligibility
Parameter
<asin> (required): The ASIN of the item for which you want an eligibility preview
<marketplaceIds> (optional): The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND. Max count : 1
<program> (required): The program that you want to check eligibility against
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The marketplace for which eligibility was determined
ASIN	string	The ASIN of the item for which you want an eligibility preview
ineligibilityReasonList	string	Potential Ineligibility Reason Codes
isEligibleForProgram	boolean	Indicates if the item is eligible for the program
program	boolean	The program that you want to check eligibility against

Example

SQL

CREATE VIEW amazon_sp_examples.example_ItemEligibilityPreview AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ItemEligibilityPreview (
			program => 'program',
			marketplaceIds => 'ATVPDKIKX0DER',
			asin => 'B08SG2QJGH'
		)
	) AS x

ItemOffers

Lowest priced offers for items based on ASIN
Parameter
<ASIN> (optional): The Amazon Standard Identification Number (ASIN) of the item
<CustomerType> (optional): Indicates whether to request Consumer or Business offers. Default is Consumer
<ItemCondition> (required): Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club
<MarketplaceId> (optional): A marketplace identifier. Specifies the marketplace for which prices are returned
<asin_table> (optional): A table that has asin column
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label

Attribute	Type	Description
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item. The payload for the getListingOffers and getItemOffers operations
ItemCondition	string	The condition of the item. Values : New, Used, Collectible, Refurbished, Club
MarketplaceId	string	A marketplace identifier
Offers_ConditionNotes	string	Information about the condition of the item
Offers_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
Offers_IsFeaturedMerchant	boolean	When true, the seller of the item is eligible to win the Buy Box
Offers_IsFulfilledByAmazon	boolean	When true, the offer is fulfilled by Amazon
Offers_ListingPrice_Amount	bigdecimal	The monetary value. The price of the item
Offers_ListingPrice_CurrencyCode	string	The currency code in ISO 4217 format. The price of the item
Offers_MyOffer	boolean	When true, this is the seller's offer
Offers_offerType	string	Indicates the type of customer that the offer is valid for. Values : B2C, B2B
Offers_Points_PointsMonetaryValue_Amount	bigdecimal	The monetary value. The monetary value of the points
Offers_Points_PointsMonetaryValue_CurrencyCode	string	The currency code in ISO 4217 format. The monetary value of the points
Offers_Points_PointsNumber	integer	The number of points
Offers_PrimeInformation_IsNationalPrime	boolean	Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. Amazon Prime information
Offers_PrimeInformation_IsPrime	boolean	Indicates whether the offer is an Amazon Prime offer. Amazon Prime information
Offers_QuantityDiscountPrices_listingPrice_Amount	bigdecimal	The monetary value. The price at this quantity tier
Offers_QuantityDiscountPrices_listingPrice_CurrencyCode	string	The currency code in ISO 4217 format. The price at this quantity tier
Offers_QuantityDiscountPrices_quantityDiscountType	string	Indicates the type of quantity discount this price applies to. Values : QUANTITY_DISCOUNT
Offers_QuantityDiscountPrices_quantityTier	integer	Indicates at what quantity this price becomes active
Offers_SellerFeedbackRating_FeedbackCount	long	The number of ratings received about the seller. Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received
Offers_SellerFeedbackRating_SellerPositiveFeedbackRating	bigdecimal	The percentage of positive feedback for the seller in the past 365 days. Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received
Offers_SellerId	string	The seller identifier for the offer
Offers_Shipping_Amount	bigdecimal	The monetary value. The price of the item
Offers_Shipping_CurrencyCode	string	The currency code in ISO 4217 format. The price of the item
Offers_ShippingTime_availabilityType	string	Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping. Possible values: NOW, FUTURE_WITHOUT_DATE, FUTURE_WITH_DATE. Descriptions: NOW - The item is available for shipping now FUTURE_WITHOUT_DATE - The item will be available for shipping on an unknown date in the future FUTURE_WITH_DATE - The item will be available for shipping on a known date in the future. The maximum time within which the item will likely be shipped once an order has been placed
Offers_ShippingTime_availableDate	date	The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. The maximum time within which the item will likely be shipped once an order has been placed
Offers_ShippingTime_maximumHours	long	The maximum time, in hours, that the item will likely be shipped after the order has been placed. The maximum time within which the item will likely be shipped once an order has been placed
Offers_ShippingTime_minimumHours	long	The minimum time, in hours, that the item will likely be shipped after the order has been placed. The maximum time within which the item will likely be shipped once an order has been placed
Offers_ShipsFrom_Country	string	The country from where the item is shipped. The state and country from where the item is shipped
Offers_ShipsFrom_State	string	The state from where the item is shipped. The state and country from where the item is shipped
Offers_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
SKU	string	The stock keeping unit (SKU) of the item. The payload for the getListingOffers and getItemOffers operations
status	string	The status of the operation. The payload for the getListingOffers and getItemOffers operations
Summary_BuyBoxEligibleOffers_Csv	string
Summary_CompetitivePriceThreshold_Amount	bigdecimal	The monetary value. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_CompetitivePriceThreshold_CurrencyCode	string	The currency code in ISO 4217 format. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_ListPrice_Amount	bigdecimal	The monetary value. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_ListPrice_CurrencyCode	string	The currency code in ISO 4217 format. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_NumberOfOffers_Csv	string	A list that contains the total number of offers for the item for the given conditions and fulfillment channels
Summary_OffersAvailableTime	timestamp	When the status is ActiveButTooSoonForProcessing, this is the time when the offers will be available for processing
Summary_SalesRankings_Csv	string
Summary_SuggestedLowerPricePlusShipping_Amount	bigdecimal	The monetary value. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_SuggestedLowerPricePlusShipping_CurrencyCode	string	The currency code in ISO 4217 format. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_TotalOfferCount	integer	The number of unique offers contained in NumberOfOffers

Example

SQL

CREATE VIEW amazon_sp_examples.example_ItemOffers AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ItemOffers (
			MarketplaceId => 'A1PA6795UKMFR9',
			ItemCondition => 'New',
			CustomerType => 'Business',
			Asin => 'B07V6M4S3M'
		)
	) AS x

KioskDocument

Data Kiosk document's contents
Parameter
<documentId> (required): The identifier for the Data Kiosk document
<label> (optional): Multi-tenancy label

Attribute	Type	Description
documentId	string	The identifier for the Data Kiosk document. This identifier is unique only in combination with a selling partner account ID
documentUrl	string	A presigned URL that can be used to retrieve the Data Kiosk document. This URL expires after 5 minutes. If the Data Kiosk document is compressed, the Content-Encoding header will indicate the compression algorithm. Note: Most HTTP clients are capable of automatically decompressing downloaded files based on the Content-Encoding header

Example

SQL

CREATE OR REPLACE VIEW amazon_sp_examples.example_KioskDocument AS 
	SELECT * 
	FROM (
		CALL amazon_sp.KioskDocument (
			documentId => 'amzn1.tortuga.4.na.b866f9f3-0cf7-4086-9231-7f26114b50a3.T2PBXALTVYNY6Q'
		)
	) AS x;;

KioskQueries

Details for the Data Kiosk queries that match the specified filters
Parameter
<createdSince> (optional): The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago
<createdUntil> (optional): The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the getQueries request
<processingStatuses> (optional): A list of processing statuses used to filter queries. Min count : 1
<queryId> (optional): The query identifier
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
createdTime	timestamp	The date and time when the query was created, in ISO 8601 date time format
dataDocumentId	string	The data document identifier. This identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the getDocument operation to get the information required to retrieve the data document's contents
processingEndTime	timestamp	The date and time when the query processing completed, in ISO 8601 date time format
processingStartTime	timestamp	The date and time when the query processing started, in ISO 8601 date time format
processingStatus	string	The processing status of the query
query	string	The submitted query
queryId	string	The query identifier. This identifier is unique only in combination with a selling partner account ID

Example

SQL

CREATE OR REPLACE VIEW amazon_sp_examples.example_KioskQueries AS 
	SELECT * 
	FROM (
		CALL amazon_sp.KioskQueries (
			createdSince => NULL,
			createdUntil => NULL,
			processingStatuses => 'DONE,CANCELLED,FATAL,IN_PROGRESS,IN_QUEUE'
		)
	) AS x;;

ListingOffers

Lowest priced offers for SKU listing
Parameter
<CustomerType> (optional): Indicates whether to request Consumer or Business offers. Default is Consumer
<ItemCondition> (required): Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club
<MarketplaceId> (optional): A marketplace identifier. Specifies the marketplace for which prices are returned
<SellerSKU> (required): Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit
<sku_table> (optional): A table that has asin column
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label

Attribute	Type	Description
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item. The payload for the getListingOffers and getItemOffers operations
ItemCondition	string	The condition of the item. Values : New, Used, Collectible, Refurbished, Club
MarketplaceId	string	A marketplace identifier
Offers_ConditionNotes	string	Information about the condition of the item
Offers_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
Offers_IsFeaturedMerchant	boolean	When true, the seller of the item is eligible to win the Buy Box
Offers_IsFulfilledByAmazon	boolean	When true, the offer is fulfilled by Amazon
Offers_ListingPrice_Amount	bigdecimal	The monetary value. The price of the item
Offers_ListingPrice_CurrencyCode	string	The currency code in ISO 4217 format. The price of the item
Offers_MyOffer	boolean	When true, this is the seller's offer
Offers_offerType	string	Indicates the type of customer that the offer is valid for. Values : B2C, B2B
Offers_Points_PointsMonetaryValue_Amount	bigdecimal	The monetary value. The monetary value of the points
Offers_Points_PointsMonetaryValue_CurrencyCode	string	The currency code in ISO 4217 format. The monetary value of the points
Offers_Points_PointsNumber	integer	The number of points
Offers_PrimeInformation_IsNationalPrime	boolean	Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. Amazon Prime information
Offers_PrimeInformation_IsPrime	boolean	Indicates whether the offer is an Amazon Prime offer. Amazon Prime information
Offers_QuantityDiscountPrices_listingPrice_Amount	bigdecimal	The monetary value. The price at this quantity tier
Offers_QuantityDiscountPrices_listingPrice_CurrencyCode	string	The currency code in ISO 4217 format. The price at this quantity tier
Offers_QuantityDiscountPrices_quantityDiscountType	string	Indicates the type of quantity discount this price applies to. Values : QUANTITY_DISCOUNT
Offers_QuantityDiscountPrices_quantityTier	integer	Indicates at what quantity this price becomes active
Offers_SellerFeedbackRating_FeedbackCount	long	The number of ratings received about the seller. Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received
Offers_SellerFeedbackRating_SellerPositiveFeedbackRating	bigdecimal	The percentage of positive feedback for the seller in the past 365 days. Information about the seller's feedback, including the percentage of positive feedback, and the total number of ratings received
Offers_SellerId	string	The seller identifier for the offer
Offers_Shipping_Amount	bigdecimal	The monetary value. The price of the item
Offers_Shipping_CurrencyCode	string	The currency code in ISO 4217 format. The price of the item
Offers_ShippingTime_availabilityType	string	Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping. Possible values: NOW, FUTURE_WITHOUT_DATE, FUTURE_WITH_DATE. Descriptions: NOW - The item is available for shipping now FUTURE_WITHOUT_DATE - The item will be available for shipping on an unknown date in the future FUTURE_WITH_DATE - The item will be available for shipping on a known date in the future. The maximum time within which the item will likely be shipped once an order has been placed
Offers_ShippingTime_availableDate	date	The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. The maximum time within which the item will likely be shipped once an order has been placed
Offers_ShippingTime_maximumHours	long	The maximum time, in hours, that the item will likely be shipped after the order has been placed. The maximum time within which the item will likely be shipped once an order has been placed
Offers_ShippingTime_minimumHours	long	The minimum time, in hours, that the item will likely be shipped after the order has been placed. The maximum time within which the item will likely be shipped once an order has been placed
Offers_ShipsFrom_Country	string	The country from where the item is shipped. The state and country from where the item is shipped
Offers_ShipsFrom_State	string	The state from where the item is shipped. The state and country from where the item is shipped
Offers_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
SKU	string	The stock keeping unit (SKU) of the item. The payload for the getListingOffers and getItemOffers operations
status	string	The status of the operation. The payload for the getListingOffers and getItemOffers operations
Summary_BuyBoxEligibleOffers_Csv	string
Summary_CompetitivePriceThreshold_Amount	bigdecimal	The monetary value. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_CompetitivePriceThreshold_CurrencyCode	string	The currency code in ISO 4217 format. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_ListPrice_Amount	bigdecimal	The monetary value. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_ListPrice_CurrencyCode	string	The currency code in ISO 4217 format. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_NumberOfOffers_Csv	string	A list that contains the total number of offers for the item for the given conditions and fulfillment channels
Summary_OffersAvailableTime	timestamp	When the status is ActiveButTooSoonForProcessing, this is the time when the offers will be available for processing
Summary_SalesRankings_Csv	string
Summary_SuggestedLowerPricePlusShipping_Amount	bigdecimal	The monetary value. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_SuggestedLowerPricePlusShipping_CurrencyCode	string	The currency code in ISO 4217 format. This price is based on competitive prices from other retailers (excluding other Amazon sellers). The offer may be ineligible for the Buy Box if the seller's price + shipping (minus Amazon Points) is greater than this competitive price
Summary_TotalOfferCount	integer	The number of unique offers contained in NumberOfOffers

Example

SQL

CREATE VIEW amazon_sp_examples.example_ListingOffers AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ListingOffers (
			SellerSKU => 'sim800l5er',
			MarketplaceId => 'A1PA6795UKMFR9',
			ItemCondition => 'New',
			CustomerType => 'Business'
		)
	) AS x

ListingsItem

Details about a listings item for a selling partner
Parameter
<includedData> (optional): A comma-delimited list of data sets to include in the response: summaries - Summary details of the listing item; attributes - JSON object containing structured listing item attribute data keyed by attribute name; issues - Issues associated with the listing item; offers - Current offers for the listing item; fulfillmentAvailability - Fulfillment availability details for the listing item; procurement - Vendor procurement details for the listing item
<issueLocale> (optional): A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale
<marketplaceIds> (optional): A comma-delimited list of Amazon marketplace identifiers for the request
<sellerId> (optional): A selling partner identifier, such as a merchant account or vendor code
<sku> (optional): A selling partner provided identifier for an Amazon listing
<sku_table> (optional): A table that has sku column for taking sku from it
<sku_column> (optional): Name of the sku column
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	Amazon marketplace identifier
sellerId	string	A selling partner identifier, such as a merchant account or vendor code
asin	string	Amazon Standard Identification Number (ASIN) of the listings item
sku	string	A selling partner provided identifier for an Amazon listing
conditionType	string	Identifies the condition of the listings item
fnSku	string	Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item
itemName	string	Name, or title, associated with an Amazon catalog item
mainImage_height	integer	Height of the image in pixels
mainImage_link	string	Link, or URL, for the image
mainImage_width	integer	Width of the image in pixels
productType	string	The Amazon product type of the listings item
status	string	Statuses that apply to the listings item
createdDate	date	Date the listings item was created, in ISO 8601 format
lastUpdatedDate	date	Date the listings item was last updated, in ISO 8601 format

Example

SQL

CREATE VIEW amazon_sp_examples.example_ListingsItem AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ListingsItem (
			sku => '15D-UK',
			sellerId => 'A3088BAKABQE8B',
			marketplaceIds => 'A1PA6795UKMFR9',
			issueLocale => 'de_DE',
			includedData => 'summaries,attributes,issues,offers,fulfillmentAvailability,procurement'
		)
	) AS x

ListingsRestrictions

Listing restrictions for an item in the Amazon Catalog
Parameter
<asin> (optional): The Amazon Standard Identification Number (ASIN) of the item
<conditionType> (optional): The condition used to filter restrictions
<marketplaceIds> (optional): A comma-delimited list of Amazon marketplace identifiers for the request
<reasonLocale> (optional): A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale
<sellerId> (optional): A selling partner identifier, such as a merchant account
<asin_table> (optional): A table that has asin column for taking asin from it
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label

Attribute	Type	Description
asin	string	The Amazon Standard Identification Number (ASIN) of the item
marketplaceId	string	A marketplace identifier. Identifies the Amazon marketplace where the restriction is enforced
conditionType	string	The condition that applies to the restriction
message	string	A message describing the reason for the restriction
reasonCode	string	A code indicating why the listing is restricted

Example

SQL

CREATE VIEW amazon_sp_examples.example_ListingsRestrictions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ListingsRestrictions (
			sellerId => 'A3088BAKABQE8B',
			reasonLocale => NULL,
			marketplaceIds => 'A1PA6795UKMFR9',
			conditionType => NULL,
			asin => 'B07QX8XKG4'
		)
	) AS x

MarketplaceParticipations

Marketplaces that the seller submitting the request can sell in and information about the seller's participation in those marketplaces
Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
marketplace_name	string	Marketplace name
marketplace_CountryCode	string	The ISO 3166-1 alpha-2 format country code of the marketplace.
marketplace_defaultCurrencyCode	string	The ISO 4217 format currency code of the marketplace
marketplace_defaultLanguageCode	string	The ISO 639-1 format language code of the marketplace
marketplace_domainName	string	The domain name of the marketplace
participation_hasSuspendedListings	boolean
participation_isParticipating	boolean

Example

SQL

CREATE VIEW amazon_sp_examples.example_MarketplaceParticipations AS 
	SELECT * 
	FROM (
		CALL amazon_sp.MarketplaceParticipations ()
	) AS x

MessagingActionsForOrder

Message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message
Parameter
<amazonOrderId> (required): An Amazon order identifier. This specifies the order for which you want a list of available message types
<marketplaceIds> (optional): A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified. Max count : 1
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The identifier of the marketplace
href	string	A URI for this object
name	string	An identifier for this object

Example

SQL

CREATE VIEW amazon_sp_examples.example_MessagingActionsForOrder AS 
	SELECT * 
	FROM (
		CALL amazon_sp.MessagingActionsForOrder (
			marketplaceIds => 'ATVPDKIKX0DER',
			amazonOrderId => '123-1234567-1234567'
		)
	) AS x

OrderAddress

Detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it's used to retrieve the next page of order items
Parameter
<orderId> (optional): An orderId is an Amazon-defined order identifier, in 3-7-7 format
<order_table> (optional): Table that contains columns: AmazonOrderId, LastUpdateDate, MarketplaceId
<restart_timeout> (optional): Number of seconds berfore restarting data loading
<maintain_history> (optional): Do not delete data that were updated since previous runs
<use_rdt_token> (optional): Use Restricted Data Token (RDT) to get access to customer's Personally Identifiable Information (PII)
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
AmazonOrderId	string	An Amazon-defined order identifier, in 3-7-7 format
BuyerCompanyName	string	Company Name of the Buyer
DeliveryPreferences_AddressInstructions	string	Building instructions, nearby landmark or navigation instructions
DeliveryPreferences_DropOffLocation	string	Drop-off location selected by the customer
DeliveryPreferences_OtherAttributes	string	Enumerated list of miscellaneous delivery attributes associated with the shipping address
DeliveryPreferences_PreferredDeliveryTime_BusinessHours	string	Business hours when the business is open for deliveries
DeliveryPreferences_PreferredDeliveryTime_ExceptionDates	string	Dates when the business is closed in the next 30 days
ShippingAddress_AddressLine1	string	The street address
ShippingAddress_AddressLine2	string	Additional street address information, if required
ShippingAddress_AddressLine3	string	Additional street address information, if required
ShippingAddress_AddressType	string	The address type of the shipping address
ShippingAddress_City	string	The city
ShippingAddress_CountryCode	string	The country code. A two-character country code, in ISO 3166-1 alpha-2 format
ShippingAddress_County	string	The county
ShippingAddress_District	string	The district
ShippingAddress_ExtendedFields_Complement	string	The floor number/unit number in the building/private house number
ShippingAddress_ExtendedFields_Neighborhood	string	The neighborhood. It's smaller than a region and an integral part of an address. It is used in some countries like Brazil
ShippingAddress_ExtendedFields_StreetName	string	The street name
ShippingAddress_ExtendedFields_StreetNumber	string	The house number/building number/property number in the street
ShippingAddress_Municipality	string	The municipality
ShippingAddress_Name	string	The name
ShippingAddress_Phone	string	The phone number. Not returned for Fulfillment by Amazon (FBA) orders
ShippingAddress_PostalCode	string	The postal code
ShippingAddress_StateOrRegion	string	The state or region

Example

SQL

CREATE VIEW amazon_sp_examples.example_OrderAddress AS 
	SELECT * 
	FROM (
		CALL amazon_sp.OrderAddress (
			orderId => '114-8544918-8081842'
		)
	) AS x;;

OrderBuyerInfo

Detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it's used to retrieve the next page of order items
Parameter
<orderId> (optional): An orderId is an Amazon-defined order identifier, in 3-7-7 format
<order_table> (optional): Table that contains columns: AmazonOrderId, LastUpdateDate, MarketplaceId
<restart_timeout> (optional): Number of seconds berfore restarting data loading
<maintain_history> (optional): Do not delete data that were updated since previous runs
<use_rdt_token> (optional): Use Restricted Data Token (RDT) to get access to customer's Personally Identifiable Information (PII)
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
AmazonOrderId	string	An Amazon-defined order identifier, in 3-7-7 format
BuyerCounty	string	The county of the buyer
BuyerEmail	string	The anonymized email address of the buyer
BuyerName	string	The name of the buyer
BuyerTaxInfo_CompanyLegalName	string	The legal name of the company
BuyerTaxInfo_TaxClassifications	string	A list of tax classifications that apply to the order
BuyerTaxInfo_TaxingRegion	string	The country or region imposing the tax
PurchaseOrderNumber	string	The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout

Example

SQL

CREATE VIEW amazon_sp_examples.example_OrderBuyerInfo AS 
	SELECT * 
	FROM (
		CALL amazon_sp.OrderBuyerInfo (
			orderId => '114-8544918-8081842'
		)
	) AS x;;

OrderItems

Detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it's used to retrieve the next page of order items
Parameter
<orderId> (optional): An orderId is an Amazon-defined order identifier, in 3-7-7 format
<order_table> (optional): Table that contains columns: AmazonOrderId, LastUpdateDate, MarketplaceId
<restart_timeout> (optional): Number of seconds berfore restarting data loading
<maintain_history> (optional): Do not delete data that were updated since previous runs
<use_rdt_token> (optional): Use Restricted Data Token (RDT) to get access to customer's Personally Identifiable Information (PII)
<rdt_resource_elements> (optional): Indicates the type of Personally Identifiable Information requested. Possible values include: buyerInfo,shippingAddress,buyerTaxInformation. buyerInfo - on the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available. - shippingAddress - this includes information for fulfilling orders. - buyerTaxInformation - this includes information for issuing tax invoices.
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
AmazonOrderId	string	An Amazon-defined order identifier, in 3-7-7 format
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item
OrderItemId	string	An Amazon-defined order item identifier
AssociatedItems	string	A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires
BuyerInfo_BuyerCustomizedInfo_CustomizedURL	string	The location of a zip file containing Amazon Custom data
BuyerInfo_GiftMessageText	string	A gift message provided by the buyer
BuyerInfo_GiftWrapLevel	string	The gift wrap level specified by the buyer
BuyerInfo_GiftWrapPrice_Amount	bigdecimal	The currency amount
BuyerInfo_GiftWrapPrice_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
BuyerInfo_GiftWrapTax_Amount	bigdecimal	The currency amount
BuyerInfo_GiftWrapTax_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
BuyerRequestedCancel_BuyerCancelReason	string	The reason that the buyer requested cancellation
BuyerRequestedCancel_IsBuyerRequestedCancel	boolean	When true, the buyer has requested cancellation
CODFee_Amount	bigdecimal	The currency amount
CODFee_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
CODFeeDiscount_Amount	bigdecimal	The currency amount
CODFeeDiscount_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
ConditionId	string	The condition of the item. Possible values: New, Used, Collectible, Refurbished, Preorder, Club
ConditionNote	string	The condition of the item as described by the seller
ConditionSubtypeId	string	The subcondition of the item. Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, Any, Other
DeemedResellerCategory	string	The category of deemed reseller. This 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
IossNumber	string	The IOSS number for the marketplace. Sellers shipping to the European Union (EU) from outside of the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale
IsGift	boolean	When true, the item is a gift
IsTransparency	boolean	When true, the ASIN is enrolled in Transparency and the Transparency serial number that needs to be submitted can be determined by the following: 1D or 2D Barcode: This has a T logo. Submit either the 29-character alpha-numeric identifier beginning with AZ or ZA, or the 38-character Serialized Global Trade Item Number (SGTIN). 2D Barcode SN: Submit the 7- to 20-character serial number barcode, which likely has the prefix SN. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode. QR code SN: Submit the URL that the QR code generates
ItemPrice_Amount	bigdecimal	The currency amount
ItemPrice_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
ItemTax_Amount	bigdecimal	The currency amount
ItemTax_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
Measurement_Unit	string	The unit of measure for this measurement
Measurement_Value	bigdecimal	The value of the measurement
PointsGranted_PointsMonetaryValue_Amount	bigdecimal	The currency amount
PointsGranted_PointsMonetaryValue_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
PointsGranted_PointsNumber	integer	The number of Amazon Points granted with the purchase of an item
PriceDesignation	string	Indicates that the selling price is a special price that is available only for Amazon Business orders. For more information about the Amazon Business Seller Program, see the Amazon Business website. Possible values: BusinessPrice - A special price that is available only for Amazon Business orders
ProductInfo_NumberOfItems	integer	The total number of items that are included in the ASIN
PromotionDiscount_Amount	bigdecimal	The currency amount
PromotionDiscount_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
PromotionDiscountTax_Amount	bigdecimal	The currency amount
PromotionDiscountTax_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
PromotionIds	string	A list of promotion identifiers provided by the seller when the promotions were created
QuantityOrdered	integer	The number of items in the order
QuantityShipped	integer	The number of items shipped
ScheduledDeliveryEndDate	timestamp	The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format
ScheduledDeliveryStartDate	timestamp	The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format
SellerSKU	string	The seller stock keeping unit (SKU) of the item
SerialNumberRequired	boolean	When true, the product type for this item has a serial number. Returned only for Amazon Easy Ship orders
SerialNumbers	string	A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only
ShippingDiscount_Amount	bigdecimal	The currency amount
ShippingDiscount_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
ShippingDiscountTax_Amount	bigdecimal	The currency amount
ShippingDiscountTax_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
ShippingPrice_Amount	bigdecimal	The currency amount
ShippingPrice_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
ShippingTax_Amount	bigdecimal	The currency amount
ShippingTax_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
StoreChainStoreId	string	The store chain store identifier. Linked to a specific store in a store chain
SubstitutionPreferences_SubstitutionType	string	The type of substitution that these preferences represent
TaxCollection_Model	string	The tax collection model applied to the item
TaxCollection_ResponsibleParty	string	The party responsible for withholding the taxes and remitting them to the taxing authority
Title	string	The name of the item

Example

SQL

CREATE VIEW amazon_sp_examples.example_OrderItems AS 
	SELECT * 
	FROM (
		CALL amazon_sp.OrderItems (
			orderId => '114-8544918-8081842'
		)
	) AS x;;

OrderItemsBuyerInfo

Orders items buyer information
Parameter
<orderId> (optional): An orderId is an Amazon-defined order identifier, in 3-7-7 format
<order_table> (optional): Table that contains columns: AmazonOrderId, LastUpdateDate, MarketplaceId
<restart_timeout> (optional): Number of seconds berfore restarting data loading
<maintain_history> (optional): Do not delete data that were updated since previous runs
<use_rdt_token> (optional): Use Restricted Data Token (RDT) to get access to customer's Personally Identifiable Information (PII)
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
AmazonOrderId	string	An Amazon-defined order identifier, in 3-7-7 format
OrderItemId	string	An Amazon-defined order item identifier
BuyerCustomizedInfo_CustomizedURL	string	The location of a zip file containing Amazon Custom data
GiftMessageText	string	A gift message provided by the buyer
GiftWrapLevel	string	The gift wrap level specified by the buyer
GiftWrapPrice_Amount	bigdecimal	The currency amount
GiftWrapPrice_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
GiftWrapTax_Amount	bigdecimal	The currency amount
GiftWrapTax_CurrencyCode	string	The three-digit currency code. In ISO 4217 format

Example

SQL

CREATE VIEW amazon_sp_examples.example_OrderItemsBuyerInfo AS 
	SELECT * 
	FROM (
		CALL amazon_sp.OrderItemsBuyerInfo (
			orderId => '114-8544918-8081842'
		)
	) AS x;;

OrderMetrics

Aggregated order metrics for given interval, broken down by granularity, for given buyer type
Parameter
<interval_start> (optional): Start time of interval used for selecting order metrics
<interval_end> (optional): Start time of interval used for selecting order metrics
<asin> (optional): 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. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN
<buyerType> (optional): 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
<firstDayOfWeek> (optional): Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday
<fulfillmentNetwork> (optional): 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. Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network
<granularity> (required): 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. Specifying granularity=Total results in order metrics that are aggregated over the entire interval that you specify. If the interval start and end date don't align with the specified granularity, the head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of the request interval, where the day boundary is defined by the granularityTimeZone
<granularityTimeZone> (optional): 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. For example, if the interval value uses Z notation, then granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting for daylight time savings, for US/Pacific zone
<marketplaceIds> (optional): A list of marketplace identifiers. Example: ATVPDKIKX0DER indicates the US marketplace
<sku> (optional): 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. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
MarketplaceId	string	The identifier for the marketplace
interval_start	timestamp	The interval of time based on requested granularity (ex. Hour, Day, etc.) If this is the first or the last interval from the list, it might contain incomplete data if the requested interval doesn't align with the requested granularity (ex. request interval 2018-09-01T02:00:00Z--2018-09-04T19:00:00Z and granularity day will result in Sept 1st UTC day and Sept 4th UTC days having partial data)
interval_end	timestamp	The interval of time based on requested granularity (ex. Hour, Day, etc.) If this is the first or the last interval from the list, it might contain incomplete data if the requested interval doesn't align with the requested granularity (ex. request interval 2018-09-01T02:00:00Z--2018-09-04T19:00:00Z and granularity day will result in Sept 1st UTC day and Sept 4th UTC days having partial data)
averageUnitPrice_amount	bigdecimal	The currency amount
averageUnitPrice_CurrencyCode	string	Three-digit currency code. In ISO 4217 format
orderCount	integer	The number of orders based on the specified filters
orderItemCount	integer	The number of order items based on the specified filters
totalSales_amount	bigdecimal	The currency amount
totalSales_CurrencyCode	string	Three-digit currency code. In ISO 4217 format
unitCount	integer	The number of units in orders based on the specified filters

Example

SQL

CREATE VIEW amazon_sp_examples.example_OrderMetrics AS 
	SELECT * 
	FROM (
		CALL amazon_sp.OrderMetrics (
			sku => NULL,
			marketplaceIds => 'A1PA6795UKMFR9',
			interval_start => TIMESTAMPADD (SQL_TSI_DAY, -30, CURDATE ()),
			interval_end => CURDATE (),
			granularityTimeZone => NULL,
			granularity => 'Total',
			fulfillmentNetwork => NULL,
			firstDayOfWeek => 'Monday',
			buyerType => 'All',
			asin => NULL
		)
	) AS x

Orders

Orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria
Parameter
<AmazonOrderIds> (optional): A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format. Max count : 50
<BuyerEmail> (optional): The email address of a buyer. Used to select orders that contain the specified email address
<CreatedAfter> (optional): A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format
<CreatedBefore> (optional): A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format
<EasyShipShipmentStatuses> (optional): A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller)
<FulfillmentChannels> (optional): A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller)
<LastUpdatedAfter> (optional): A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format
<LastUpdatedBefore> (optional): A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format
<MarketplaceIds> (optional): A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. Max count : 50
<OrderStatuses> (optional): A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
<PaymentMethods> (optional): A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS)
<SellerOrderId> (optional): An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified
<orderId> (optional): An Amazon-defined order identifier, in 3-7-7 format
<days_step> (optional): Number of days to query in a single batch. If set to 0 the data will be saved in loop after requesting and loading every 100 records
<restart_timeout> (optional): Number of seconds berfore restarting data loading
<maintain_history> (optional): Do not delete data that were updated since previous runs
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<use_rdt_token> (optional): Use Restricted Data Token (RDT) to get access to customer's Personally Identifiable Information (PII)
<use_rdt_token_for_subordinate_tables> (optional): Use Restricted Data Token (RDT) to get access to customer's Personally Identifiable Information (PII) for subordinate tables: Items, Address, BuyerInfo, ItemsBuyerInfo
<rdt_resource_elements> (optional): CSV list of types of Personally Identifiable Information to request. Possible values include: buyerInfo,shippingAddress,buyerTaxInformation. buyerInfo - on the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available. - shippingAddress - this includes information for fulfilling orders. - buyerTaxInformation - this includes information for issuing tax invoices.
<rdt_items_resource_elements> (optional): CSV list of types of Personally Identifiable Information to request for subordinate table Items. Possible values include: buyerInfo,shippingAddress,buyerTaxInformation. buyerInfo - on the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available. - shippingAddress - this includes information for fulfilling orders. - buyerTaxInformation - this includes information for issuing tax invoices.
<with_Items> (optional): Save detailed order item information into a separate subordinate table along with orders (if parameter target_table is set)
<with_Address> (optional): Save shipping address into a separate subordinate table along with orders (if parameter target_table is set)
<with_BuyerInfo> (optional): Save buyer information into a separate subordinate table along with orders (if parameter target_table is set)
<with_ItemsBuyerInfo> (optional): Save buyer information for the order items into a separate subordinate table along with orders (if parameter target_table is set)
<label> (optional): Multi-tenancy label

Attribute	Type	Description
AmazonOrderId	string	An Amazon-defined order identifier, in 3-7-7 format
AutomatedShippingSettings_AutomatedCarrier	string	Auto-generated carrier for SSA orders
AutomatedShippingSettings_AutomatedShipMethod	string	Auto-generated ship method for SSA orders
AutomatedShippingSettings_HasAutomatedShippingSettings	boolean	When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order
BuyerInfo_BuyerCounty	string	The county of the buyer
BuyerInfo_BuyerEmail	string	The anonymized email address of the buyer
BuyerInfo_BuyerName	string	The buyer name or the recipient name
BuyerInfo_BuyerTaxInfo_CompanyLegalName	string	The legal name of the company
BuyerInfo_BuyerTaxInfo_TaxClassifications	string	A list of tax classifications that apply to the order
BuyerInfo_BuyerTaxInfo_TaxingRegion	string	The country or region imposing the tax
BuyerInfo_PurchaseOrderNumber	string	The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout
BuyerInvoicePreference	string	The buyer's invoicing preference. Available only in the TR marketplace
BuyerTaxInformation_BuyerBusinessAddress	string	Business buyer's address
BuyerTaxInformation_BuyerLegalCompanyName	string	Business buyer's company legal name
BuyerTaxInformation_BuyerTaxOffice	string	Business buyer's tax office
BuyerTaxInformation_BuyerTaxRegistrationId	string	Business buyer's tax registration ID
CbaDisplayableShippingLabel	string	Custom ship label for Checkout by Amazon (CBA)
DefaultShipFromLocationAddress_AddressLine1	string	The street address
DefaultShipFromLocationAddress_AddressLine2	string	Additional street address information, if required
DefaultShipFromLocationAddress_AddressLine3	string	Additional street address information, if required
DefaultShipFromLocationAddress_AddressType	string	The address type of the shipping address
DefaultShipFromLocationAddress_City	string	The city
DefaultShipFromLocationAddress_CountryCode	string	The country code. A two-character country code, in ISO 3166-1 alpha-2 format
DefaultShipFromLocationAddress_County	string	The county
DefaultShipFromLocationAddress_District	string	The district
DefaultShipFromLocationAddress_ExtendedFields_Complement	string	The floor number/unit number in the building/private house number
DefaultShipFromLocationAddress_ExtendedFields_Neighborhood	string	The neighborhood. It's smaller than a region and an integral part of an address. It is used in some countries like Brazil
DefaultShipFromLocationAddress_ExtendedFields_StreetName	string	The street name
DefaultShipFromLocationAddress_ExtendedFields_StreetNumber	string	The house number/building number/property number in the street
DefaultShipFromLocationAddress_Municipality	string	The municipality
DefaultShipFromLocationAddress_Name	string	The name
DefaultShipFromLocationAddress_Phone	string	The phone number. Not returned for Fulfillment by Amazon (FBA) orders
DefaultShipFromLocationAddress_PostalCode	string	The postal code
DefaultShipFromLocationAddress_StateOrRegion	string	The state or region
EarliestDeliveryDate	timestamp	The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders
EarliestShipDate	timestamp	The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. Note: EarliestShipDate might not be returned for orders placed before February 1, 2013
EasyShipShipmentStatus	string	The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders
ElectronicInvoiceStatus	string	The status of the electronic invoice
FulfillmentChannel	string	Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN)
FulfillmentInstruction_FulfillmentSupplySourceId	string	Denotes the recommended sourceId where the order should be fulfilled from
HasRegulatedItems	boolean	Whether the order contains regulated items which may require additional approval steps before being fulfilled
IsAccessPointOrder	boolean	When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers
IsBusinessOrder	boolean	When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer
IsEstimatedShipDateSet	boolean	When true, the estimated ship date is set for the order. Returned only for Sourcing on Demand orders
IsGlobalExpressEnabled	boolean	When true, the order is a GlobalExpress order
IsIBA	boolean	When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller
IsISPU	boolean	When true, this order is marked to be picked up from a store rather than delivered
IsPremiumOrder	boolean	When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, see "Premium Shipping Options" in the Seller Central Help for your marketplace
IsPrime	boolean	When true, the order is a seller-fulfilled Amazon Prime order
IsReplacementOrder	boolean	When true, this is a replacement order
IsSoldByAB	boolean	When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller
LastUpdateDate	timestamp	The date when the order was last updated. Note: LastUpdateDate is returned with an incorrect date for orders that were last updated before 2009-04-01
LatestDeliveryDate	timestamp	The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status
LatestShipDate	timestamp	The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders. Note: LatestShipDate might not be returned for orders placed before February 1, 2013
MarketplaceId	string	The identifier for the marketplace where the order was placed
MarketplaceTaxInfo_TaxClassifications	string	A list of tax classifications that apply to the order
NumberOfItemsShipped	integer	The number of items shipped
NumberOfItemsUnshipped	integer	The number of items unshipped
OrderChannel	string	The order channel of the first item in the order
OrderStatus	string	The current order status
OrderTotal_Amount	bigdecimal	The currency amount
OrderTotal_CurrencyCode	string	The three-digit currency code. In ISO 4217 format
OrderType	string	The type of the order
PaymentExecutionDetail	string	Information about sub-payment methods for a Cash On Delivery (COD) order. Note: For a COD order that is paid for using one sub-payment method, one PaymentExecutionDetailItem object is returned, with PaymentExecutionDetailItem/PaymentMethod = COD. For a COD order that is paid for using multiple sub-payment methods, two or more PaymentExecutionDetailItem objects are returned
PaymentMethod	string	The payment method for the order. This property is limited to Cash On Delivery (COD) and Convenience Store (CVS) payment methods. Unless you need the specific COD payment information provided by the PaymentExecutionDetailItem object, we recommend using the PaymentMethodDetails property to get payment method information
PaymentMethodDetails	string	A list of payment methods for the order
PromiseResponseDueDate	date	Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders
PurchaseDate	timestamp	The date when the order was created
ReplacedOrderId	string	The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true
SalesChannel	string	The sales channel of the first item in the order
SellerDisplayName	string	The seller's friendly name registered in the marketplace
SellerOrderId	string	A seller-defined order identifier
ShipmentServiceLevelCategory	string	The shipment service level category of the order. Possible values: Expedited, FreeEconomy, NextDay, Priority, SameDay, SecondDay, Scheduled, Standard
ShippingAddress_AddressLine1	string	The street address
ShippingAddress_AddressLine2	string	Additional street address information, if required
ShippingAddress_AddressLine3	string	Additional street address information, if required
ShippingAddress_AddressType	string	The address type of the shipping address
ShippingAddress_City	string	The city
ShippingAddress_CountryCode	string	The country code. A two-character country code, in ISO 3166-1 alpha-2 format
ShippingAddress_County	string	The county
ShippingAddress_District	string	The district
ShippingAddress_ExtendedFields_Complement	string	The floor number/unit number in the building/private house number
ShippingAddress_ExtendedFields_Neighborhood	string	The neighborhood. It's smaller than a region and an integral part of an address. It is used in some countries like Brazil
ShippingAddress_ExtendedFields_StreetName	string	The street name
ShippingAddress_ExtendedFields_StreetNumber	string	The house number/building number/property number in the street
ShippingAddress_Municipality	string	The municipality
ShippingAddress_Name	string	The name
ShippingAddress_Phone	string	The phone number. Not returned for Fulfillment by Amazon (FBA) orders
ShippingAddress_PostalCode	string	The postal code
ShippingAddress_StateOrRegion	string	The state or region
ShipServiceLevel	string	The shipment service level of the order

Example

SQL

CREATE VIEW amazon_sp_examples.example_Orders AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Orders (
			SellerOrderId => NULL,
			PaymentMethods => NULL,
			OrderStatuses => NULL,
			MarketplaceIds => 'ATVPDKIKX0DER',
			LastUpdatedBefore => NULL,
			LastUpdatedAfter => NULL,
			FulfillmentChannels => NULL,
			EasyShipShipmentStatuses => NULL,
			CreatedBefore => NULL,
			CreatedAfter => TIMESTAMPADD (SQL_TSI_MONTH, -1, CURDATE ()),
			BuyerEmail => NULL,
			AmazonOrderIds => NULL
		)
	) AS x;;

PackageTrackingDetails

Delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order
Parameter
<packageNumber> (required): The unencrypted package identifier returned by the getFulfillmentOrder operation
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
trackingNumber	string	The tracking number for the package
additionalLocationInfo	string	Additional location information
carrierCode	string	The name of the carrier
currentStatus	string	The current delivery status of the package
currentStatusDescription	string	Description corresponding to the CurrentStatus value
customerTrackingLink	string	Link on swiship.com that allows customers to track the package
packageNumber	integer	The unencrypted package identifier returned by the getFulfillmentOrder operation
shipToAddress_city	string	The city
shipToAddress_country	string	The country
shipToAddress_state	string	The state
trackingEvents_eventAddress_city	string	The city
trackingEvents_eventAddress_country	string	The country
trackingEvents_eventAddress_state	string	The state
trackingEvents_eventCode	string	The event code for the delivery event
trackingEvents_eventDate	timestamp	The date and time that the delivery event took place, in ISO 8601 date time format
trackingEvents_eventDescription	string	A description for the corresponding event code

Example

SQL

CREATE VIEW amazon_sp_examples.example_PackageTrackingDetails AS 
	SELECT * 
	FROM (
		CALL amazon_sp.PackageTrackingDetails (
			packageNumber => 212794778
		)
	) AS x

PrepInstructions

Labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network
Parameter
<ASINList> (optional): A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. Max count : 50
<SellerSKUList> (optional): A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response. Max count : 50
<ShipToCountryCode> (required): The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item
AmazonPrepFeesDetailsList_FeePerUnit_CurrencyCode	string	The currency code
AmazonPrepFeesDetailsList_FeePerUnit_Value	bigdecimal	The amount
AmazonPrepFeesDetailsList_PrepInstruction	string	Preparation instructions for shipping an item to Amazon's fulfillment network. For more information about preparing items for shipment to Amazon's fulfillment network, see the Seller Central Help for your marketplace
BarcodeInstruction	string	Labeling requirements for the item. For more information about FBA labeling requirements, see the Seller Central Help for your marketplace
ErrorReason	string	The reason why the seller SKU is invalid
PrepGuidance	string	Item preparation instructions
PrepInstructionList	string	A list of preparation instructions to help with item sourcing decisions
SellerSKU	string	The seller SKU of the item
list	string	A list of invalid SKU values and the reason they are invalid

Example

SQL

CREATE VIEW amazon_sp_examples.example_PrepInstructions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.PrepInstructions (
			ShipToCountryCode => 'US',
			SellerSKUList => NULL,
			ASINList => 'B08SG2QJGH'
		)
	) AS x

Pricing

Pricing information for a seller's offer listings based on seller SKU or ASIN
Parameter
<Asins> (optional): A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace
<Skus> (optional): A list of up to twenty seller SKU values used to identify items in the given marketplace
<asin_table> (optional): A table that has asin column
<sku_table> (optional): A table that has sku column
<ItemCondition> (required): Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club
<MarketplaceId> (optional): A marketplace identifier. Specifies the marketplace for which prices are returned
<OfferType> (optional): Indicates whether to request pricing information for the seller's B2C or B2B offers. Default is B2C
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<maintain_history> (optional): Do not delete earlier data
<label> (optional): Multi-tenancy label

Attribute	Type	Description
MarketplaceId	string	The identifier of the marketplace
ASIN	string	The Amazon Standard Identification Number (ASIN) of the item
NumberOfOfferListings	string	The number of active offer listings for the item that was submitted. The listing count is returned by condition, one for each listing condition value that is returned
Offers_BuyingPrice_LandedPrice_Amount	bigdecimal	The monetary value
Offers_BuyingPrice_LandedPrice_CurrencyCode	string	The currency code in ISO 4217 format
Offers_BuyingPrice_ListingPrice_Amount	bigdecimal	The monetary value
Offers_BuyingPrice_ListingPrice_CurrencyCode	string	The currency code in ISO 4217 format
Offers_BuyingPrice_Points_PointsMonetaryValue_Amount	bigdecimal	The monetary value
Offers_BuyingPrice_Points_PointsMonetaryValue_CurrencyCode	string	The currency code in ISO 4217 format
Offers_BuyingPrice_Points_PointsNumber	integer	The number of points
Offers_BuyingPrice_Shipping_Amount	bigdecimal	The monetary value
Offers_BuyingPrice_Shipping_CurrencyCode	string	The currency code in ISO 4217 format
Offers_FulfillmentChannel	string	The fulfillment channel for the offer listing. Possible values: Amazon - Fulfilled by Amazon; Merchant - Fulfilled by the seller;
Offers_ItemCondition	string	The item condition for the offer listing. Possible values: New, Used, Collectible, Refurbished, or Club
Offers_ItemSubCondition	string	The item subcondition for the offer listing. Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other
Offers_offerType	string	Indicates the type of customer that the offer is valid for
Offers_QuantityDiscountPrices_listingPrice_Amount	bigdecimal	The monetary value
Offers_QuantityDiscountPrices_listingPrice_CurrencyCode	string	The currency code in ISO 4217 format
Offers_QuantityDiscountPrices_quantityDiscountType	string	Indicates the type of quantity discount this price applies to
Offers_QuantityDiscountPrices_quantityTier	integer	Indicates at what quantity this price becomes active
Offers_RegularPrice_Amount	bigdecimal	The monetary value
Offers_RegularPrice_CurrencyCode	string	The currency code in ISO 4217 format
Offers_SellerSKU	string	The seller stock keeping unit (SKU) of the item
SalesRankings	string	A list of sales rank information for the item, by category
status	string	The status of the operation

Example

SQL

CREATE VIEW amazon_sp_examples.example_Pricing AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Pricing (
			Skus => NULL,
			OfferType => 'B2B',
			MarketplaceId => 'A1PA6795UKMFR9',
			ItemCondition => 'New',
			Asins => 'B07TWSDZ76,B07V59XY8K,B07V591PL4,B07V6M4S3M,B07V7ZTVYG,B07VCG6Q68,B07Y88WBT9,B089QK1CHR,B089VYGQ2R,B089W8DB5P'
		)
	) AS x

Rates

Service rates
Parameter
<body> (required): The payload schema for the getRates operation
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
billableWeight_unit	string	The unit of measurement
billableWeight_value	bigdecimal	The measurement value
promise_deliveryWindow_end	timestamp	The end date and time. This must come after the value of start. This defaults to the next business day from the start
promise_deliveryWindow_start	timestamp	The start date and time. This defaults to the current date and time
promise_receiveWindow_end	timestamp	The end date and time. This must come after the value of start. This defaults to the next business day from the start
promise_receiveWindow_start	timestamp	The start date and time. This defaults to the current date and time
serviceType	string	The type of shipping service that will be used for the service offering
totalCharge_unit	string	A 3-character currency code
totalCharge_value	bigdecimal	The amount of currency

Example

SQL

CREATE VIEW amazon_sp_examples.example_Rates AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Rates (
			body => '{}'
		)
	) AS x

ReportDocument

Report document's contents. This includes a presigned URL for the report document as well as the information required to decrypt the document's contents
Parameter
<reportDocumentId> (required): The identifier for the report document
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
reportDocumentId	string	The identifier for the report document. This identifier is unique only in combination with a seller ID
compressionAlgorithm	string	If present, the report document contents have been compressed with the provided algorithm
encryptionDetails_initializationVector	string	The vector to decrypt the document contents using Cipher Block Chaining (CBC)
encryptionDetails_key	string	The encryption key used to decrypt the document contents
encryptionDetails_standard	string	The encryption standard required to decrypt the document contents
url	string	A presigned URL for the report document. This URL expires after 5 minutes

Example

SQL

CREATE VIEW amazon_sp_examples.example_ReportDocument AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ReportDocument (
			reportDocumentId => '0356cf79-b8b0-4226-b4b9-0ee058ea5760'
		)
	) AS x

ReportSchedules

Report schedule details that match the filters that you specify
Parameter
<reportTypes> (optional): A list of report types used to filter report schedules. Min count : 1 Max count : 10
<reportScheduleId> (optional): The identifier for the report schedule. This identifier is unique only in combination with a seller ID
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
reportScheduleId	string	The identifier for the report schedule. This identifier is unique only in combination with a seller ID
marketplaceIds	string	A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise
nextReportCreationTime	timestamp	The date and time when the schedule will create its next report, in ISO 8601 date time format
period	string	An ISO 8601 period value that indicates how often a report should be created
reportOptions	string	Additional information passed to reports. This varies by report type
reportType	string	The report type

Example

SQL

CREATE VIEW amazon_sp_examples.example_ReportSchedules AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ReportSchedules (
			reportTypes => 'FEE_DISCOUNTS_REPORT,GET_FBA_FULFILLMENT_CUSTOMER_TAXES_DATA'
		)
	) AS x

Report_ActiveListings

Active Listings Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
item_name	string	The item name
item_description	string	The item description
listing_id	string	The listing id
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
quantity	bigdecimal	The total number of units reimbursed for this line item
open_date	string	Open date
image_url	string	The image url
item_is_marketplace	boolean	Item is marketplace
product_id_type	string	The type of product id
zshop_shipping_fee	bigdecimal	Zshop shipping fee
item_note	string	The item note
item_condition	string	Numeric entry that indicates the condition of the product. This field is required. Note: Not all conditions are available for all categories. For more information about what conditions you may use in your product category, see Condition Guidelines
zshop_category1	string	Zshop category1
zshop_browse_path	string	Zshop browse path
zshop_storefront_feature	string	Zshop storefront feature
asin1	string	The Amazon Standard Identification Number (ASIN) of the item
asin2	string	The Amazon Standard Identification Number (ASIN) of the item
asin3	string	The Amazon Standard Identification Number (ASIN) of the item
will_ship_internationally	string	Will ship internationally
expedited_shipping	string	Expedited shipping
zshop_boldface	string	Zshop boldface
product_id	string	The product id
bid_for_featured_placement	string	The bid for featured placement
add_delete	string	Add delete
pending_quantity	bigdecimal	Pending quantity
fulfillment_channel	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
Business_Price	bigdecimal	A special price that is available only for Amazon Business orders
Quantity_Price_Type	string	Quantity price type
Quantity_Lower_Bound_1	bigdecimal	Quantity lower bound
Quantity_Price_1	bigdecimal	Quantity price
Quantity_Lower_Bound_2	bigdecimal	Quantity lower bound
Quantity_Price_2	bigdecimal	Quantity price
Quantity_Lower_Bound_3	bigdecimal	Quantity lower bound
Quantity_Price_3	bigdecimal	Quantity price
Quantity_Lower_Bound_4	bigdecimal	Quantity lower bound
Quantity_Price_4	bigdecimal	Quantity price
Quantity_Lower_Bound_5	bigdecimal	Quantity lower bound
Quantity_Price_5	bigdecimal	Quantity price
merchant_shipping_group	string	The merchant shipping group
Progressive_Price_Type	string	Progressive price type
Progressive_Lower_Bound_1	bigdecimal	Progressive lower bound
Progressive_Price_1	bigdecimal	Progressive price
Progressive_Lower_Bound_2	bigdecimal	Progressive lower bound
Progressive_Price_2	bigdecimal	Progressive price
Progressive_Lower_Bound_3	bigdecimal	Progressive lower bound
Progressive_Price_3	bigdecimal	Progressive price

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_ActiveListings AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_ActiveListings (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_AllListings

All Listings Report
Parameter
<Custom> (optional): A Boolean value that indicates whether a custom report is returned
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
item_name	string	The item name
item_description	string	The item description
listing_id	string	The listing id
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
quantity	bigdecimal	The total number of units reimbursed for this line item
open_date	string	Open date
image_url	string	The image url
item_is_marketplace	boolean	Item is marketplace
product_id_type	string	The type of product id
zshop_shipping_fee	bigdecimal	Zshop shipping fee
item_note	string	The item note
item_condition	string	Numeric entry that indicates the condition of the product. This field is required. Note: Not all conditions are available for all categories. For more information about what conditions you may use in your product category, see Condition Guidelines
zshop_category1	string	Zshop category1
zshop_browse_path	string	Zshop browse path
zshop_storefront_feature	string	Zshop storefront feature
asin1	string	The Amazon Standard Identification Number (ASIN) of the item
asin2	string	The Amazon Standard Identification Number (ASIN) of the item
asin3	string	The Amazon Standard Identification Number (ASIN) of the item
will_ship_internationally	string	Will ship internationally
expedited_shipping	string	Expedited shipping
zshop_boldface	string	Zshop boldface
product_id	string	Product id
bid_for_featured_placement	string	Bid for featured placement
add_delete	string	Add delete
pending_quantity	bigdecimal	Pending quantity
fulfillment_channel	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
merchant_shipping_group	string	Merchant shipping group
status	string	Current status of this item within the order
Minimum_order_quantity	bigdecimal	Minimum order quantity
Sell_remainder	boolean	Sell remainder

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_AllListings AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_AllListings (
			Custom => false,
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_AmazonSearchTerms

Amazon Search Terms Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportPeriod> (optional): Specifies the reporting period for the report. Values include DAY, WEEK, MONTH, QUARTER and YEAR
<reportId> (optional): Id of the report to parse
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
startDate	date	Start date
endDate	date	End date
clickedAsin	string	Asin (Amazon Standard Identification Number) of the clicked item
clickedItemName	string	Name of the clicked item
clickShare	bigdecimal	Click share
clickShareRank	integer	Click share rank
conversionShare	bigdecimal	Conversion share
departmentName	string	Name of the department
searchFrequencyRank	integer	Search frequency rank
searchTerm	string	Search term

Example

SQL

	CREATE VIEW amazon_sp_examples.example_Report_AmazonSearchTerms AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_AmazonSearchTerms (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_AmazonVATCalculation

Amazon VAT Calculation Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
Order_ID	string	Amazon''s unique identifying number for the order. Used for shipping confirmation and post- order processing
ASIN	string	Amazon Standard Inventory Number
Buyer_E_Invoice_Account_Id	string	The e-invoice account Id of the Customer. This will be populated if the customer has provided an e- invoice account Id (which can be used to send the invoice to Sistema di Interscambio (SdI), if required). This column is specifically added for Italy e-invoicing law that came into effect in 2019, so that sellers can upload invoices to SdI
Buyer_Tax_Registration	string	VAT registration number of the buyer used in VAT calculation
Buyer_Tax_Registration_Jurisdiction	string	The country associated with the buyer''s VAT registration number
Buyer_Tax_Registration_Type	string	The tax type of the customer (if the customer has a VAT registration number)
Converted_Tax_Amount	bigdecimal	Total VAT amount in invoice currency
Currency	string	The currency for the estimated long-term storage fee charge
EInvoice_URL	string
Export_Outside_EU	boolean	Indicates whether or not an item was shipped from a EU27 member country to a country outside the EU27 member countries
GIFTWRAP_Tax_Amount	bigdecimal	VAT amount on giftwrap price
GIFTWRAP_Tax_Amount_Promo	bigdecimal	VAT amount on giftwrap promotion
GIFTWRAP_Tax_Exclusive_Promo_Amount	bigdecimal	VAT exclusive giftwrap price discounted of promotion
GIFTWRAP_Tax_Exclusive_Selling_Price	bigdecimal	VAT exclusive giftwrap price
GIFTWRAP_Tax_Inclusive_Promo_Amount	bigdecimal	VAT inclusive giftwrap price discounted of promotion
GIFTWRAP_Tax_Inclusive_Selling_Price	bigdecimal	VAT inclusive giftwrap price for the item
Invoice_Correction_Details	string	Invoice amendment details describing changes on the invoice. This is only applicable for invoice amendment transaction
Invoice_Level_Currency_Code	string	The currency used for the invoice
Invoice_Level_Exchange_Rate	bigdecimal	The exchange rate used to convert the invoice amount to invoice currency
Invoice_Level_Exchange_Rate_Date	date	The date of the exchange rate used to convert the invoice amount to invoice currency
Invoice_Url	string	URL link for the seller to download or view the invoice/credit note/ tax document
Is_Amazon_Invoiced	boolean	Is Amazon supposed to create an Invoice for this transaction? This will be true if seller uses VCS and chooses the option to allow Amazon to create the Invoices, or if Amazon World Imports buys from the seller. Seller should not create Invoices for these transactions. Amazon will generate an invoice and make it available to the seller
Is_Invoice_Corrected	boolean	Flag indicating whether transaction is invoice correction transaction or not
Jurisdiction_Level	string	Level corresponding to tax jurisdiction authority
Jurisdiction_Name	string	Name of the tax jurisdiction authority
Marketplace_ID	string	The marketplace on which the order was placed
Merchant_ID	string	An unique alphanumeric identifier for your account
Order_Date	date	Date the order was placed
Original_VAT_Invoice_Number	string	Original VAT invoice number that has been amended. This is only applicable for Invoice amendment transaction
OUR_PRICE_Tax_Amount	bigdecimal	VAT amount of Item price
OUR_PRICE_Tax_Amount_Promo	bigdecimal	VAT amount of promotion
OUR_PRICE_Tax_Exclusive_Promo_Amount	bigdecimal	VAT exclusive sale price for the item discounted of promotion
OUR_PRICE_Tax_Exclusive_Selling_Price	bigdecimal	VAT exclusive sale price for the item. All amounts are aggregates of the quantity, not unit prices
OUR_PRICE_Tax_Inclusive_Promo_Amount	bigdecimal	VAT Inclusive sale price for the item discounted of promotion
OUR_PRICE_Tax_Inclusive_Selling_Price	bigdecimal	VAT inclusive sale price for the item. All amounts are aggregates of the quantity, not unit prices
Product_Tax_Code	string	Your item level product tax code (PTC) is used to designate a specific PTC to a specific item and will be used instead of your default PTC
Quantity	bigdecimal	Enter a quantity when you add a new SKU. This is a required field for seller-fulfilled products if product-id is provided, and to make the product available for purchase on Amazon. Products must be in-stock and on-hand at the time a purchase is made. Note: For Fulfillment by Amazon (FBA) products, do not enter a quantity. Instead, provide a fulfillment-center-id in the last column of the template
Return_Fc_Country	string	Country of "Return FC"
SDI_Invoice_Delivery_Status	string	Shows the e-Invoice SDI validation and delivery status. It has 5 status values: 1 Rejected: Status when e-Invoice failed validation by SDI 2 Accepted: Status when e-invoice validated successfully 3 Pending: Status when validation awaiting 4 (Blank): Status for other PDF invoices 5 Accepted but failed to deliver: Status when received receipt of delivery impossibility This is only applicable for IT e-invoices where e-invoice issued for transactions between resident businesses in Italy with valid intra-community VAT registration number
SDI_Invoice_Error_Code	string	Error code returned by SDI for rejecting e-Invoice. This is only applicable for IT e-invoices
SDI_Invoice_Error_Description	string	Error description associated with error code returned by the SDI. This is only applicable for IT e-invoices
SDI_Invoice_Status_Last_Updated_Date	date	Date of SDI invoice Delivery Status. This is only applicable for IT e-invoices
Seller_Tax_Registration	string	VAT registration number of the seller used in VAT calculation
Seller_Tax_Registration_Jurisdiction	string	The country associated with the seller''s VAT registration number
Ship_From_City	string	City of "Ship from" address
Ship_From_Country	string	Country of "Ship from" address
Ship_From_Postal_Code	string	Postal Code of "Ship from" address
Ship_From_State	string	State of "Ship from" address
Ship_From_Tax_Location_Code	string	Code that describes the location of the "Ship from" address used to determine the tax jurisdictions
Ship_To_City	string	City of "Ship to" address
Ship_To_Country	string	Country of "Ship to" address
Ship_To_Location_Code	string	Code that describes the location of the "Ship to" address used to determine the tax jurisdictions
Ship_To_Postal_Code	string	Postal Code of "ship to" address
Ship_To_State	string	State of "Ship to" address
Shipment_Date	date	Date of dispatch of this shipment
Shipment_ID	string	Shipping Id for this shipment
SHIPPING_Tax_Amount	bigdecimal	VAT amount on shipping price
SHIPPING_Tax_Amount_Promo	bigdecimal	VAT amount on shipping promotion
SHIPPING_Tax_Exclusive_Promo_Amount	bigdecimal	VAT exclusive shipping price discounted of promotion
SHIPPING_Tax_Exclusive_Selling_Price	bigdecimal	VAT exclusive shipping price
SHIPPING_Tax_Inclusive_Promo_Amount	bigdecimal	VAT inclusive shipping price discounted of promotion
SHIPPING_Tax_Inclusive_Selling_Price	bigdecimal	VAT inclusive shipping price for the item
SKU	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
Tax_Address_Role	string	The address used for Tax calculation e.g. Ship To address
Tax_Calculation_Date	date	The date that is used to calculate the VAT
Tax_Calculation_Reason_Code	string	The reason for tax calculation e.g. Taxable or Tax exempt
Tax_Collection_Responsibility	string
Tax_Rate	bigdecimal	The VAT rate percentage applied to the transaction
Tax_Reporting_Scheme	string
Tax_Type	string	Type of tax applied on the transaction
Transaction_ID	string	An unique transaction id for shipments
Transaction_Type	string	Values can be shipment, refund or return depending on the type of transaction
VAT_Invoice_Number	string	The sequential VAT invoice number or credit note number or tax document

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_AmazonVATCalculation AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_AmazonVATCalculation (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_AmazonVATTransactions

Amazon VAT Transactions Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
UNIQUE_ACCOUNT_IDENTIFIER	string	A unique alphanumeric identifier for your account
ACTIVITY_PERIOD	string	Year and Month where activity is contained within the report
SALES_CHANNEL	string	The channel where the transaction originated. - "MFN" - Merchant Fulfillment Network: These are shipments fulfilled directly by the seller for sales placed on Amazon's websites. "AFN" - Amazon Fulfillment Network: These are shipments fulfilled by Amazon on the seller's behalf for sales placed on Amazon's websites
MARKETPLACE	string	The marketplace in which the order was placed
PROGRAM_TYPE	string	This column identifies the program type pertaining to the transaction. There are business teams within Amazon that launch programs catering to different use cases for Amazon and the seller. AVTR includes such programs when the corresponding activities are relevant for the seller's VAT reporting. - "LIQUIDATION": Liquidation sales of excess inventory initiated by a seller. For more details, refer to FBA Liquidations. - "DONATION": Donation of excess inventory to a charitable organization through the Fulfillment by Amazon donations program. For more details, refer to FBA Donations. - "COMMINGLING": Acquisition or disposal of a product from/to another FBA seller (or Amazon Retail), participating in the Commingling Program. For more details, refer to Commingling FAQs. - "REGULAR": Any transaction to which the above program types do not apply
TRANSACTION_TYPE	string	Shipment, Refund, Retrocharge, Order Fee, etc
TRANSACTION_EVENT_ID	string	Transaction Event ID is an ID that relates to the entire transaction. - This ID can be used to search for transactional level information in Seller Central. - Transaction event IDs can appear more than once if there are sales, refunds, returns, and/or multiple items in an order
ACTIVITY_TRANSACTION_ID	string	Activity Transaction ID is an identifier that relates to lower-level activity within a transaction event. For example, multiple shipments or refunds for one order. - This ID cannot be used to search for transactional level information in Seller Central. - Activity Transaction IDs can appear more than once if there are multiple items related the activity level
TAX_CALCULATION_DATE	date	The date that is used to determine the VAT details
TRANSACTION_DEPART_DATE	date	Date associated with the departure (outbound) movement to the final destination. This date may be in a different month from the arrival month. Date used to determine the month in which the activity will be contained in the transaction report is the TRANSACTION_COMPLETE_DATE. - MFN/AFN: "Sale"- Shipment Date (seller to buyer shipments). This is also the date the buyer's payment instrument is charged. - AFN: "Commingling_Sell" & "Commingling_Buy" - Shipment Date (seller-to-buyer shipments). - AFN: "Liquidation_Sale" - Shipment date (seller-to-buyer shipments). - AFN: "Donation" - Shipment date (seller-to-buyer shipments). - AFN: "Return"- Date good(s) sent back. This field will be blank if the data is not provided to Amazon by the buyer or Carrier. - AFN: "FC_Transfer"- Process Date: The date inventory began its movement from a Fulfillment Center. - AFN: "Inbound"- The date in which you create shipment in "Manage FBA Shipments" page. - MFN/AFN: "Refund"- Blank. There is a monetary change and the date is reflected in TRANSACTION_COMPLETE_DATE. - NOTE: Product movement will be reflected in the Return section
TRANSACTION_ARRIVAL_DATE	date	Date associated with the final destination (inbound) movement. This date may be in a different month from the arrival month. Date used to determine the month in which the activity will be contained in the transaction report is the TRANSACTION_COMPLETE_DATE_UTC. - MFN/AFN: "Sale"- Delivery date (seller to buyer shipments). This field will be blank if the data is not provided to Amazon by the Carrier. - AFN: "Commingling_Sell" & "Commingling_Buy" - Delivery Date (seller-to-buyer shipments). - AFN: "Liquidation_Sale", "Liquidation_Refund", "Donation" - Empty. - AFN: "Return"- Date return arrived at Fulfillment Center. (buyer to seller returns) . - AFN: "FC_Transfer"- Date items arrive at the Fulfillment Center receiving dock and are pending check-in. - AFN: "Inbounds"- Date items arrive at the Fulfillment Center receiving dock and completed check-in. - MFN/AFN: "Refund"- Blank. There is a monetary change and the date is reflected in TRANSACTION_COMPLETE_DATE. - NOTE: Product movement will be reflected in the Return section
TRANSACTION_COMPLETE_DATE	date	Date used to determine the month in which the activity will be contained in the transaction report. - MFN/AFN: "Sale", "Liquidation_Sale", "Donation" - Shipment Date (seller to Buyer shipments). This is also the date the buyer's payment instrument is charged. - AFN: "Commingling_Sell" & "Commingling_Buy" - Shipment Date (seller-to-buyer shipments). - AFN: "Return"- Date return arrived at Fulfillment Center. (Buyer to seller returns) . - MFN/AFN: "Refund", "Liquidation_Refund" - Date the refund of monetary values was completed. - NOTE: Product movement will be reflected in the Return section. - AFN: "FC_Transfer"- Received Date, the date the inventory was checked into the receiving Fulfillment Center. - AFN: "Inbounds"- Received Date, the date the inventory is checked into the receiving Fulfillment Center
SELLER_SKU	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that are assigned to Amazon by the seller to make it easier for them to identify their products. Seller SKUs are required when listing an item. If SKU available, populated. If unavailable, populated as 'Not Available'
ASIN	string	The Amazon Standard Identification Number of the item
ITEM_DESCRIPTION	string	The product description based on the Amazon Marketplace in which the item transacted. - "FC_Transfer" & "Inbound": The product description based on seller's home market place. This field will be blank if product description not available in seller's home market place
ITEM_MANUFACTURE_COUNTRY	string	Two character country code where the product was originally made or manufactured; this is not the location where the item is sold
QTY	bigdecimal	The total number of units in reserved status
ITEM_WEIGHT	bigdecimal	The weight of each individual SKU item in kilograms (kg). - All Transactions - Except MFN/AFN "Refund": The unit weight in kilograms (kg). - "FC_Transfer" & "Inbound": The weight of each individual SKU item in kilograms (kg) based on seller's home market place. - This field will be blank if not available in seller's home market place. - MFN/AFN: "Refund", "Liquidation_Refund" - Refunds only reflect financial movement, so this value will be 0. Product movement will be reflected in the "Return" section
TOTAL_ACTIVITY_WEIGHT	bigdecimal	Total weight of the units moved for this activity line. The unit will be in kilograms (kg). - All Use Cases: "QUANTITY" x "ITEM_WEIGHT". - "FC_Transfer" & "Inbound": Total weight of the units moved for this activity line in kilograms (kg) based on seller's home market place. - This field will be blank if not available in seller's home market place
COST_PRICE_OF_ITEMS	bigdecimal	The cost price of the item (amount paid to acquire the item) as provided by the seller
PRICE_OF_ITEMS_AMT_VAT_EXCL	bigdecimal	The total price of items for all units (quantity) in the activity type, excluding VAT, Shipping, Gift Wrap, and Promotion amounts. Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts
PROMO_PRICE_OF_ITEMS_AMT_VAT_EXCL	bigdecimal	The promotion amount applied to the transaction type for all units (quantity) in the activity type, Excluding VAT, Shipping, Gift Wrap, and Price of Item amounts. - Sales are reflected as negative amounts, and returns/refunds are reflected as positive amounts
TOTAL_PRICE_OF_ITEMS_AMT_VAT_EXCL	bigdecimal	The total value of the item price paid by the buyer, excluding VAT, Shipping, and Gift Wrap. - "PRICE_OF_ITEMS_AMT_VAT_EXCL" + "PROMO_PRICE_OF_ITEMS_AMT_VAT_EXCL"
SHIP_CHARGE_AMT_VAT_EXCL	bigdecimal	The amount of shipping charged/refunded to the buyer for all units (quantity) in the activity type, excluding VAT, Price of Items, Gift Wrap, and Promotion amounts. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts
PROMO_SHIP_CHARGE_AMT_VAT_EXCL	bigdecimal	The promotion amount applied to shipping charged/refunded to the buyer for all units (quantity) in the activity type, excluding VAT, Price of Items, Shipping Charge, and Gift Wrap amounts. - Sales are reflected as negative amounts and returns/refunds are reflected as positive amounts
TOTAL_SHIP_CHARGE_AMT_VAT_EXCL	bigdecimal	The total value of shipping paid or refunded to the buyer, excluding VAT, Price of Items, and Gift Wrap,. - "SHIP_CHARGE_AMT_VAT_EXCL" + "PROMO_SHIP_CHG_AMT_VAT_EXCL"
GIFT_WRAP_AMT_VAT_EXCL	bigdecimal	The amount of gift wrap charged/refunded to the buyer for all units (quantity) in the activity type, excluding VAT, Price of Items, Shipping, and Promotion amounts. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts
PROMO_GIFT_WRAP_AMT_VAT_EXCL	bigdecimal	The promotion amount applied to gift wrap charged/refunded to the buyer for all units (quantity) in the activity type, excluding VAT, Price of Items, and Shipping amounts. - Sales are reflected as negative amounts and returns/refunds are reflected as positive amounts
TOTAL_GIFT_WRAP_AMT_VAT_EXCL	bigdecimal	The total value of gift wrap paid or refunded to the buyer, excluding VAT, Price of Items, and Shipping. - "GIFT_WRAP_AMT_VAT_EXCL" + "PROMO_GIFT_WRAP_AMT_VAT_EXCL"
TOTAL_ACTIVITY_VALUE_AMT_VAT_EXCL	bigdecimal	The total value of the activity, excluding VAT. - "TOTAL_PRICE_OF_ITEMS_AMT_VAT_EXCL" + "TOTAL_SHIP_CHARGE_AMT_VAT_EXCL" + "TOTAL_GIFT_WRAP_AMT_VAT_EXCL"
PRICE_OF_ITEMS_VAT_RATE_PERCENT	bigdecimal	The VAT rate percentage applied to the activity. The rate percentage is provided as decimal value (e.g.0.20=20%, 0.02=2%)
PRICE_OF_ITEMS_VAT_AMT	bigdecimal	The VAT amount charged or refunded to the buyer from the seller on the items in the activity based on the PRICE_OF_ITEMS_VAT_RATE_PERCENT. - This amount excludes shipping, gift wrap, promotions, and PRICE_OF_ITEMS_VAT_EXCL
PROMO_PRICE_OF_ITEMS_VAT_AMT	bigdecimal	The VAT amount charged or refunded to the buyer from the seller on the promotional amount applied to the items in the activity based on the PRICE_OF_ITEMS_VAT_RATE_PERCENT. - This amount excludes shipping, gift wrap, PRICE_OF_ITEMS_VAT_EXCL, and PRICE_OF_ITEMS_VAT_AMT
TOTAL_PRICE_OF_ITEMS_VAT_AMT	bigdecimal	The total VAT amount charged/refunded to the buyer from the seller on the items in the activity. - "PRICE_OF_ITEMS_VAT_AMT" + "PROMO_PRICE_OF_ITEMS_VAT_AMT"
SHIP_CHARGE_VAT_RATE_PERCENT	bigdecimal	The VAT rate percentage applied to the shipping charged/refunded to the buyer for the activity. - The rate percentage is provided as decimal value (e.g.0.20=20%, 0.02=2%)
SHIP_CHARGE_VAT_AMT	bigdecimal	The VAT amount charged or refunded to the buyer from the seller on the shipping amount based on the SHIP_CHARGE_VAT_RATE_PERCENT. - This amount excludes price of items, gift wrap, promotions, and SHIP_CHARGE_AMT_VAT_EXCL
PROMO_SHIP_CHARGE_VAT_AMT	bigdecimal	The VAT amount charged or refunded to the buyer from the seller on the promotional amount applied to the shipping amount, based on the SHIP_CHARGE_VAT_RATE_PERCENT. - This amount excludes price of items, gift wrap, and SHIP_CHARGE_AMT_VAT_EXCL
TOTAL_SHIP_CHARGE_VAT_AMT	bigdecimal	The total VAT amount charged/refunded to the buyer from the seller on the shipping amount for the activity. - "SHIP_CHARGE_VAT_AMT" + "PROMO_SHIP_CHARGE_VAT_AMT"
GIFT_WRAP_VAT_RATE_PERCENT	bigdecimal	The VAT rate percentage applied to the gift wrap charged/refunded to the buyer for the activity. - The rate percentage is provided as decimal value (e.g.0.20=20%, 0.02=2%)
GIFT_WRAP_VAT_AMT	bigdecimal	The VAT rate percentage applied to the gift wrap charged/refunded to the buyer for the activity. - The rate percentage is provided as decimal value (e.g.0.20=20%, 0.02=2%)
PROMO_GIFT_WRAP_VAT_AMT	bigdecimal	The VAT amount charged or refunded to the buyer from the seller on the promotional amount applied to Gift Wrap, based on the GIFT_WRAP_VAT_RATE_PERCENT. - This amount excludes price of items, shipping, and GIFT_WRAP_AMT_VAT_EXCL
TOTAL_GIFT_WRAP_VAT_AMT	bigdecimal	The total VAT amount charged/refunded to the buyer from the seller on the gift wrap for the activity. - "GIFT_WRAP_VAT_AMT" + "PROMO_GIFT_WRAP_VAT_AMT"
TOTAL_ACTIVITY_VALUE_VAT_AMT	bigdecimal	The total VAT for the activity. - "TOTAL_PRICE_OF_ITEMS_VAT_AMT" + "TOTAL_SHIP_CHARGE_VAT_AMT" + "TOTAL_GIFT_WRAP_VAT_AMT"
PRICE_OF_ITEMS_AMT_VAT_INCL	bigdecimal	The total price of items for all units (quantity) in the activity type, including VAT and excluding Shipping, Gift Wrap, and Promotion amounts. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale", "Liquidation_Sale": The total VAT inclusive amount of the items in the activity. - "Donation" - This will be blank. - AFN "Commingling_Buy" & "Commingling_Sell": The total VAT-inclusive amount of the items in the activity. - MFN/AFN "Refund", "Liquidation_Refund": The total VAT inclusive amount of the items in the activity. - NOTE: Product movement will be reflected in the Return section. - AFN "FC_Transfer" & "Inbounds". - This will be blank. The service made available by Amazon does not currently capture this information from sellers. - AFN "Return": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
PROMO_PRICE_OF_ITEMS_AMT_VAT_INCL	bigdecimal	The total promotion price of items for all units (quantity) in the activity type, including VAT and excluding price of items, shipping, and gift wrap. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale": The total VAT inclusive promotional amount of the items in the activity. - "Liquidation_Sale", "Liquidation_Refund", "Donation" - This will be blank. - AFN: "Commingling_Buy" & "Commingling_Sell": This will be blank. There are no promotional amounts applied to Commingling transactions. - MFN/AFN "Refund": The total VAT inclusive promotional amount of the items in the activity. - NOTE: Product movement will be reflected in the Return section. - AFN "FC_Transfer" & "Inbounds": There are no promotional amounts applied to Inbound and Transfer activity. There are no financial movements between the seller and Amazon. - AFN "Return": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
TOTAL_PRICE_OF_ITEMS_AMT_VAT_INCL	bigdecimal	The total price of items for all units (quantity) in the activity type, including VAT and excluding Shipping and Gift Wrap charges. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale", "Liquidation_Sale": PRICE_OF_ITEMS_AMT_VAT_INCL + PROMO_PRICE_OF_ITEMS_AMT_VAT_INCL. - AFN "Commingling_Buy" & "Commingling_Sell": PRICE_OF_ITEMS_AMT_VAT_INCL. - MFN/AFN "Refund", "Liquidation_Refund": PRICE_OF_ITEMS_AMT_VAT_INCL + PROMO_PRICE_OF_ITEMS_AMT_VAT_INCL. - NOTE: Product movement will be reflected in the Return section. - AFN "FC_Transfer" & "Inbounds" & "Return" & "Return" & "Donation": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
SHIP_CHARGE_AMT_VAT_INCL	bigdecimal	The amount of shipping charged/refunded to the buyer for all units (quantity) in the activity type, including VAT, but excluding price of items, gift wrap, and promotion amounts. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale": The total VAT inclusive amount of the shipping in the activity. - "Liquidation_Sale", "Liquidation_Refund", "Donation" - This will be blank. - MFN/AFN "Refund": The total VAT inclusive amount of the shipping in the activity. - AFN "Commingling_Buy" & "Commingling_Sell": This will be blank. There are no shipping charges for Commingling transactions. - NOTE: Product movement will be reflected in the Return section. - AFN "FC_Transfer" & "Inbounds": This value will be 0. The buyer is not charged on movement between Fulfillment Centers. - AFN "Return": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
PROMO_SHIP_CHARGE_AMT_VAT_INCL	bigdecimal	The promotion amount for shipping charges for all units (quantity) in the activity type, including VAT and excluding price of items, and gift wrap. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale": The total VAT inclusive amount of the promotion amount on shipping charges in the activity. - "Liquidation_Sale", "Liquidation_Refund", "Donation" - This will be blank. - MFN/AFN "Refund": The total VAT inclusive amount of the promotion amount on shipping charges in the activity. - AFN "Commingling_Buy" & "Commingling_Sell": This will be blank. There are no shipping charges for Commingling transactions. - NOTE: Product movement will be reflected in the Return section. - AFN "Return": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - AFN "FC_Transfer" & "Inbounds": There are no promotional amounts applied to Inbound and Transfer activity. There are no financial movements between the seller and Amazon. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
TOTAL_SHIP_CHARGE_AMT_VAT_INCL	bigdecimal	The total shipping charges for all units (quantity) in the activity type, including VAT and excluding Price of Items, Gift Wrap, and Promotion amounts. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale": "SHIP_CHG_VAT_INCL" + "PROMO_SHIP_CHG_VAT_INCL". - "Liquidation_Sale", "Liquidation_Refund", "Donation" - This will be blank. - MFN/AFN "Refund": "SHIP_CHG_VAT_INCL" + "PROMO_SHIP_CHG_VAT_INCL". - AFN "Commingling_Buy" & "Commingling_Sell": This will be blank. There are no shipping charges for Commingling transactions. - NOTE: Product movement will be reflected in the Return section. - AFN "FC_Transfer" & "Inbounds": This value will be 0. The buyer is not charged on movement between Fulfillment Centers. - AFN "Return": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
GIFT_WRAP_AMT_VAT_INCL	bigdecimal	The amount of gift wrap charged/refunded to the buyer for all units (quantity) in the activity type, including VAT, but excluding price of items, shipping and promotion amounts. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale": The total VAT inclusive amount of the gift wrap charges in the activity. - "Liquidation_Sale", "Liquidation_Refund", "Donation" - This will be blank. - MFN/AFN "Refund": The total VAT inclusive amount of the gift wrap charges in the activity. - AFN "Commingling_Buy" & "Commingling_Sell": This will be blank. There are no gift wrapping charges for Commingling transactions. - NOTE: Product movement will be reflected in the Return section. - AFN "FC_Transfer" & "Inbounds": This value will be 0. The buyer is not charged on movement between Fulfillment Centers. - AFN "Return": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
PROMO_GIFT_WRAP_AMT_VAT_INCL	bigdecimal	The promotion amount for gift wrap charges for all units (quantity) in the activity type, including VAT and excluding price of items, shipping, and gift wrap. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale": The total VAT inclusive amount of the promotion amount on shipping charges in the activity. - "Liquidation_Sale", "Liquidation_Refund", "Donation" - This will be blank. - MFN/AFN "Refund": The total VAT inclusive amount of the promotion amount on shipping charges in the activity. - AFN "Commingling_Buy" & "Commingling_Sell": This will be blank. There are no gift wrapping charges for Commingling transactions. - NOTE: Product movement will be reflected in the Return section. - AFN "Return": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - AFN "FC_Transfer" & "Inbounds": There are no promotional amounts applied to Inbound and Transfer activity. There are no financial movements between the seller and Amazon. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
TOTAL_GIFT_WRAP_AMT_VAT_INCL	bigdecimal	The total gift wrap charges for all units (quantity) in the activity type, including VAT and excluding price of items, shipping, and promotion amounts. - Sales are reflected as positive amounts and returns/refunds are reflected as negative amounts. - MFN/AFN "Sale": "GIFT_WRAP_CHG_VAT_INCL" + "PROMO_GIFT_WRAP_VAT_INCL". - "Liquidation_Sale", "Liquidation_Refund", "Donation" - This will be blank. - MFN/AFN "Refund": "GIFT_WRAP_CHG_VAT_INCL" + "PROMO_GIFT_WRAP_VAT_INCL". - AFN "Commingling_Buy" & "Commingling_Sell": This will be blank. There are no gift wrapping charges for Commingling transactions. - NOTE: Product movement will be reflected in the Return section. - AFN "FC_Transfer" & "Inbounds": This value will be 0. The buyer is not charged on movement between Fulfillment Centers. - AFN "Return": This will be blank. The service made available by Amazon does not currently capture this information from sellers. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
TOTAL_ACTIVITY_VALUE_AMT_VAT_INCL	bigdecimal	The total VAT inclusive amount for the activity inclusive of Price of Items, Gift Wrap, Shipping, and Promotion Amounts. - "TOTAL_PRICE_OF_ITEMS_AMT_VAT_INCL" + "TOTAL_SHIP_CHARGE_AMT_VAT_INCL" + "TOTAL_GIFT_WRAP_AMT_VAT_INCL". - MFN/AFN "Sale", "Liquidation_Sale": The amount charged or refunded to the buyer for this activity. - MFN/AFN "Refund", "Liquidation_Refund": The amount charged or refunded to the buyer for this activity. - AFN "Commingling_Buy" & "Commingling_Sell": The amount charged to the buyer for this activity. - NOTE: Product movement will be reflected in the Return section. - AFN "FC_Transfer" & "Inbounds" & "Return" & "Donation" : This will be blank. The service made available by Amazon does not currently capture this information from sellers. - Note: The service made available by Amazon does not currently calculate VAT details on seller to buyer orders, for non VAT Calculation Service enrolled sellers
TRANSACTION_CURRENCY_CODE	string	Currency code that relates to the activity. - MFN/AFN: "Sale", "Liquidation_Sale", "Refund", "Liquidation_Refund", & "Donation" - The currency of the marketplace in which the item was sold. - AFN: "Commingling_Buy" & "Commingling_Sell" - The currency of the marketplace in which the item was sold
COMMODITY_CODE	string	An eight digit numeric code provided by the European Government that identifies a group of goods
STATISTICAL_CODE_DEPART	string	Additional national statistic code required for certain products departing from specific countries. - For example, in CZ, additional statistical codes relate to fuels related commodities and in FR, additional statistical codes relate to meats, wines, and aircrafts related commodities
STATISTICAL_CODE_ARRIVAL	string	Additional national statistic code required for certain products delivered to specific countries. - For example, in CZ, additional statistical codes relate to fuels related commodities and in FR, additional statistical codes relate to meats, wines, and aircrafts related commodities
COMMODITY_CODE_SUPPLEMENTARY_UNIT	string	Supplementary unit for certain Commodity Codes. - For example, carats for diamonds
ITEM_QTY_SUPPLEMENTARY_UNIT	integer	COMMODITY_CODE_SUPPLEMENTARY_UNIT quantity in the transaction. - For example, 10 if it is a 10 carat diamond
TOTAL_ACTIVITY_SUPPLEMENTARY_UNIT	integer	Total supplementary weight of the transaction. - For example, if there are 3 diamonds in this order and each diamond is 10. Carats, this will be 30. - "ITEM_QTY_SUPPLEMENTARY_UNIT" x "QTY"
PRODUCT_TAX_CODE	string	A standard code to identify the tax properties of a product
DEPATURE_CITY	string	City associated with the departure location for the transaction. - AFN: "Sale", "Liquidation_Sale", "Donation" - Amazon Fulfillment Center region where the items departed from. - AFN: "Commingling_Buy" & "Commingling_Sell" - Amazon Fulfilment Centre region where the transfer took place. - AFN: "FC_Transfer" - Amazon Fulfillment Center region where the items departed from
DEPARTURE_COUNTRY	string	Two character country code associated with the departure location for the transaction. - AFN: "Sale", "Liquidation_Sale", "Donation" - Amazon Fulfillment Center country where the items departed from. - AFN: "Commingling_Buy" & "Commingling_Sell" - Amazon Fulfilment Centre country where the transfer took place. - AFN: "FC_Transfer" - Amazon Fulfillment Center country where the items departed from
DEPARTURE_POST_CODE	string	Post Code associated with the departure location for the transaction. - AFN: "Sale", "Liquidation_Sale", "Donation" - Amazon Fulfillment Center postcode where the items departed from. - AFN: "Commingling_Buy" & "Commingling_Sell" - Amazon Fulfilment Centre postcode where the transfer took place. - AFN: "FC_Transfer" - Amazon Fulfillment Center post code where the items departed from
ARRIVAL_CITY	string	City associated with the arrival location for the transaction. - MFN/AFN: "Sale", "Liquidation_Sale", "Donation" - Region where the shipment was delivered. - AFN: "Commingling_Buy" & "Commingling_Sell" - Amazon Fulfilment Centre region where the transfer took place. - AFN: "Return": Amazon Fulfillment Center region where the return items arrived. - AFN: "FC_Transfer" & Inbound - Amazon Fulfillment Center region where the inbound items arrived
ARRIVAL_COUNTRY	string	Two character country code associated with the arrival location for the transaction. - MFN/AFN: "Sale", "Liquidation_Sale", "Donation" - Country where the shipment was delivered. - AFN: "Commingling_Buy" & "Commingling_Sell" - Amazon Fulfilment Centre country where the transfer took place. - AFN: "Return": Amazon Fulfillment Center country where the return items arrived. - AFN: "FC_Transfer" & Inbound - Amazon Fulfillment Center country where the inbound items arrived
ARRIVAL_POST_CODE	string	Post Code associated with the arrival location for the transaction. - MFN/AFN: "Sale", "Liquidation_Sale", "Donation" - Post code where the shipment was delivered. - AFN: "Commingling_Buy" & "Commingling_Sell" - Amazon Fulfilment Centre postcode where the transfer took place. - AFN: "Return": Amazon Fulfillment Center post code where the return items arrived. - AFN: "FC_Transfer" & Inbound - Amazon Fulfillment Center post code where the inbound items arrived
SALE_DEPART_COUNTRY	string	Two character departure country code associated with the original sale. - AFN: "Sale", "Return", "Refund", "Liquidation_Sale", "Liquidation_Refund" - Amazon Fulfillment Center country where the items departed from. - AFN: "Commingling_Buy" & "Commingling_Sell" - Amazon Fulfilment Centre country where the transfer took place
SALE_ARRIVAL_COUNTRY	string	Two character arrival country code associated with the original sale. - AFN/MFN: "Sale", "Return", "Refund", "Liquidation_Sale", "Liquidation_Refund" - Buyer's delivery country associated with the original sale. - AFN: "Commingling_Buy" & "Commingling_Sell" - Amazon Fulfilment Centre country where the transfer took place
TRANSPORTATION_MODE	string	The way goods are moved between destinations. - AFN: "FC_Transfer", "Donation" - Transport by Road
DELIVERY_CONDITIONS	string	The delivery conditions (Incoterms) used to communicate the condition in which the product was delivered. - Incoterms are a series of pre-defined commercial terms published by the International Chamber of Commerce (ICC). The Incoterms are intended to clearly communicate the tasks, costs, and risks associated with the transportation and delivery of goods. - MFN: "Sale" - Amazon does not have the information as the transaction originated from the seller and these values will be blank. - MFN/AFN: "Refund", "Liquidation_Refund" - There is no product movement related to a Refund and these values will be blank
SELLER_DEPART_VAT_NUMBER_COUNTRY	string	The country associated with the seller's VAT number in relation to the departure country. This is represented as a two character country code
SELLER_DEPART_COUNTRY_VAT_NUMBER	string	The seller's VAT number in relation to the departure country
SELLER_ARRIVAL_VAT_NUMBER_COUNTRY	string	The country associated with the seller's VAT number in relation to the arrival country. This is represented as a two character country code
SELLER_ARRIVAL_COUNTRY_VAT_NUMBER	string	The seller's VAT number in relation to the arrival country
TRANSACTION_SELLER_VAT_NUMBER_COUNTRY	string	The country associated with the seller's VAT number used for this transaction. This is represented as a two character country code
TRANSACTION_SELLER_VAT_NUMBER	string	Seller's VAT number provided for this transaction and is also reflected on the VAT Invoice. - The service made available by Amazon does not currently calculate VAT details on seller to buyer orders as seller has not activated VAT Calculation Services and this must be filled in by the seller if applicable
BUYER_VAT_NUMBER_COUNTRY	string	The country associated with the buyer's VAT number provided for this transaction. This is represented as a two character country code
BUYER_VAT_NUMBER	string	Buyer's VAT number provided for this transaction
VAT_CALCULATION_IMPUTATION_COUNTRY	string	The country which was used to back VAT out of the VAT inclusive price. This is represented as a two character country code
TAXABLE_JURISDICTION	string	Indicates the jurisdictional value where a tax calculation was performed. For example, Country, Territory, etc
TAXABLE_JURISDICTION_LEVEL	string	Indicates at which jurisdictional level a tax calculation was performed. For example, Country, Territory, etc
VAT_INV_NUMBER	string	Indicates the sequential number assigned to the tax document, if applicable. E.g. the sequential VAT invoice number or credit note number
VAT_INV_CONVERTED_AMT	bigdecimal	Indicates the total invoice-level VAT amount converted into the local taxed jurisdiction's currency, where that currency differs to that of the marketplace
VAT_INV_CURRENCY_CODE	string	Indicates the currency code of the local taxed jurisdiction's currency, where that currency differs to that of the marketplace
VAT_INV_EXCHANGE_RATE	bigdecimal	Indicates the exchange rate used to convert the total VAT amount in the marketplace currency to that of the local taxed jurisdiction's currency. The exchange rates are provided by the European Central Bank
VAT_INV_EXCHANGE_RATE_DATE	date	Indicates the date of the exchange rate used to convert the total VAT amount in the marketplace currency to that of the local taxed jurisdiction's currency
EXPORT_OUTSIDE_EU	boolean	Indicates whether or not an item was shipped from a EU28 member country to a country outside the EU28 member countries
INVOICE_URL	string	This field will be blank. The service made available by Amazon does not currently capture this as seller has not activated VAT Calculation Services
BUYER_NAME	string	This field will be blank. The service made available by Amazon does not currently capture this as seller has not activated VAT Calculation Services
ARRIVAL_ADDRESS	string	This field will be blank. The service made available by Amazon does not currently capture this as seller has not activated VAT Calculation Services
SUPPLIER_NAME	string	This field will be blank. The service made available by Amazon does not currently capture this as seller has not activated VAT Calculation Services
SUPPLIER_VAT_NUMBER	string	Supplier's VAT number
TAX_REPORTING_SCHEME	string	This field will be blank. The service made available by Amazon does not currently capture this as seller has not activated VAT Calculation Services
TAX_COLLECTION_RESPONSIBILITY	string	This field will be blank. The service made available by Amazon does not currently capture this as seller has not activated VAT Calculation Services

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_AmazonVATTransactions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_AmazonVATTransactions (
			marketplaceIds => 'A1PA6795UKMFR9',
			startDate => TIMESTAMPADD (SQL_TSI_MONTH, -3, CURDATE ())
		)
	) AS x

Report_B2BProductOpportunitiesNotyetonAmazon

B2B Product Opportunities - Not yet on Amazon
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
brand	string	The brand name of the product
category	string	The primary product category (on Amazon)
partNumber	string	The Manufacturer Part Number(MPN) of the product
ean	string	The European Article Number(EAN) of the product
upc	string	The Universal Product Code(UPC) of the product
modelNumber	string	The Model Number of the product
isbn	string	The International Standard Book Number, or ISBN, of each product
itemName	string	The title of the product
initialB2bBuyerIndustry	string	The industry of the first customer who requested the product
initialB2bBuyerRequestedDate	string	The date we learned this product may not be on Amazon as the result of a customer request

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_B2BProductOpportunitiesNotyetonAmazon AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_B2BProductOpportunitiesNotyetonAmazon (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_B2BProductOpportunitiesRecommendedforYou

B2B Product Opportunities - Recommended for You Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
brand	string	The brand name of the product
lowestPriceInTheLastWeek_amount	string	The lowest price in the last week amount
category	string	The primary product category (on Amazon)
lowestPriceInTheLastWeek_CurrencyCode	string	Three-digit currency code in ISO 4217 format
partNumber	string	The Manufacturer Part Number(MPN) of the product
ean	string	The European Article Number(EAN) of the product
upc	string	The Universal Product Code(UPC) of the product
modelNumber	string	The Model Number of the product
isbn	string	The International Standard Book Number, or ISBN, of each product
ASIN	string	The Amazon Standard Identification Number of the item
link	string	A hyperlink to the Amazon product detail page
itemName	string	The title of the product
subCategory	string	It is the secondary product category
hasFBAOffer	boolean	A value of 'true' means at least one Fulfillment by Amazon (FBA) offer exists on the product. A 'false' means there are no Fulfillment by Amazon (FBA) offers for the product
offerCount	integer	The total number of active offers on each product (including Amazon Retail)
reviewCount	integer	This shows the total number of customer reviews on each product
b2bSalesRank	string	It is the sales rank of each product at the category level. The metric is based only on Amazon Business customer purchases
b2bSalesRankGrowth	string	It measures the growth of business sales rank over the past 30 days. It can be 'High,' 'Medium,' or 'Low.' 'High' means that the product's business sales rank has grown over 33% from the previous month. 'Medium' means that it has grown from 0% to 33%. 'Low' means that the Business Sales Rank has decreased (growth less than 0%)
pageViews	string	It measures the number of times that the specific product has been viewed in the past 30 days. It can be 'High,' 'Medium,' or 'Low.'
isBrandYouOffer	boolean	true: It means the product shares a brand with at least one of your active offers, false: It means the product does not share a brand with any of your active offers
isCategoryYouOffer	boolean	true: It shows that the product shares a category with at least one of your active offers, false: It shows that the product does not share a category with any of your active offers
productPerformance	string	It measures the product sales to Amazon Business customers over the past 30 days. It can be Tier 1, Tier 2, or Tier 3
isProductOnAmazon	boolean	Is product on Amazon
hasAmazonOffer	boolean	True: It means that an active Amazon offer exists on the product. False: It means there are no active Amazon offers for the product
hasOfferWithVatInvoiceGeneration	boolean	This field will be equal to 'true' only if it has at least one offer from a seller who has adopted an automated solution for VAT invoice generation. This type of offer will guarantee that the buyer will have access to a downloadable VAT invoice

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_B2BProductOpportunitiesRecommendedforYou AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_B2BProductOpportunitiesRecommendedforYou (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_BrowseTree

Browse Tree Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
browseNodeAttributes	string	Browse Node Attributes
browseNodeId	long	Browse Node Id
browseNodeName	string	Browse Node Name
browseNodeStoreContextName	string	Browse Node Store Context Name
browsePathById	string	Browse Path By Id
browsePathByName	string	Browse Path By Name
childNodes	string	Child Nodes
hasChildren	boolean	Has Children
productTypeDefinitions	string	Product Type Definitions
refinementsInformation	string	Refinements Information

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_BrowseTree AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_BrowseTree (
		)
	) AS x;;

Report_CanceledListings

Canceled Listings Report
Parameter
<Custom> (optional): A Boolean value that indicates whether a custom report is returned
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
item_name	string	The item name
item_description	string	The item description
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
quantity	bigdecimal	The total number of units reimbursed for this line item
image_url	string	The image url
item_is_marketplace	boolean	Item is marketplace
product_id_type	string	The type of product id
zshop_shipping_fee	bigdecimal	Zshop shipping fee
item_note	string	The item note
item_condition	string	Numeric entry that indicates the condition of the product. This field is required. Note: Not all conditions are available for all categories. For more information about what conditions you may use in your product category, see Condition Guidelines
zshop_category1	string	Zshop category1
zshop_browse_path	string	Zshop browse path
zshop_storefront_feature	string	Zshop storefront feature
asin1	string	The Amazon Standard Identification Number (ASIN) of the item
asin2	string	The Amazon Standard Identification Number (ASIN) of the item
asin3	string	The Amazon Standard Identification Number (ASIN) of the item
will_ship_internationally	string	Will ship internationally
expedited_shipping	string	Expedited shipping
zshop_boldface	string	Zshop boldface
product_id	string	The product id
add_delete	string	Add delete
Business_Price	bigdecimal	A special price that is available only for Amazon Business orders
Quantity_Price_Type	string	Quantity price type
Quantity_Lower_Bound_1	bigdecimal	Quantity lower bound
Quantity_Price_1	bigdecimal	Quantity price
Quantity_Lower_Bound_2	bigdecimal	Quantity lower bound
Quantity_Price_2	bigdecimal	Quantity price
Quantity_Lower_Bound_3	bigdecimal	Quantity lower bound
Quantity_Price_3	bigdecimal	Quantity price
Quantity_Lower_Bound_4	bigdecimal	Quantity lower bound
Quantity_Price_4	bigdecimal	Quantity price
Quantity_Lower_Bound_5	bigdecimal	Quantity lower bound
Quantity_Price_5	bigdecimal	Quantity price
merchant_shipping_group	string	The merchant shipping group
Progressive_Price_Type	string	Progressive price type
Progressive_Lower_Bound_1	bigdecimal	Progressive lower bound
Progressive_Price_1	bigdecimal	Progressive price
Progressive_Lower_Bound_2	bigdecimal	Progressive lower bound
Progressive_Price_2	bigdecimal	Progressive price
Progressive_Lower_Bound_3	bigdecimal	Progressive lower bound
Progressive_Price_3	bigdecimal	Progressive price

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_CanceledListings AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_CanceledListings (
			Custom => false,
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_CouponPerformance

Seller Coupon Performance Report
Parameter
<couponStartDateFrom> (optional): The start of a date and time range used for selecting coupons to report on
<couponStartDateTo> (optional): The end of a date and time range used for selecting coupon campaigns to report on
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	Marketplace the coupon is running in
couponId	string	Unique identifier of the coupon
merchantId	string	Merchant customer ID associated with the coupon
currencyCode	string	The ISO 4217 currency code of all currency values in the coupon
name	string	The name given to the coupon
websiteMessage	string	The message displayed with the coupon on the product page
startDateTime	timestamp	Coupon start date-time in UTC
endDateTime	timestamp	Coupon end date-time in UTC
customerSegment	string	Customer segment that the coupon is available to
discountType	string	Whether the discount is given as a fixed amount or a percentage off the list price
discountAmount	bigdecimal	Discount amount the customer receives. Reflects a percentage when discountType is PERCENT_OFF_LIST_PRICE and a currency value when discountType is AMOUNT_OFF_LIST_PRICE
clips	integer	"Number of times the coupon has been applied on the product page by unique customers
redemptions	integer	Number of times the coupon has been used for a purchase. Represents a gross value, including purchases that were returned or cancelled
budget	bigdecimal	The budget allocated to the coupon to cover discount offering and clip/redemption fees. Currency value
totalDiscount	bigdecimal	Total amount saved by customers redeeming the coupon. Currency value. Represents a gross value, including purchases that were returned or cancelled
budgetSpent	bigdecimal	Total amount spent by the seller on the coupon, including clip fees and redemption fees. Currency value. Represents a gross value, including purchases that were returned or cancelled
budgetRemaining	bigdecimal	The budget remaining for the coupon, equal to budget minus budgetSpent. Currency value. Represents a gross value, including purchases that were returned or cancelled
budgetPercentageUsed	bigdecimal	Percentage of the allocated budget that has been spent, equal to the budgetSpent divided by budget
sales	bigdecimal	Total revenue generated by redemptions of the coupon after the discount. Currency value. Represents a gross value, including purchases that were returned or cancelled

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_CouponPerformance AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_CouponPerformance (
			couponStartDateFrom => NOW(),
			couponStartDateTo => NOW()
		)
	) AS x;;

Report_FBAAmazonFulfilledInventory

FBA Amazon Fulfilled Inventory Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
fulfillment_channel_sku	string	Unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
asin	string	The Amazon Standard Identification Number of the item
condition_type	string	The condition of your inventory
Warehouse_Condition_code	string	Code assigned in Amazon's fulfillment center to listings matching the ASIN and the seller's condition-type
Quantity_Available	bigdecimal	Quantity available

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAAmazonFulfilledInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAAmazonFulfilledInventory (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_FBAAmazonFulfilledShipments

FBA Amazon Fulfilled Shipments Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
amazon_order_id	string	Amazon's unique, displayable identifier for an order
merchant_order_id	string	A unique identifier optionally supplied for the order by the Merchant
shipment_id	string	Encrypted Amazon shipment id
shipment_item_id	string	Encrypted Amazon shipment item id
amazon_order_item_id	string	Amazon's unique, displayable identifier for an item within the order
merchant_order_item_id	string	A unique identifier for an item within the order
purchase_date	timestamp	The date the order was placed
payments_date	timestamp	The date the buyer's credit card was charged and order processing was completed
shipment_date	timestamp	The date the shipment was completed (shipped) by the fulfillment center
reporting_date	timestamp	The date the data for this report became available in the FBA data store
buyer_email	string	The encrypted email address of the buyer
buyer_name	string	The full name of the buyer
buyer_phone_number	bigdecimal	The phone number of the buyer
sku	string	A merchant-defined unique identifier for a product
product_name	string	The short title for the product, displayed in bold on the detail web page and in the title bar of the browser window
quantity_shipped	bigdecimal	The number of this item that were shipped
currency	string	The currency used for the purchase. Supported currencies include USD, CAD, GBP, EUR, and JPY
item_price	bigdecimal	The amount that the buyer paid for the item. Amount is aggregate of the quantity, not unit price
item_tax	bigdecimal	The amount that the buyer paid for item tax. Amount is aggregate of the quantity, not unit price
shipping_price	bigdecimal	The amount that the buyer paid for shipping. Amount is aggregate of the quantity, not unit price
shipping_tax	bigdecimal	The amount that the buyer paid for shipping tax. Amount is aggregate of the quantity, not unit price
gift_wrap_price	string	The amount that the buyer paid for gift wrap. Amount is aggregate of the quantity, not unit price
gift_wrap_tax	string	The amount that the buyer paid for gift wrap tax. Amount is aggregate of the quantity, not unit price
ship_service_level	string	An enumerated value that determines the type of fulfillment service that the buyer expects the merchant to use (e.g., Standard v. Expedited)
recipient_name	string	Name field of a standard address
ship_address_1	string	The first line of a standard address
ship_address_2	string	The second line of a standard address
ship_address_3	string	The third line of a standard address
ship_city	string	The city of a standard address
ship_state	string	The state or region of a standard address
ship_postal_code	string	The postal (ZIP) code of a standard address
ship_country	string	ISO 3166 standard two-letter country code
ship_phone_number	string	The phone number associated with the ship-to address
bill_address_1	string	The first line of a standard address
bill_address_2	string	The second line of a standard address
bill_address_3	string	The third line of a standard address
bill_city	string	The city of a standard address
bill_state	string	The state or region of a standard address
bill_postal_code	string	The postal (zip) code of a standard address
bill_country	string	ISO 3166 standard two-letter country code
item_promotion_discount	bigdecimal	Promotion discount applied to the order item
ship_promotion_discount	bigdecimal	Promotion discount applied to shipping
carrier	string	The name of the carrier the package was shipped with
tracking_number	string	The carrier's tracking number for the package
estimated_arrival_date	date	The estimated date of delivery to the customer
fulfillment_center_id	string	The unique identifier from which fulfillment center the order was shipped
fulfillment_channel	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
sales_channel	string	The source of the order

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAAmazonFulfilledShipments AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAAmazonFulfilledShipments (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_FBAAmazonFulfilledShipmentsTax

FBA Amazon Fulfilled Shipments Report (Tax)
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
amazon_order_id	string	Amazon's unique, displayable identifier for an order
merchant_order_id	string	A unique identifier optionally supplied for the order by the Merchant
shipment_id	string	Amazon shipment ID
shipment_item_id	string	Unique identifier--pertains only to this item in this shipment
amazon_order_item_id	string	Amazon''s unique, displayable identifier for an item within the order
merchant_order_item_id	string	A unique identifier for an item within the order
purchase_date	timestamp	The date the order was placed
payments_date	timestamp	The date the buyer''s credit card was charged and order processing was completed
shipment_date	timestamp	Date of the shipment
reporting_date	timestamp	The date the data for this report became available in the FBA data store
buyer_email	string	The encrypted email address of the buyer
buyer_name	string	The full name of the buyer
buyer_phone_number	string	The phone number of the buyer
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
product_name	string	The name of your product
quantity_shipped	integer	The number of this item that were shipped
currency	string	The currency used for the purchase. Supported currencies include CDN, USD, GBP, EUR, and JPY
item_price	bigdecimal	Price set for an item, minus VAT
item_tax	bigdecimal	The amount the buyer paid for item tax. Amount is aggregate of the quantity, not unit price
shipping_price	bigdecimal	The amount the buyer paid for shipping. Amount is aggregate of the quantity, not unit price
shipping_tax	bigdecimal	The amount the buyer paid for shipping tax. Amount is aggregate of the quantity, not unit price
gift_wrap_price	bigdecimal	The amount the buyer paid for gift wrap. Amount is aggregate of the quantity, not unit price
gift_wrap_tax	bigdecimal	The amount the buyer paid for gift wrap tax. Amount is aggregate of the quantity, not unit price
ship_service_level	string	An enumerated value that determines the type of fulfilment service that the buyer expects the merchant to use (e.g., Standard vs. Expedited)
recipient_name	string	Name field of a standard address
ship_address_1	string	The first line of a standard address
ship_address_2	string	The second line of a standard address
ship_address_3	string	The third line of a standard address
ship_city	string	The city of a standard address
ship_state	string	The state or region of a standard address
ship_postal_code	string	The postal (ZIP) code of a standard address
ship_country	string	ISO 3166 standard two-letter country code
ship_phone_number	string	The phone number associated with the ship-to address
bill_address_1	string	The first line of a standard address
bill_address_2	string	The second line of a standard address
bill_address_3	string	The third line of a standard address
bill_city	string	The city of a standard address
bill_state	string	The state or region of a standard address
bill_postal_code	string	The postal (zip) code of a standard address
bill_country	string	ISO 3166 standard two-letter country code
item_promotion_discount	bigdecimal	Promotion discount applied to the order item
ship_promotion_discount	bigdecimal	Promotion discount applied to shipping
carrier	string	The name of the carrier the package was shipped with. Multiple carriers may be used for a single removal order
tracking_number	string	The carrier''s tracking number for the package, if available. Multiple tracking IDs may exist for a single removal order
estimated_arrival_date	timestamp	The estimated date of delivery to the customer
fulfillment_center_id	string	Fulfillment center where inventory is stored
fulfillment_channel	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
sales_channel	string	The source of the order. Will be either http://Amazon.com or Non Amazon. Non Amazon means the order was not placed on Amazon, but it was fulfilled by Amazon

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAAmazonFulfilledShipmentsTax AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAAmazonFulfilledShipmentsTax (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;

Report_FBABulkFixStrandedInventory

FBA Bulk Fix Stranded Inventory Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
product_id	string	ID designated by Amazon
add_delete	string	Sellers can delete offers without deleting item data contributions by specifying a "d" in the "add-delete" field when submitting Inventory Loader feeds
expedited_shipping	string	Expedited shipping
fulfillment_center_id	string	Fulfillment center where inventory is stored
item_condition	string	Condition of the item being sold
item_note	string	Item Note
leadtime_to_ship	bigdecimal	The time, in days, between when you receive an order and when you can ship the product. The default leadtime-to-ship is 1 to 2 business days
maximum_seller_allowed_price	bigdecimal	This field helps Amazon identify potential pricing errors with your listings. To use it, enter your maximum allowable price for the product
merchant_shipping_group_name	string	Use this field to assign SKUs to a shipping template that was configured in shipping settings
minimum_seller_allowed_price	bigdecimal	This field helps Amazon identify potential pricing errors with your listings. To use it, enter your minimum allowable price for the product
price	bigdecimal	The price set for an item
product_id_type	string	Amazon defines product id type as follows 1 = ASIN 2 = ISBN 3 = UPC 4 = EAN
product_tax_code	string	Your product tax code used in tax calculation
quantity	bigdecimal	Quantity of an item ordered
standard_plus	string	Standard plus
will_ship_internationally	string	Indicates if a SKU can be shipped internationally

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBABulkFixStrandedInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBABulkFixStrandedInventory (
		)
	) AS x;;

Report_FBACustomerShipmentSales

FBA Customer Shipment Sales Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
shipment_date	timestamp	The date the shipment was completed (shipped) by the fulfillment center
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify each seller's products. SKUs are assigned by the seller
fnsku	string	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
asin	string	The Amazon Standard Identification Number of the item
fulfillment_center_id	string	The fulfillment center where the problem is identified
quantity	bigdecimal	The total number of units reimbursed for this line item
amazon_order_id	string	The unique identifier assigned to the customer order. This field is empty if the reimbursement is not associated with an order
currency	string	The currency of the removal fee
item_price_per_unit	string	Item price per unit
shipping_price	bigdecimal	The amount that the buyer paid for shipping. Amount is aggregate of the quantity, not unit price
gift_wrap_price	string	The amount that the buyer paid for gift wrap. Amount is aggregate of the quantity, not unit price
ship_city	string	The city of a standard address
ship_state	string	The state or region of a standard address
ship_postal_code	string	The postal (ZIP) code of a standard address

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBACustomerShipmentSales AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBACustomerShipmentSales (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_FBAFeePreview

FBA Fee Preview Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify your products. SKUs are assigned by you as the seller
fnsku	string	Unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters or numbers that identify products. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
amazon_store	string	The Amazon Store
product_name	string	The title of your product
product_group	string	The Amazon department or category
brand	string	The brand of your product
fulfilled_by	string	The entity that fulfilled the item
your_price	bigdecimal	Your current selling price
sales_price	bigdecimal	Your current promotional price
longest_side	bigdecimal	Measurement of the longest side of your product including its packaging
median_side	bigdecimal	Measurement of the side that is neither the longest nor the shortest side of your product including its packaging
shortest_side	bigdecimal	Measurement of the shortest side of your product including its packaging
length_and_girth	bigdecimal	The longest side of your product, including its packaging, plus the girth, a unit measure, equivalent to 2 x (median side + shortest side)
unit_of_dimension	string	The unit of dimension
item_package_weight	bigdecimal	The item package weight
unit_of_weight	string	The unit of weight used in weight measurement
product_size_tier	string	The size tier assigned to your product by FBA based on its dimensions and weight
currency	string	The currency in which the fee is calculated
estimated_fee_total	bigdecimal	The estimated fulfillment and Selling on Amazon fee
estimated_referral_fee_per_unit	bigdecimal	The estimated Selling on Amazon Referral Fee
estimated_variable_closing_fee	bigdecimal	The estimated Variable Closing Fee for your product
estimated_order_handling_fee_per_order	bigdecimal	The estimated Order Handling Fee per order
estimated_pick_pack_fee_per_unit	bigdecimal	Estimated pick pack fee per unit
estimated_weight_handling_fee_per_unit	bigdecimal	The estimated Weight Handling Fee for your product based on the Outbound Shipping Weight
expected_fulfillment_fee_per_unit	bigdecimal	Expected fulfillment fee per unit

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAFeePreview AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAFeePreview (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_FBAInboundPerformance

FBA Inbound Performance Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
issue_reported_date	timestamp	Date shipment problem was resolved
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
alert_status	string	Indicates whether the problem has been acknowledged
coaching_level	string	The coaching level for a particular problem group. One of the following: Standard, Elevated, Critical
currency	string	The currency used for the purchase. Supported currencies include CDN, USD, GBP, EUR, and JPY
expected_quantity	bigdecimal	The number of units we expected to receive at the fulfillment center
fba_carton_id	string	Box ID in which the problem was identified
fba_shipment_id	string	Shipment ID in which the problem was identified
fee_total	bigdecimal	The total unplanned Service fees charged
fee_type	string	One of the following: Unplanned Service fee, Unplanned Service fee (Preview), Exempt, Refund
fnsku	string	Fulfillment Network Stock Keeping Units (FNSKUs) are unique identifiers assigned by Amazon to products stored in and fulfilled from Amazon fulfillment centers
fulfillment_center_id	string	The fulfillment center where the problem is identified
performance_measurement_unit	string	The unit of measurement for the particular problem type. For example, whether the problem occurred at the unit, box, or shipment level
problem_level	string	The level of problem. One of the following: Units, Shipment
problem_quantity	integer	Number of units to which the problem applies
problem_type	string	The type of problem identified, for example: Barcode cannot be scanned, Item label missing
product_name	string	The name of your product
received_quantity	integer	The number of units we received at the fulfillment center
shipment_creation_date	timestamp	The date you created the shipment

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAInboundPerformance AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAInboundPerformance (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_FBALongTermStorageFeeCharges

FBA Long Term Storage Fee Charges Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
condition	string	The condition of your product
country	string	Country in which your products are stored
currency	string	The currency used for the purchase. Supported currencies include CDN, USD, GBP, EUR, and JPY
enrolled_in_small_and_light	boolean	Enrolled in small and light
fnsku	string	Fulfillment Network Stock Keeping Units (FNSKUs) are unique identifiers assigned by Amazon to products stored in and fulfilled from Amazon fulfillment centers
long_time_range_long_term_storage_fee	bigdecimal	Qty charged long time range long term storage fee
per_unit_volume	bigdecimal	The volume in cubic feet of each inventory unit assessed the Long-Term Storage Fee
product_name	string	The name of your product
qty_charged_long_time_range_long_term_storage_fee	bigdecimal	Qty charged long time range long term storage fee
qty_charged_short_time_range_long_term_storage_fee	bigdecimal	Qty charged short time range long term storage fee
short_time_range_long_term_storage_fee	bigdecimal	Short time range long term storage fee
snapshot_date	timestamp	The date the report was generated
volume_unit	string	Volume unit
amount_charged	bigdecimal	Amount Charged
surcharge_age_tier	string	Surcharge Age Tier
rate_surcharge	bigdecimal	Rate Surcharge

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBALongTermStorageFeeCharges AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBALongTermStorageFeeCharges (
		)
	) AS x;;

Report_FBAManageInventory

FBA Manage Inventory
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify your products
fnsku	string	Fulfillment Network Stock Keeping Units (FNSKUs) are unique identifiers assigned by Amazon to products stored in and fulfilled from Amazon fulfillment centers
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
product_name	string	The title of your product
condition	string	The condition of your product
your_price	bigdecimal	Your current selling price
mfn_listing_exists	boolean	"Yes" indicates that the product is listed for fulfillment by you as the seller
mfn_fulfillable_quantity	bigdecimal	The quantity in your fulfillment network that can be picked, packed, and shipped
afn_listing_exists	boolean	"Yes" indicates that the item is listed for Fulfillment by Amazon
afn_warehouse_quantity	integer	The number of units you have for an SKU in Amazon fulfillment centers that have been processed: (afn-warehouse-quantity) = (afn-fulfillable-quantity) + (afn-unsellable-quantity) + (afn-reserved-quantity)
afn_fulfillable_quantity	integer	The number of units you have for a SKU in Amazon fulfillment centers that can be picked, packed, and shipped
afn_unsellable_quantity	integer	The number of units you have for a SKU in Amazon fulfillment centers in unsellable condition
afn_reserved_quantity	integer	The number of units you have for a SKU in Amazon fulfillment centers that are currently being picked, packed, and shipped or are sidelined for measurement, sampling, or other internal processes
afn_total_quantity	integer	The total number of units you have for a SKU in an inbound shipment or in Amazon fulfillment centers: (afn-total-quantity) = (afn-warehouse-quantity) + (afn-inbound-working-quantity) + (afn-inbound-shipped-quantity) + (afn-inbound-receiving-quantity)
per_unit_volume	bigdecimal	The volume in cubic feet of one unit (to the nearest 1/100 of an inch)
afn_inbound_working_quantity	integer	The number of units you have for a SKU in an inbound shipment that you have notified Amazon about
afn_inbound_shipped_quantity	integer	The number of units you have for a SKU in an inbound shipment that you have notified Amazon about and provided a tracking number
afn_inbound_receiving_quantity	integer	The number of units you have for a SKU that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed
afn_researching_quantity	string	Afn researching quantity
afn_reserved_future_supply	bigdecimal	The number of units that customers have purchased while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start
afn_future_supply_buyable	bigdecimal	The number of units available for customers to find and buy while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAManageInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAManageInventory (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_FBAManageInventoryArchived

FBA Manage Inventory - Archived
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify your products
fnsku	string	Fulfillment Network Stock Keeping Units (FNSKUs) are unique identifiers assigned by Amazon to products stored in and fulfilled from Amazon fulfillment centers
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
product_name	string	The title of your product
condition	string	The condition of your product
your_price	bigdecimal	Your current selling price
mfn_listing_exists	boolean	"Yes" indicates that the product is listed for fulfillment by you as the seller
mfn_fulfillable_quantity	bigdecimal	The quantity in your fulfillment network that can be picked, packed, and shipped
afn_listing_exists	boolean	"Yes" indicates that the item is listed for Fulfillment by Amazon
afn_warehouse_quantity	integer	The number of units you have for an SKU in Amazon fulfillment centers that have been processed: (afn-warehouse-quantity) = (afn-fulfillable-quantity) + (afn-unsellable-quantity) + (afn-reserved-quantity)
afn_fulfillable_quantity	integer	The number of units you have for a SKU in Amazon fulfillment centers that can be picked, packed, and shipped
afn_unsellable_quantity	integer	The number of units you have for a SKU in Amazon fulfillment centers in unsellable condition
afn_reserved_quantity	integer	The number of units you have for a SKU in Amazon fulfillment centers that are currently being picked, packed, and shipped or are sidelined for measurement, sampling, or other internal processes
afn_total_quantity	integer	The total number of units you have for a SKU in an inbound shipment or in Amazon fulfillment centers: (afn-total-quantity) = (afn-warehouse-quantity) + (afn-inbound-working-quantity) + (afn-inbound-shipped-quantity) + (afn-inbound-receiving-quantity)
per_unit_volume	bigdecimal	The volume in cubic feet of one unit (to the nearest 1/100 of an inch)
afn_inbound_working_quantity	integer	The number of units you have for a SKU in an inbound shipment that you have notified Amazon about
afn_inbound_shipped_quantity	integer	The number of units you have for a SKU in an inbound shipment that you have notified Amazon about and provided a tracking number
afn_inbound_receiving_quantity	integer	The number of units you have for a SKU that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed
afn_researching_quantity	string	Afn researching quantity
afn_reserved_future_supply	bigdecimal	The number of units that customers have purchased while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start
afn_future_supply_buyable	bigdecimal	The number of units available for customers to find and buy while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAManageInventoryArchived AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAManageInventoryArchived (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_FBAManageInventoryHealth

FBA Manage Inventory Health Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
snapshot_date	date	The date the report was generated
asin	string	Unique blocks of 10 letters or numbers that Amazon assigns to the products that are sold through Amazon
sku	string	Unique blocks of letters and numbers that you assign to the products that you are selling
alert	string	This is displayed when an item has a low-traffic or low-conversion alert. Low traffic indicates that a low number of potential buyers have seen the listing. Low conversion indicates that potential buyers are viewing the listing but aren''t following through to buy the product
available	integer	Available (sellable inventory) quantity
condition	string	The condition of the unit (for example, new or used)
currency	string	The currency for the estimated aged inventory surcharge
days_of_supply	bigdecimal	The estimated number of days that your current inventory supply will last based on the projected demand for your product
estimated_ais_181_210_days	bigdecimal	The estimated aged inventory surcharge amount for units that have been in fulfillment centers for 181 to 210 days on the next charge date
estimated_ais_211_240_days	bigdecimal	The estimated aged inventory surcharge amount for units that have been in fulfillment centers for 211 to 240 days on the next charge date
estimated_ais_241_270_days	bigdecimal	The estimated aged inventory surcharge amount for units that have been in fulfillment centers for 241 to 270 days on the next charge date
estimated_ais_271_300_days	bigdecimal	The estimated aged inventory surcharge amount for units that have been in fulfillment centers for 271 to 300 days on the next charge date
estimated_ais_301_330_days	bigdecimal	The estimated aged inventory surcharge amount for units that have been in fulfillment centers for 301 to 330 days on the next charge date
estimated_ais_331_365_days	bigdecimal	The estimated aged inventory surcharge amount for units that have been in fulfillment centers for 331 to 365 days on the next charge date
estimated_ais_365_plus_days	bigdecimal	The estimated aged inventory surcharge amount for units that have been in fulfillment centers for 365+ days on the next charge date
estimated_cost_savings_of_recommended_actions	bigdecimal	Estimated cost savings between taking the recommended action versus the storage fees you would incur on that inventory by taking no action
estimated_excess_quantity	bigdecimal	Estimated excess units are overstocked units based on your current sales velocity and customer demand forecast. It''s costing you more to keep these units on hand and pay storage fees than to reduce the number of units through a price reduction or removal
estimated_storage_cost_next_month	bigdecimal	Estimated storage fees (monthly storage + storage utilization surcharge + aged inventory surcharge) that you would incur 30 days from today, based on your current sales rate
Exempted_from_Low_Inventory_Level_fee	boolean	Exempted from Low Inventory Level fee?
fba_inventory_level_health_status	string	Inventory-level category based on evaluating sellable on-hand quantity against the recommended minimum level and estimated excess units
fba_minimum_inventory_level	bigdecimal	The minimum amount of FBA sellable inventory units that we recommend you maintain within the Amazon fulfillment network before your next incoming shipment arrives
featuredoffer_price	bigdecimal	Offer displayed on a product detail page with an Add to Cart button
fnsku	string	Unique blocks of letters and numbers that Amazon assigns to products that are stored in and fulfilled from an Amazon fulfillment center
historical_days_of_supply	bigdecimal	Historical days of supply
inbound_quantity	bigdecimal	Inbound quantity = inbound-working + inbound-shipped + inbound receiving
inbound_received	bigdecimal	Shipments in receiving status
inbound_shipped	bigdecimal	Shipments in shipped status
inbound_working	bigdecimal	Shipments in working status
inv_age_0_to_30_days	integer	The number of sellable units that have been in the fulfillment center for the last 0-30 days
inv_age_0_to_90_days	integer	The number of sellable units that have been in the fulfillment center for the last 0-90 days
inv_age_181_to_270_days	integer	The number of sellable units that have been in the fulfillment center for the last 181-270 days
inv_age_181_to_330_days	integer	The number of sellable units that have been in the fulfillment center for the last 181-330 days
inv_age_271_to_365_days	integer	The number of sellable units that have been in the fulfillment center for the last 271-365 days
inv_age_31_to_60_days	integer	The number of sellable units that have been in the fulfillment center for the last 31-60 days
inv_age_331_to_365_days	integer	The number of sellable units that have been in the fulfillment center for the last 331-365 days
inv_age_365_plus_days	integer	The number of sellable units that have been in the fulfillment center for the last 365+ days
inv_age_61_to_90_days	integer	The number of sellable units that have been in the fulfillment center for the last 61-90 days
inv_age_91_to_180_days	integer	The number of sellable units that have been in the fulfillment center for the last 91-180 days
Inventory_age_snapshot_date	date	Inventory age snapshot date
Inventory_Supply_at_FBA	integer	Inventory Supply at FBA
item_volume	bigdecimal	The volume of the item, which is calculated by multiplying the longest side, median side, and shortest side together. These measurements generally correspond to the length, width, and height of the item
Last_updated_date_for_Historical_Days_of_Supply	date	Last updated date for Historical Days of Supply
Long_term_historical_days_of_supply	bigdecimal	Long term historical days of supply
Low_Inventory_Level_fee_applied_in_current_week	boolean	Low Inventory Level fee applied in current week?
lowest_price_new_plus_shipping	bigdecimal	The lowest price (including shipping) for this item in new condition on Amazon
lowest_price_used	bigdecimal	The lowest price (including shipping) for this item in used condition on Amazon
marketplace	string	The Amazon store where the product is located
no_sale_last_6_months	bigdecimal	Inventory that has not sold in six or more consecutive months and that have been in fulfillment centers for more than 180 days. These units will be automatically removed during the next removal cycle if you are opted in to automated fulfillable inventory removals
pending_removal_quantity	bigdecimal	The number of units that you have asked to be returned to you or disposed of
product_group	string	Distinct product grouping distinguishing products like books, from watches or video games
product_name	string	The name of your product
quantity_to_be_charged_ais_181_210_days	bigdecimal	The number of available units that will have been in the fulfillment center for 181 to 210 days and would be subject to the 181-day aged inventory surcharge as of the next charge date
quantity_to_be_charged_ais_211_240_days	bigdecimal	The number of available units that will have been in the fulfillment center for 211 to 240 days and would be subject to the 211-day aged inventory surcharge as of the next charge date
quantity_to_be_charged_ais_241_270_days	bigdecimal	The number of available units that will have been in the fulfillment center for 241 to 270 days and would be subject to the 241-day aged inventory surcharge as of the next charge date
quantity_to_be_charged_ais_271_300_days	bigdecimal	The number of available units that will have been in the fulfillment center for 271 to 300 days and would be subject to the 271-day aged inventory surcharge as of the next charge date
quantity_to_be_charged_ais_301_330_days	bigdecimal	The number of available units that will have been in the fulfillment center for 301 to 330 days and would be subject to the 301-day aged inventory surcharge as of the next charge date
quantity_to_be_charged_ais_331_365_days	bigdecimal	The number of available units that will have been in the fulfillment center for 331 to 365 days and would be subject to the 331-day aged inventory surcharge as of the next charge date
quantity_to_be_charged_ais_365_plus_days	bigdecimal	The number of available units that will have been in the fulfillment center for 365+ days and would be subject to the 365-day aged inventory surcharge as of the next charge date
recommended_action	string	The action recommended for your inventory. Recommendations are based on your current customer demand and on whether it would cost you less to take an action than to do nothing
recommended_order_date	date	Recommended order date
recommended_order_quantity	integer	Recommended order quantity
recommended_removal_quantity	bigdecimal	Estimated number of units that would likely benefit from removal instead of being charged storage fees
recommended_sale_duration_days	bigdecimal	If a sale is recommended, this is the estimated sale duration in days that would likely help you sell through your excess inventory
recommended_sales_price	bigdecimal	Sales price recommended to help you sell through your inventory based on your current inventory settings. This value may be different from the lowest price or Featured Offer price. We recommend that you keep your product at this price until you have sold through your excess inventory
Recommended_ship_in_date	date	Recommended ship in date
Recommended_ship_in_quantity	integer	Recommended ship in quantity
Reserved_Customer_Order	integer	The number of products currently reserved for customer orders
Reserved_FC_Processing	integer	The number of products that are currently under processing
Reserved_FC_Transfer	integer	The number of products being transported from one fulfillment center to the next
reserved_quantity	bigdecimal	The number of units you have for a SKU in Amazon fulfillment centers that are currently being picked, packed, and shipped or are sidelined for measurement, sampling, or other internal processes
sales_price	bigdecimal	Your sales price if you are running a sale on the product
sales_rank	bigdecimal	The current rank for your product. The change in sales rank value is the plus or minus change in the past 7 days
sales_shipped_last_30_days	bigdecimal	Shipped-unit sales in the last 30 days
sales_shipped_last_60_days	bigdecimal	Shipped-unit sales in the last 60 days
sales_shipped_last_7_days	bigdecimal	Shipped-unit sales in the last 7 days
sales_shipped_last_90_days	bigdecimal	Shipped-unit sales in the last 90 days
sell_through	bigdecimal	The rate at which your units sold and shipped over the past 90 days divided by the average inventory available at fulfillment centers during that time. Tracking your sell-through rate can help you determine whether you need to take action to improve traffic or conversion for your products
Short_term_historical_days_of_supply	bigdecimal	Short term historical days of supply
storage_type	string	Storage-type category of the product for which storage limits are set
storage_volume	bigdecimal	Storage volume is the total usage for this product in our fulfillment centers minus inventory that is pending removal
Total_Days_of_Supply_including_units_from_open_shipments	integer	Total Days of Supply including units from open shipments
Total_Reserved_Quantity	integer	The total number of units in Amazon''s fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes
unfulfillable_quantity	bigdecimal	Unfulfillable quantity
units_shipped_t30	bigdecimal	Units shipped in the last 30 days
units_shipped_t60	bigdecimal	Units shipped in the last 60 days
units_shipped_t7	bigdecimal	Units shipped in the last 7 days
units_shipped_t90	bigdecimal	Units shipped in the last 90 days
volume_unit_measurement	string	Unit of measurement for the volume of the item
weeks_of_cover_t30	bigdecimal	Your historical trailing 30-day on-hand inventory average divided by your units sold over the same time period divided by 4 weeks. If you sold 400 units of a given item in the last 30 days (4 weeks) and had 100 sellable units in fulfillment centers, your weeks of cover last 30 days would be 1
weeks_of_cover_t90	bigdecimal	Your historical trailing 90-day on-hand inventory average divided by your units sold over the same time period divided by 12 weeks. If you sold 400 units of a given item in the last 90 days (12 weeks) and had an average of 10 sellable units in fulfillment centers, your weeks of cover last 90 days would be 3.33
your_price	bigdecimal	Your listed price

Example

CODE

CREATE VIEW amazon_sp_examples.example_Report_FBAManageInventoryHealth AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAManageInventoryHealth (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_FBAMultiCountryInventory

FBA Multi-Country Inventory Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
fulfillment_channel_sku	string	Unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
asin	string	The Amazon Standard Identification Number of the item
condition_type	string	The condition of your inventory
country	string	Country in which your products are stored
quantity_for_local_fulfillment	bigdecimal	Quantity for local fulfillment

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAMultiCountryInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAMultiCountryInventory (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_FBAPromotions

FBA Promotions Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
shipment_date	timestamp	Date the item shipped to the customer
currency	string	Local currency for the transaction
item_promotion_discount	bigdecimal	Promotion value applied to this shipment item
item_promotion_id	string	Unique identifier for this promotion
description	string	Description of the promotion
promotion_rule_value	string	Maximum net value of the promotion
amazon_order_id	string	Order id of shipment to which the promotion was applied
shipment_id	string	Unique identifier for this item in this shipment
shipment_item_id	string	Unique identifier--pertains only to this item in this shipment

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAPromotions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAPromotions (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_FBARecommendedRemoval

FBA Recommended Removal Report
Parameter
<reportId> (optional): Id of the report to parse
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
snapshot_date	timestamp	Report data are current as of the date in this field
sku	string	Stock keeping units (SKUs) are unique blocks of letters or numbers that identify your products. SKUs are assigned by you as the seller
fnsku	string	Unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters or numbers that identify products. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
product_name	string	The title of your product
condition	string	The condition of your product
sellable_quantity	integer	The number of units you have for a SKU in sellable condition in our fulfillment network
sellable_271_365_days	integer	The number of sellable units you have for a SKU that have been in the fulfillment center for the last 271 to 365 days
sellable_365__days	string	he number of sellable units you have for a SKU that have been in the fulfillment center for 365 days
sellable_removal_quantity	integer	The number of sellable units you have for a SKU that will have been in the fulfillment center for 181 to 365 days or 365 days or more on the next Inventory Cleanup date and need to be removed (assuming no further sales) to avoid the long-term storage fee
unsellable_quantity	integer	The number of unsellable units you have for a SKU in our fulfillment network
unsellable_0_7_days	integer	The number of units that have been unsellable for zero to seven days
unsellable_8_60_days	integer	The number of units that have been unsellable for eight to 60 days
unsellable_61_90_days	integer	The number of units that have been unsellable for 61 to 90 days
sellable_121_180_days	integer	The number of sellable units you have for a SKU that have been in the fulfillment center for the past 121 to 180 days
sellable_181_270_days	integer	The number of sellable units you have for a SKU that have been in the fulfillment center for the past 181 to 270 days

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBARecommendedRemoval AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBARecommendedRemoval (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_FBAReimbursements

FBA Reimbursements Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
approval_date	timestamp	The date the reimbursement was approved
reimbursement_id	string	The unique identifier for this reimbursement. Each reimbursement may include multiple line items
case_id	string	The unique identifier assigned to the case when you request a reimbursement
amazon_order_id	string	The unique identifier assigned to the customer order. This field is empty if the reimbursement is not associated with an order
reason	string	The reason for the reimbursement (for example, Damaged: Warehouse)
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify each seller''s products. SKUs are assigned by the seller
fnsku	string	fnsku
asin	string	An ASIN (Amazon Standard Identification Numbers) is a unique identifier assigned by Amazon to products in the Amazon product catalog. The ASIN can be found on the product detail page
product_name	string	The title of your product
condition	string	The condition of your item (for example, New)
currency_unit	string	The currency for the applicable marketplace
amount_per_unit	bigdecimal	The per-unit reimbursement amount for this line item
amount_total	bigdecimal	The total amount of the cash reimbursement for this line item
quantity_reimbursed_cash	bigdecimal	The total number of units reimbursed with cash
quantity_reimbursed_inventory	bigdecimal	The number of units reimbursed with inventory
quantity_reimbursed_total	bigdecimal	The total number of units reimbursed with either cash or inventory (Quantity Reimbursed Cash + Quantity Reimbursed Inventory)
original_reimbursement_id	string	The number of units reimbursed with id
original_reimbursement_type	string	The number of units reimbursed with type

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAReimbursements AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAReimbursements ()
	) AS x

Report_FBARemovalOrderDetail

FBA Removal Order Detail Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
request_date	timestamp	Date the removal order was submitted
last_updated_date	timestamp	Date of the most recent order update
order_id	string	Amazon's unique, displayable identifier for an order. This is an alphanumeric value. Go to Manage Orders to search for an order ID that includes letters, as they are not searchable in all tools
currency	string	Currency code for the marketplace, which is also the currency code for all prices listed in the records
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
cancelled_quantity	integer	The total number of units of this FNSKU cancelled from the removal order
disposed_quantity	integer	The total number of units for this FNSKU that were disposed of
disposition	string	The status of the unit
fnsku	string	Amazon's Fulfillment network SKU identifier
in_process_quantity	integer	The total number of units for this FNSKU that are in process
order_status	string	Removal order status
order_type	string	Removal order type (Return, Disposal)
removal_fee	bigdecimal	The total removal fee for all the units of this FNSKU Note: If this cell is blank, no fee was found or the order is incomplete
requested_quantity	integer	The number of units of this FNSKU requested in the removal order
shipped_quantity	integer	The total number of units for this FNSKU that were shipped for this return

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBARemovalOrderDetail AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBARemovalOrderDetail ()
	) AS x

Report_FBARemovalShipmentDetail

FBA Removal Shipment Detail Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
request_date	timestamp	Date the removal order was submitted
shipment_date	timestamp	Date of the shipment confirmation
order_id	string	Amazon's unique, displayable identifier for an order. This is an alphanumeric value. Go to Manage Orders to search for an order ID that includes letters, as they are not searchable in all tools
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
carrier	string	The name of the carrier the package was shipped with. Multiple carriers may be used for a single removal order
disposition	string	The status of the unit
fnsku	string	Amazon's Fulfillment network SKU identifier
removal_order_type	string
shipped_quantity	integer	The total number of units for this FNSKU that were shipped for this return
tracking_number	string	The carrier's tracking number for the package, if available. Multiple tracking IDs may exist for a single removal order

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBARemovalShipmentDetail AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBARemovalShipmentDetail ()
	) AS x

Report_FBAReplacements

FBA Replacements Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
original_amazon_order_id	string	Order ID of original shipment
fulfillment_center_id	string	Fulfillment center shipping this unit
original_fulfillment_center_id	string	Original fulfillment center shipping free replaced item
quantity	bigdecimal	Quantity of an item ordered
replacement_amazon_order_id	string	Order ID of the replacement order
replacement_reason_code	integer	Reason for replacement: see Free Replacement Reasons
shipment_date	timestamp	Date of free replacement shipment

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAReplacements AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAReplacements (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_FBAReservedInventory

FBA Reserved Inventory Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify your products. SKUs are assigned by you as the seller
fnsku	string	Unique identifier assigned by Amazon to items stored in and fulfilled from an Amazon fulfillment center
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
product_name	string	The title of your product
reserved_qty	bigdecimal	The total number of units in reserved status
reserved_customerorders	bigdecimal	The number of units reserved for customer orders
reserved_fc_transfers	integer	The number of units being transferred from one fulfillment center to another
reserved_fc_processing	integer	The number of units that have been sidelined at the fulfillment center for additional processing

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAReservedInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAReservedInventory (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_FBAReturns

FBA Returns Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
return_date	timestamp	Return date
order_id	string	Amazon''s unique identifying number for the order. Used for shipping confirmation and post-order processing
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify each seller''s products. SKUs are assigned by the seller
asin	string	The Amazon Standard Identification Number of the item
fnsku	string	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
product_name	string	The title of your product
quantity	bigdecimal	The total number of units reimbursed for this line item
fulfillment_center_id	string	The fulfillment center where the problem is identified
detailed_disposition	string	Status of the product (examples: sellable, damaged)
reason	string	The reason for the reimbursement (for example, Damaged: Warehouse)
status	string	Current status of this item within the order
license_plate_number	string	License plate number
customer_comments	string	Customer comments

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAReturns AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAReturns (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_FBAStorageFees

FBA Storage Fees Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
month_of_charge	date	Month of year in which storage-fee estimate applies; format is YEAR-MONTH
fnsku	string	Fulfillment Network Stock Keeping Units (FNSKUs) are unique identifiers assigned by Amazon to products stored in and fulfilled from Amazon fulfillment centers
product_name	string	Description of the ASIN on the product-detail page
fulfillment_center	string	Fulfillment center in which the ASIN is stored
country_code	string	Country in which the fulfillment center is located
longest_side	bigdecimal	The dimensions of the longest side of a single unit of the item. The inventory storage fee is charged by volume in cubic feet, which equals the longest side x median side x shortest side. These often correspond to the length, width, and height of an item
median_side	bigdecimal	The dimensions of the side of a single unit of the item that is neither the longest nor the shortest. The inventory storage fee is charged by volume in cubic feet, which equals the longest side x median side x shortest side. These often correspond to the length, width, and height of an item
shortest_side	bigdecimal	The dimensions of the shortest side of a single unit of the item. The inventory storage fee is charged by volume in cubic feet, which equals the longest side x median side x shortest side. These often correspond to the length, width, and height of an item
measurement_units	string	Unit of measurement for the longest, median, and shortest sides of the item for purposes of calculating the inventory storage fee
weight	bigdecimal	The item''s weight used to identify its product-size tier. This can be the item''s unit weight or dimensional weight, depending on the item
weight_units	string	Unit of measurement for the weight of the item
item_volume	bigdecimal	The inventory storage fee is charged per volume in cubic feet, which equals the longest side x median side x shortest side. These often correspond to the length, width, and height of an item
volume_units	string	Unit of measurement for the volume of the item
product_size_tier	string	Classification of the item by its dimensions for purposes of calculating fees
average_quantity_on_hand	bigdecimal	Daily average quantity of the item in fulfillment centers. This is equal to the inventory for the trailing month divided by the number of days in that month
average_quantity_pending_removal	bigdecimal	Daily average quantity of items for which removal from the fulfillment center was requested
estimated_total_item_volume	bigdecimal	Average volume on hand, minus average volume pending removal, multiplied by the volume of the item
storage_rate	bigdecimal	Amount of the monthly inventory storage fee that will apply to this ASIN
currency	string	The currency used for the purchase. Supported currencies include CDN, USD, GBP, EUR, and JPY
estimated_monthly_storage_fee	bigdecimal	Estimated monthly storage fee per ASIN
dangerous_goods_storage_type	string	Dangerous goods storage type
eligible_for_inventory_discount	boolean	Eligible for inventory discount
qualifies_for_inventory_discount	boolean	Qualifies for inventory discount
total_incentive_fee_amount	bigdecimal	Total incentive fee amount
breakdown_incentive_fee_amount	string	Breakdown incentive fee amount
average_quantity_customer_orders	bigdecimal	Average quantity customer orders

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAStorageFees AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAStorageFees (
		)
	) AS x;;

Report_FBAStrandedInventory

FBA Stranded Inventory Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
primary_action	string	Action needed to bring your inventory out of stranded status. The possible actions are: Relist: For products that have been listed previously but do not have an active offer, click Add a Product in the Inventory drop-down menu to create an offer. If you see a message indicating that your product is already listed but needs to be edited, click the provided link to update your listing. Create removal order: For products you no longer want to sell, go to the Manage FBA Inventory page, select the product, and choose Create Removal Order from the drop-down menu on top. Change to Fulfilled by Amazon: If you have an offer, but it is for a product that you fulfill yourself, none of your FBA inventory for that product will be available for sale. On your Manage Inventory page, select the product and click Change to Fulfilled by Amazon in the Action drop-down menu to enable FBA to pick, pack, and ship those products. Create a new listing: If you have FBA inventory of a product that has never been listed, create a listing for your SKU by clicking Add a Product in the Inventory drop-down menu. Note: When relisting a product or creating a listing, the following information must match the units in your FBA inventory: ASIN Condition Merchant SKU If these fields don't match, the stranded inventory in the fulfillment center won't be associated with the new listing
date_stranded	date	This date shows how long your inventory has been stranded and without an active offer
Date_to_take_auto_removal	string	Date to take auto removal
status_primary	string	Identifies whether the offer is active, inactive, or incomplete. Incomplete offers are those missing price or condition
status_secondary	string	For inactive offers, this field identifies the reasons - for example, blocked or out of stock
error_message	string	For select inactive offers, additional information is displayed here - for example, quality alerts
stranded_reason	string	Stranded reason
asin	string	The Amazon Standard Identification Number of the item
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify each seller's products. SKUs are assigned by the seller
fnsku	string	fnsku
product_name	string	The title of your product
condition	string	The condition of your product
fulfilled_by	string	The entity that fulfilled the item
fulfillable_qty	bigdecimal	The number of units of a SKU that you have in Amazon fulfillment centers and that are in unsellable condition
your_price	bigdecimal	Your current selling price
unfulfillable_qty	bigdecimal	The number of units of a SKU that you have in Amazon fulfillment centers and that are in unsellable condition
reserved_quantity	bigdecimal	The number of units of a SKU that you have in Amazon fulfillment centers and that are currently being picked, packed, and shipped or that are sidelined for measurement, sampling, or other internal processes
inbound_shipped_qty	bigdecimal	The number of units of a SKU that you have shipped to Amazon and that are in transit

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FBAStrandedInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FBAStrandedInventory ()
	) AS x

Report_FlatFileArchivedOrdersByOrderDate

Flat File Archived Orders Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
amazon_order_id	string	Amazon''s unique, displayable identifier for an order
merchant_order_id	string	A unique identifier optionally supplied for the order by the Merchant
purchase_date	timestamp	The date the order was placed
last_updated_date	timestamp	The date of the most recent order update
order_status	string	Current status of the customer order
fulfillment_channel	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
sales_channel	string	Channel through which the order was purchased
order_channel	string	The sub channel through which a sale was made for CBA/WBA orders
ship_service_level	string	An enumerated value that determines the type of fulfillment service that the buyer expects the merchant to use (e.g., standard versus expedited)
product_name	string	The short title for the product, displayed in bold on the detail web page and in the title bar of the browser window
sku	string	A merchant-defined unique identifier for a product
asin	string	Amazon inventory ID
item_status	string	Current status of this item within the order
quantity	bigdecimal	The number of this item that were purchased
currency	string	The currency used for the purchase. Supported currencies include USD, CAD, GBP, EUR, and JPY
item_price	bigdecimal	The amount the buyer paid for the item. Amount is aggregate of the quantity, not unit price
item_tax	bigdecimal	The amount the buyer paid for item tax. Amount is aggregate of the quantity, not unit price
shipping_price	bigdecimal	The amount the buyer paid for shipping. Amount is aggregate of the quantity, not unit price
shipping_tax	bigdecimal	The amount the buyer paid for shipping tax. Amount is aggregate of the quantity, not unit price
gift_wrap_price	bigdecimal	The amount the buyer paid for gift wrap. Amount is aggregate of the quantity, not unit price
gift_wrap_tax	bigdecimal	The amount the buyer paid for gift wrap tax. Amount is aggregate of the quantity, not unit price
item_promotion_discount	bigdecimal	Total of all promotion discounts applied to the order item
ship_promotion_discount	bigdecimal	Promotion discount applied to shipping
ship_city	string	The city of a standard address
ship_state	string	The state or region of a standard address
ship_postal_code	string	The postal (zip) code of a standard address
ship_country	string	ISO 3166 standard two-letter country code
promotion_ids	string	List of all item promotions applied to this order item
is_business_order	string	Is business order
purchase_order_number	string
	price_designation	string

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileArchivedOrdersByOrderDate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileArchivedOrdersByOrderDate (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -30, CURDATE ())
		)
	) AS x

Report_FlatFileFeedback

Flat File Feedback Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<parsing_templates> (optional): Templates by currency for converting report data as triplets of currency|date template|timestamp template e.g. EUR|dd.MM.yyyy|dd.MM.yyyy HH:mm:ssZ
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
Date	date	Date
Order_ID	string	Amazon order number
Comments	string	Comments
Rater_Email	string	Rater Email
Rating	bigdecimal	Rating on a scale of 1-5, but the API presently only provides Ratings of 3-5
Response	string	Response

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileFeedback AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileFeedback (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_FlatFileOrdersByLastUpdate

Flat File Orders By Last Update Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
amazon_order_id	string	Amazon's unique, displayable identifier for an order
merchant_order_id	string	A unique identifier optionally supplied for the order by the Merchant
purchase_date	timestamp	The date the order was placed
last_updated_date	timestamp	The date of the most recent order update
order_status	string	Current status of the customer order
fulfillment_channel	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
sales_channel	string	Channel through which the order was purchased
order_channel	string	The sub channel through which a sale was made for CBA/WBA orders
ship_service_level	string	An enumerated value that determines the type of fulfillment service that the buyer expects the merchant to use (e.g., standard versus expedited)
product_name	string	The short title for the product, displayed in bold on the detail web page and in the title bar of the browser window
sku	string	A merchant-defined unique identifier for a product
asin	string	Amazon inventory ID
item_status	string	Current status of this item within the order
quantity	bigdecimal	The number of this item that were purchased
currency	string	The currency used for the purchase. Supported currencies include USD, CAD, GBP, EUR, and JPY
item_price	bigdecimal	The amount the buyer paid for the item. Amount is aggregate of the quantity, not unit price
item_tax	bigdecimal	The amount the buyer paid for item tax. Amount is aggregate of the quantity, not unit price
shipping_price	bigdecimal	The amount the buyer paid for shipping. Amount is aggregate of the quantity, not unit price
shipping_tax	bigdecimal	The amount the buyer paid for shipping tax. Amount is aggregate of the quantity, not unit price
gift_wrap_price	bigdecimal	The amount the buyer paid for gift wrap. Amount is aggregate of the quantity, not unit price
gift_wrap_tax	bigdecimal	The amount the buyer paid for gift wrap tax. Amount is aggregate of the quantity, not unit price
item_promotion_discount	bigdecimal	Total of all promotion discounts applied to the order item
ship_promotion_discount	bigdecimal	Promotion discount applied to shipping
ship_city	string	The city of a standard address
ship_state	string	The state or region of a standard address
ship_postal_code	string	The postal (zip) code of a standard address
ship_country	string	ISO 3166 standard two-letter country code
promotion_ids	string	List of all item promotions applied to this order item
is_business_order	string	Is business order
purchase_order_number	string	Purchase order number
price_designation	string	Price designation

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileOrdersByLastUpdate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileOrdersByLastUpdate (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_FlatFileOrdersByOrderDate

Flat File Orders By Order Date Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
amazon_order_id	string	Amazon''s unique, displayable identifier for an order
merchant_order_id	string	A unique identifier optionally supplied for the order by the Merchant
purchase_date	timestamp	The date the order was placed
last_updated_date	timestamp	The date of the most recent order update
order_status	string	Current status of the customer order
fulfillment_channel	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
sales_channel	string	Channel through which the order was purchased
order_channel	string	The sub channel through which a sale was made for CBA/WBA orders
ship_service_level	string	An enumerated value that determines the type of fulfillment service that the buyer expects the merchant to use (e.g., standard versus expedited)
product_name	string	The short title for the product, displayed in bold on the detail web page and in the title bar of the browser window
sku	string	A merchant-defined unique identifier for a product
asin	string	Amazon inventory ID
item_status	string	Current status of this item within the order
quantity	bigdecimal	The number of this item that were purchased
currency	string	The currency used for the purchase. Supported currencies include USD, CAD, GBP, EUR, and JPY
item_price	bigdecimal	The amount the buyer paid for the item. Amount is aggregate of the quantity, not unit price
item_tax	bigdecimal	The amount the buyer paid for item tax. Amount is aggregate of the quantity, not unit price
shipping_price	bigdecimal	The amount the buyer paid for shipping. Amount is aggregate of the quantity, not unit price
shipping_tax	bigdecimal	The amount the buyer paid for shipping tax. Amount is aggregate of the quantity, not unit price
gift_wrap_price	bigdecimal	The amount the buyer paid for gift wrap. Amount is aggregate of the quantity, not unit price
gift_wrap_tax	bigdecimal	The amount the buyer paid for gift wrap tax. Amount is aggregate of the quantity, not unit price
item_promotion_discount	bigdecimal	Total of all promotion discounts applied to the order item
ship_promotion_discount	bigdecimal	Promotion discount applied to shipping
ship_city	string	The city of a standard address
ship_state	string	The state or region of a standard address
ship_postal_code	string	The postal (zip) code of a standard address
ship_country	string	ISO 3166 standard two-letter country code
promotion_ids	string	List of all item promotions applied to this order item
is_business_order	string	Is business order
purchase_order_number	string	Purchase order number
price_designation	string	Price designation

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileOrdersByOrderDate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileOrdersByOrderDate (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_FlatFileReturnAttributesbyReturnDate

Flat File Return Attributes Report by Return Date
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
SKU	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify each seller's products. SKUs are assigned by the seller
Provide_prepaid_label	string	Provide prepaid label
Provide_returnless_refund	string	Provide returnless refund

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileReturnAttributesbyReturnDate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileReturnAttributesbyReturnDate (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_FlatFileReturnsbyReturnDate

Flat File Returns Report by Return Date
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
Order_ID	string	Amazon''s unique, displayable identifier for an order
A_to_Z_Claim	boolean	Reports whether the Return was completed In Policy or not
Amazon_RMA_ID	string	The RMA Id assigned by Amazon
ASIN	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
Currency_code	string	The currency code of currency used to complete a purchase
In_policy	boolean	Reports whether the Return was completed In Policy or not
Invoice_number	string	The invoice number for the order
Is_prime	boolean	Indicates whether an A-To-Z Claim was filed by the buyer
Item_Name	string	Name of item for inventory and returns reporting
Label_cost	bigdecimal	Cost of the shipping label for the return
Label_to_be_paid_by	string	Identifies who will pay for the return label. Will report Customer if customer will pay and Seller if seller will pay
Label_type	string	The type of label that was used to ship the Return back
Merchant_RMA_ID	string	RMA ID for the seller
Merchant_SKU	string	A merchant-defined unique identifier for a product
Order_Amount	bigdecimal	Revenue of item for returns reporting
Order_date	date	Date of order for returns reporting
Order_quantity	bigdecimal	Quantity ordered for Returns reporting, but not the quantity returned. Use Return Quantity to compare this metric to actual amount returned
Refunded_Amount	bigdecimal	Amount refunded of an order
Resolution	string	The action taken to resolve the return
Return_carrier	string	The carrier that returned the item (USPS, UPS, etc.)
Return_delivery_date	string	Date returned merchandise was processed at the fulfillment center
Return_quantity	bigdecimal	Number of units of an item returned
Return_Reason	string	Readable Return Reason
Return_request_date	date	Date of order for returns reporting
Return_request_status	string	The status of the Return (Approved, etc.)
Return_type	string	The type of return. Will typically report C-Returns for a customer return
SafeT_Action_reason	string	Response from Amazon for determining the Claim Status
SafeT_claim_creation_time	string	Date that the Safe-T Claim was created
SafeT_claim_id	string	Unique ID assigned to the Safe-T claim
SafeT_claim_reimbursement_amount	bigdecimal	Safe-T Claim reimbursement amount
SafeT_claim_state	string	Status of the claim (Granted, Denied, etc.)
Tracking_ID	string	The carrier''s tracking number for the package, if available

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileReturnsbyReturnDate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileReturnsbyReturnDate (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_FlatFileSettlement

Flat File Settlement Report
Parameter
<createdSince> (optional): The earliest report creation date and time for reports to include in the response. The default is 90 days ago. Reports are retained for a maximum of 90 days
<createdUntil> (optional): The latest report creation date and time for reports to include in the response. The default is now
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<parsing_templates> (optional): Templates by currency for converting report data as triplets of currency|date template|timestamp template e.g. EUR|dd.MM.yyyy|dd.MM.yyyy HH:mm:ssZ
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
reportId	long	The identifier for the report. This identifier is unique only in combination with a seller ID
reportCreatedTime	timestamp	The date and time when the report was created
order_id	string	Amazon's unique, displayable identifier for an order. This is an alphanumeric value. Go to Manage Orders to search for an order ID that includes letters, as they are not searchable in all tools
posted_date	timestamp	The date that the item (order, adjustment, misc or other) was debited or credited to the seller's account. This is an alphanumeric value. The total number of characters is 25
settlement_id	string	Amazon's unique identifier for the settlement being reported. This is a numeric value. The minimum number of digits is 1 and the maximum number is 20
settlement_start_date	timestamp	The start date of the settlement period. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
settlement_end_date	timestamp	The end date of the settlement period. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
deposit_date	timestamp	The date that the fund transfer for the settlement period will be sent to the seller's bank account. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
total_amount	bigdecimal	The sales amount to be deposited into the seller's bank account
currency	string	Currency code for the marketplace, which is also the currency code for all prices listed in the records
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
adjustment_id	string	Transaction ID for Adjustments
direct_payment_amount	bigdecimal	Direct payment amount
direct_payment_type	string	Direct payment type
fulfillment_id	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
item_related_fee_amount	bigdecimal	The amount of a particular fee charged in relation to this item
item_related_fee_type	string	The type of fee charged in the item-related-fee-amount column
marketplace_name	string	The name of the marketplace where the order was placed. This value is a string with a maximum length of 50 characters
merchant_adjustment_item_id	string	Merchant adjustment item id
merchant_order_id	string	ID assigned by Amazon or sellers
merchant_order_item_id	string	Merchant order item id
misc_fee_amount	bigdecimal	No longer used
order_fee_amount	bigdecimal	The amount of a particular fee charged for this order. This is a numeric value, with a maximum of 18 digits to the left of the decimal point and 2 digits to the right of the decimal point
order_fee_type	string	The type of fee charged in the order-fee-amount column
order_item_code	long	Amazon's unique, displayable identifier for an item within the order. This is a numeric value. The total number of digits is 14
other_amount	bigdecimal	Additional charges or credits that do not fall under the Order or Adjustment transaction types. The transaction type for this amount will be specified in the transaction-type column
other_fee_amount	bigdecimal	The amount of miscellaneous fees charged to your seller account
other_fee_reason_description	string	Miscellaneous fees that are not related to the monthly selling plan
price_amount	bigdecimal	The amount that the buyer paid for the type of price specified in the price-type column. This is a numeric value with a maximum of 18 digits to the left of the decimal point and 2 digits to the right of the decimal point
price_type	string	The type of price specified in the price-amount column
promotion_amount	bigdecimal	The amount of promotional discount applied to the item due to the promotion specified in the promotion-id column. This is a numeric value with a maximum of 18 digits to the left of the decimal point and 2 digits to the right of the decimal point
promotion_id	string	Seller-specified promotion ID. This is an alphanumeric value. The maximum number of characters is 50
promotion_type	string	The type of promotion referred to by the values in the promotion-id and promotion-amount columns
quantity_purchased	integer	The number of these items that were purchased. This is a numeric value. The maximum number of digits is 12
shipment_fee_amount	bigdecimal	The amount of the shipping fee
shipment_fee_type	string	The type of shipping Fee as Order, Adjustment, or MiscEvent
shipment_id	string	Order transaction type ID
transaction_type	string	Text description of transaction type

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileSettlement AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileSettlement ()
	) AS x

Report_FlatFileV2Settlement

Flat File V2 Settlement Report
Parameter
<createdSince> (optional): The earliest report creation date and time for reports to include in the response. The default is 90 days ago. Reports are retained for a maximum of 90 days
<createdUntil> (optional): The latest report creation date and time for reports to include in the response. The default is now
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<parsing_templates> (optional): Templates by currency for converting report data as triplets of currency|date template|timestamp template e.g. EUR|dd.MM.yyyy|dd.MM.yyyy HH:mm:ssZ
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
reportId	long	The identifier for the report. This identifier is unique only in combination with a seller ID
reportCreatedTime	timestamp	The date and time when the report was created
order_id	string	Amazon's unique, displayable identifier for an order. This is an alphanumeric value. Go to Manage Orders to search for an order ID that includes letters, as they are not searchable in all tools
posted_date	date	The date that the item (order, adjustment, misc or other) was debited or credited to the seller's account
settlement_id	string	Amazon's unique identifier for the settlement being reported. This is a numeric value. The minimum number of digits is 1 and the maximum number is 20
settlement_start_date	timestamp	The start date of the settlement period. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
settlement_end_date	timestamp	The end date of the settlement period. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
deposit_date	timestamp	The date that the fund transfer for the settlement period will be sent to the seller's bank account. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
total_amount	bigdecimal	The sales amount to be deposited into the seller's bank account
currency	string	Currency code for the marketplace, which is also the currency code for all prices listed in the records
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
adjustment_id	string	Transaction ID for Adjustments
amount	bigdecimal	Tax amount paid by customer
amount_description	string	Amount description
amount_type	string	Amount type
fulfillment_id	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
marketplace_name	string	The name of the marketplace where the order was placed. This value is a string with a maximum length of 50 characters
merchant_adjustment_item_id	string	Merchant adjustment item id
merchant_order_id	string	ID assigned by Amazon or sellers
merchant_order_item_id	string	Merchant order item id
order_item_code	long	Amazon's unique, displayable identifier for an item within the order. This is a numeric value. The total number of digits is 14
posted_date_time	timestamp	The date that the item (order, adjustment, misc or other) was debited or credited to the seller's account
promotion_id	string	Seller-specified promotion ID. This is an alphanumeric value. The maximum number of characters is 50
quantity_purchased	integer	The number of these items that were purchased. This is a numeric value. The maximum number of digits is 12
shipment_id	string	Order transaction type ID
transaction_type	string	Text description of transaction type

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileV2Settlement AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileV2Settlement ()
	) AS x

Report_FlatFileVATInvoiceDataVIDR

VAT Invoice Data Report (VIDR)
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<pendingInvoices> (optional): Only shipments for which invoices and credit notes are pending
<allInvoices> (optional): Includes shipments of all possible invoice statuses
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace	string	The marketplace where an item is listed
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
order_id	string	Amazon''s unique, displayable identifier for an order
order_item_id	string	Amazon''s unique, displayable identifier for an item within the order
shipment_date	timestamp	Shipment date
order_date	timestamp	Date the order was placed
bill_address_1	string	The first line of a standard address
bill_address_2	string	The second line of a standard address
bill_address_3	string	The third line of a standard address
bill_city	string	The city of a standard address
bill_country	string	ISO 3166 standard two-letter country code
bill_postal_code	string	The postal (zip) code of a standard address
bill_state	string	The state or region of a standard address
billing_name	string	Billing Name
billing_phone_number	string	Billing Phone Number
buyer_company_name	string	Company name of the buyer
buyer_e_invoice_account_id	string	The e-invoice account ID of the customer
buyer_name	string	The full name of the buyer
buyer_tax_registration_type	string	Type of tax registration ID for the buyer, if it exists
buyer_vat_number	string	Buyer VAT number used in VAT calculation
citation_de	string	This column provides the citation text in German
citation_en	string	This column provides the citation text in English
citation_es	string	This column provides the citation text in Spanish
citation_fr	string	This column provides the citation text in French
citation_it	string	This column provides the citation text in Italian
currency	string	The currency used for the purchase. Supported currencies include CDN, USD, GBP, EUR, and JPY
export_outside_eu	boolean	Export out of EU
fulfilled_by	string	Who fulfilled this order
gift_promo_vat_amount	bigdecimal	Total VAT Amount Gift Wrap Promotion
gift_promo_vat_excl_amount	bigdecimal	Total VAT Exclusive Gift Wrap Promotion
gift_promo_vat_incl_amount	bigdecimal	Total VAT Inclusive Gift Wrap Promotion
gift_promo_vat_rate	bigdecimal	Total VAT Rate Gift Wrap Promotion
gift_promotion_id	string	Promotion Id of Gift Wrap Promotion
gift_wrap_vat_amount	bigdecimal	Total VAT Amount of Gift Wrap
gift_wrap_vat_excl_amount	bigdecimal	Total VAT Exclusive Gift Wrap
gift_wrap_vat_incl_amount	bigdecimal	Total VAT Inclusive Gift Wrap
gift_wrap_vat_rate	bigdecimal	Total VAT Rate of Gift Price
invoice_correction_details	string	Invoice amendment details describing changes on the invoice. This is only applicable for invoice amendment transaction
invoice_number	string	The invoice number provided by the Seller. In case of "PendingInvoices" view, the column will be blank, as the invoice is not yet uploaded. In case of "All" view, the column will contain the invoice number uploaded by the Seller
invoice_status	string	Status of the Invoice
invoice_status_description	string	Description of the Invoice status
is_amazon_invoiced	boolean	The value is True if Seller uses VCS and chooses the option to allow Amazon to create the Invoices, or if Amazon World Imports buys from the Seller
is_business_order	boolean	Was this order from Amazon Business website or B2C website
is_buyer_physically_present	boolean	Is the Customer physically established in the country of which the tax number has been provided in the buyer-vat-number column
is_invoice_corrected	boolean	The value is True if this transaction is a correction of a previous transaction
is_seller_physically_present	boolean	Is the Seller physically established in the country of which the VAT number has been provided in the seller-vat-number column
item_promo_vat_amount	bigdecimal	Total VAT Amount Item Promotion
item_promo_vat_excl_amount	bigdecimal	Total VAT Exclusive Item Promotion
item_promo_vat_incl_amount	bigdecimal	Total VAT Inclusive Item Promotion
item_promo_vat_rate	bigdecimal	Total VAT Rate Item Promotion
item_promotion_id	string	Promotion Id for Item Promotion
item_vat_amount	bigdecimal	VAT amount of Item price
item_vat_excl_amount	bigdecimal	VAT Exclusive Item Price
item_vat_incl_amount	bigdecimal	VAT Inclusive Item Price
item_vat_rate	bigdecimal	VAT rate of Item price
legacy_customer_order_item_id	string	This order item id is the same as that found in FBA reports and MFN reports. If you want to match the individual line items from VIDR to FBA or MFN reports, you can use this column
original_vat_invoice_number	string	The invoice number of the original shipment whose invoice has to be corrected
price_designation	string	Indicates the type of business price that the buyer used
product_name	string	The name of your product
purchase_order_number	string	Purchase Order number (if supplied by the Customer)
quantity_purchased	bigdecimal	Quantity purchased
recipient_name	string	Name field of a standard address
recommended_invoice_format	string	Recommended invoice format to be submitted for tax authorities. If the value is PDF, you must upload the PDF invoice format in Amazon, and use the same PDF as the true invoice copy. If the recommended format is XML, then Amazon has determined that the Customer is a B2B Customer in IT, and the Seller is physically established in IT, thus the Seller must upload an XML invoice in Sistema di Interscambio (SdI) according to the new Italian law related to E-invoicing. The xml invoice available on SdI will be considered the true copy of invoice. However, you must also upload a PDF invoice on Amazon. The PDF should contain an additional text or a watermark suggesting that "this is a duplicate invoice. The Customer can retrieve the original invoice from SdI
seller_vat_number	string	VAT number of the Seller used in VAT calculation
ship_address_1	string	The first line of a standard address
ship_address_2	string	The second line of a standard address
ship_address_3	string	The third line of a standard address
ship_city	string	The city of a standard address
ship_country	string	ISO 3166 standard two-letter country code
ship_from_city	string	City of "Ship From" address
ship_from_country	string	Country of "Ship From" address
ship_from_postal_code	string	Postal Code of "Ship From" address
ship_from_state	string	State of "Ship From" address
ship_phone_number	string	The phone number associated with the ship-to address
ship_postal_code	string	The postal (zip) code of a standard address
ship_promotion_id	string	Promotion Id
ship_service_level	string	An enumerated value that determines the type of fulfilment service that the buyer expects the merchant to use (e.g., Standard vs. Expedited)
ship_state	string	The state or region of a standard address
shipping_id	string	Shipping Id for this shipment
shipping_promo_vat_amount	bigdecimal	VAT amount of Shipping price
shipping_promo_vat_excl_amount	bigdecimal	VAT Exclusive Shipping Price
shipping_promo_vat_incl_amount	bigdecimal	VAT Inclusive Shipping Price
shipping_promo_vat_rate	bigdecimal	VAT rate of Shipping price
shipping_vat_amount	bigdecimal	VAT amount of Shipping price
shipping_vat_excl_amount	bigdecimal	VAT Exclusive Shipping Price
shipping_vat_incl_amount	bigdecimal	VAT Inclusive Shipping Price
shipping_vat_rate	bigdecimal	VAT rate of Shipping price
transaction_id	string	For shipments, this will be the shipping id. For returns, this will be a unique transaction Id (different from shipping id)
transaction_type	string	Values can be shipment, refund or return depending on the type of transaction

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_FlatFileVATInvoiceDataVIDR AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_FlatFileVATInvoiceDataVIDR (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_InactiveListings

Inactive Listings Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
item_name	string	The item name
item_description	string	The item description
listing_id	string	The listing id
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
quantity	bigdecimal	The total number of units reimbursed for this line item
open_date	string	Open date
image_url	string	The image url
item_is_marketplace	boolean	Item is marketplace
product_id_type	string	The product id type
zshop_shipping_fee	bigdecimal	Zshop shipping fee
item_note	string	The item note
item_condition	string	Numeric entry that indicates the condition of the product. This field is required. Note: Not all conditions are available for all categories. For more information about what conditions you may use in your product category, see Condition Guidelines
zshop_category1	string	Zshop category1
zshop_browse_path	string	Zshop browse path
zshop_storefront_feature	string	Zshop storefront feature
asin1	string	asin1
asin2	string	asin2
asin3	string	asin3
will_ship_internationally	string	Will ship internationally
expedited_shipping	string	Expedited shipping
zshop_boldface	string	Zshop boldface
product_id	string	Product id
bid_for_featured_placement	string	Bid for featured placement
add_delete	string	Add delete
pending_quantity	bigdecimal	Pending quantity
fulfillment_channel	string	Indicates how the order was fulfilled, via Amazon (AFN) or Merchant (MFN)
merchant_shipping_group	string	Merchant shipping group

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_InactiveListings AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_InactiveListings (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_Inventory

Inventory Report
Parameter
<Custom> (optional): A Boolean value that indicates whether a custom report is returned
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify each seller's products. SKUs are assigned by the seller
asin	string	The Amazon Standard Identification Number of the item
price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
quantity	bigdecimal	The total number of units reimbursed for this line item
Business_Price	bigdecimal	A special price that is available only for Amazon Business orders
Quantity_Price_Type	string	Quantity price type
Quantity_Lower_Bound_1	bigdecimal	Quantity lower bound
Quantity_Price_1	bigdecimal	Quantity price
Quantity_Lower_Bound_2	bigdecimal	Quantity lower bound
Quantity_Price_2	bigdecimal	Quantity price
Quantity_Lower_Bound_3	bigdecimal	Quantity lower bound
Quantity_Price_3	bigdecimal	Quantity price
Quantity_Lower_Bound_4	bigdecimal	Quantity lower bound
Quantity_Price_4	bigdecimal	Quantity price
Quantity_Lower_Bound_5	bigdecimal	Quantity lower bound
Quantity_Price_5	bigdecimal	Quantity price
Progressive_Price_Type	string	Progressive price type
Progressive_Lower_Bound_1	bigdecimal	Progressive lower bound
Progressive_Price_1	bigdecimal	Progressive price
Progressive_Lower_Bound_2	bigdecimal	Progressive lower bound
Progressive_Price_2	bigdecimal	Progressive price
Progressive_Lower_Bound_3	bigdecimal	Progressive lower bound
Progressive_Price_3	bigdecimal	Progressive price

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_Inventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_Inventory (
			Custom => false,
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_ListingQualityandSuppressedListing

Listing Quality and Suppressed Listing Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify each seller's products. SKUs are assigned by the seller
product_name	string	The title of your product
asin	string	The Amazon Standard Identification Number of the item
field_name	string	Field name
alert_type	string	Alert type
current_value	string	Current value
last_updated	string	Last updated
alert_name	string	Alert name
status	string	Current status of this item within the order
explanation	string	Explanation

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_ListingQualityandSuppressedListing AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_ListingQualityandSuppressedListing (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_MarketBasketAnalysis

Market Basket Analysis Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
asin	string	The Amazon Standard Identification Number of the item
startDate	date	The date the data for this report became available
endDate	date	The date the data for this report became available
purchasedWithAsin	string	Purchased with ASIN
purchasedWithRank	bigdecimal	Purchased with rank
combinationPct	bigdecimal	Combination pct

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_MarketBasketAnalysis AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_MarketBasketAnalysis (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x

Report_MarketplaceAsinPageViewMetrics

ASIN page view (glance view) metrics for the DE, FR, IT, ES, NL, PL, SE and BE (EU-8) marketplaces
Parameter
<productType> (required): Product type
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
startTime	timestamp	The start of a date-time range
endTime	timestamp	The end of a date-time range
marketplaceId	string	The encrypted marketplace value
asin	string	Amazon Standard Inventory Number
pageViews	integer	ASIN page view (glance view)

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_MarketplaceAsinPageViewMetrics AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_MarketplaceAsinPageViewMetrics (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ()),
			productType => 'COMPUTER_DRIVE_OR_STORAGE'
		)
	) AS x;;

Report_OpenListings

Open Listings Report
Parameter
<Custom> (optional): A Boolean value that indicates whether a custom report is returned
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
item_name	string	The item name
item_description	string	The item description
listing_id	string	The listing id
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
quantity	bigdecimal	The total number of units reimbursed for this line item
open_date	string	Open date
image_url	string	The image url
item_is_marketplace	boolean	Item is marketplace
product_id_type	string	The type of product id
zshop_shipping_fee	bigdecimal	Zshop shipping fee
item_note	string	The item note
item_condition	string	Numeric entry that indicates the condition of the product. This field is required. Note: Not all conditions are available for all categories. For more information about what conditions you may use in your product category, see Condition Guidelines
zshop_category1	string	Zshop category1
zshop_browse_path	string	Zshop browse path
zshop_storefront_feature	string	Zshop storefront feature
asin1	string	Asin1
asin2	string	Asin2
asin3	string	Asin3
will_ship_internationally	string	Will ship internationally
expedited_shipping	string	Expedited shipping
zshop_boldface	string	Zshop boldface
product_id	string	Product id
bid_for_featured_placement	string	Bid for featured placement
add_delete	string	Add delete
pending_quantity	bigdecimal	Pending quantity
fulfillment_channel	string	Fulfillment channel
Business_Price	bigdecimal	A special price that is available only for Amazon Business orders
Quantity_Price_Type	string	Quantity price type
Quantity_Lower_Bound_1	bigdecimal	Quantity lower bound
Quantity_Price_1	bigdecimal	Quantity price
Quantity_Lower_Bound_2	bigdecimal	Quantity lower bound
Quantity_Price_2	bigdecimal	Quantity price
Quantity_Lower_Bound_3	bigdecimal	Quantity lower bound
Quantity_Price_3	bigdecimal	Quantity price
Quantity_Lower_Bound_4	bigdecimal	Quantity lower bound
Quantity_Price_4	bigdecimal	Quantity price
Quantity_Lower_Bound_5	bigdecimal	Quantity lower bound
Quantity_Price_5	bigdecimal	Quantity price
merchant_shipping_group	string	Merchant shipping group
Progressive_Price_Type	string	Progressive price type
Progressive_Lower_Bound_1	bigdecimal	Progressive lower bound
Progressive_Price_1	bigdecimal	Progressive price
Progressive_Lower_Bound_2	bigdecimal	Progressive lower bound
Progressive_Price_2	bigdecimal	Progressive price
Progressive_Lower_Bound_3	bigdecimal	Progressive lower bound
Progressive_Price_3	bigdecimal	Progressive price
Minimum_order_quantity	bigdecimal	Minimum order quantity
Sell_remainder	boolean	Sell remainder

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_OpenListings AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_OpenListings (
			Custom => false,
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_OpenListingsLite

Open Listings Report Lite
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
quantity	bigdecimal	The total number of units reimbursed for this line item
price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
product_id	string
Business_Price	bigdecimal	A special price that is available only for Amazon Business orders
Quantity_Price_Type	string	Quantity price type
Quantity_Lower_Bound_1	bigdecimal	Quantity lower bound
Quantity_Price_1	bigdecimal	Quantity price
Quantity_Lower_Bound_2	bigdecimal	Quantity lower bound
Quantity_Price_2	bigdecimal	Quantity price
Quantity_Lower_Bound_3	bigdecimal	Quantity lower bound
Quantity_Price_3	bigdecimal	Quantity price
Quantity_Lower_Bound_4	bigdecimal	Quantity lower bound
Quantity_Price_4	bigdecimal	Quantity price
Quantity_Lower_Bound_5	bigdecimal	Quantity lower bound
Quantity_Price_5	bigdecimal	Quantity price
Progressive_Price_Type	string	Progressive price type
Progressive_Lower_Bound_1	bigdecimal	Progressive lower bound
Progressive_Price_1	bigdecimal	Progressive price
Progressive_Lower_Bound_2	bigdecimal	Progressive lower bound
Progressive_Price_2	bigdecimal	Progressive price
Progressive_Lower_Bound_3	bigdecimal	Progressive lower bound
Progressive_Price_3	bigdecimal	Progressive price

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_OpenListingsLite AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_OpenListingsLite (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_OpenListingsLiter

Open Listings Report Liter
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
quantity	bigdecimal	The total number of units reimbursed for this line item

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_OpenListingsLiter AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_OpenListingsLiter (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_OrdersByLastUpdate

XML Orders By Last Update Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_redownload> (optional): Number of days to redownload
<days_step> (optional): Duration in days of the step between dates
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
AmazonOrderId	string	Amazon Order ID
MerchantOrderID	string	Merchant Order ID
PurchaseDate	timestamp	Purchase Date
LastUpdatedDate	timestamp	Last Updated Date
OrderStatus	string	Order Status
SalesChannel	string	Sales Channel
FulfillmentData_FulfillmentChannel	string	Fulfillment Channe lD
FulfillmentData_ShipServiceLevel	string	Fulfillment Data: Address City
FulfillmentData_Address_Country	string	Fulfillment Data: Address Country
FulfillmentData_Address_State	string	Fulfillment Data: Address State
FulfillmentData_Address_PostalCode	string	FulfillmentData Address PostalCode
FulfillmentData_Address_City	string	Fulfillment Data: Address City
IsBusinessOrder	boolean	Is Business Order

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_OrdersByLastUpdate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_OrdersByLastUpdate (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_OrdersByOrderDate

Orders By Order Date Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The end of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_redownload> (optional): Redownload orders for number of days to load updates happened during them
<days_step> (optional): Duration in days of the step between dates
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
AmazonOrderId	string	Amazon Order ID
MerchantOrderID	string	Merchant Order ID
PurchaseDate	timestamp	Purchase Date
LastUpdatedDate	timestamp	Last Updated Date
OrderStatus	string	Order Status
SalesChannel	string	Sales Channel
FulfillmentData_FulfillmentChannel	string	Fulfillment Channe lD
FulfillmentData_ShipServiceLevel	string	Fulfillment Data: Address City
FulfillmentData_Address_Country	string	Fulfillment Data: Address Country
FulfillmentData_Address_State	string	Fulfillment Data: Address State
FulfillmentData_Address_PostalCode	string	FulfillmentData Address PostalCode
FulfillmentData_Address_City	string	Fulfillment Data: Address City
IsBusinessOrder	boolean	Is Business Order

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_OrdersByOrderDate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_OrdersByOrderDate (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_PromotionsPerformance

Promotions Performance Report
Parameter
<promotionStartDateFrom> (optional): The start of a date and time range used for selecting promotions to report on
<promotionStartDateTo> (optional): The end of a date and time range used for selecting promotions to report on
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
createdDateTime	timestamp	Created Date Time
endDateTime	timestamp	End Date Time
glanceViews	integer	Glance views refers to the number of times a PDP (Product Detail Page) is viewed
lastUpdatedDateTime	timestamp	Last Updated Date Time
marketplaceId	string	Marketplace Id
merchantId	string	merchant Id
promotionId	string	Promotion Id
promotionName	string	Promotion Name
revenue	bigdecimal	Revenue
revenueCurrencyCode	string	Revenue Currency Code
startDateTime	timestamp	Start Date Time
status	string	Status
type	string	Type
unitsSold	bigdecimal	Units Sold

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_PromotionsPerformance AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_PromotionsPerformance (
			promotionStartDateFrom => NOW(),
			promotionStartDateTo => NOW()
		)
	) AS x;;

Report_ReferralFeePreview

Referral Fee Preview Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
seller_sku	string	Stock Keeping Units (SKUs) are unique blocks of letters and/or numbers that identify your products. SKUs are assigned by you as the seller
asin	string	The Amazon Standard Identification Number of the item
item_name	string	The item name
price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
estimated_referral_fee_per_item	bigdecimal	Estimated referral fee per item

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_ReferralFeePreview AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_ReferralFeePreview (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Report_RepeatPurchase

Repeat Purchase
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportPeriod> (optional): Specifies the reporting period for the report. Values include DAY, WEEK, MONTH, QUARTER and YEAR
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
startDate	string
	endDate	string
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
orders	bigdecimal	The number of orders
repeatCustomersPctTotal	bigdecimal	Repeat customers pct total
repeatPurchaseRevenue_amount	bigdecimal	Repeat purchase revenue amount
repeatPurchaseRevenue_currencyCode	string	Repeat purchase revenue currency code
repeatPurchaseRevenuePctTotal	bigdecimal	Repeat purchase revenue pct total
uniqueCustomers	integer	Unique customers

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_RepeatPurchase AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_RepeatPurchase (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_RequestedorScheduledFlatFileOrderShipping

Requested or Scheduled Flat File Order Report (Shipping)
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
order_id	string	Amazon''s unique, displayable identifier for an order
address_type	string	Address type
already_paid	boolean	Already paid
buyer_email	string	The encrypted email address of the buyer
buyer_name	string	The full name of the buyer
buyer_phone_number	string	The phone number of the buyer
cod_collectible_amount	bigdecimal	Cod collectible amount
currency	string	The currency used for the purchase. Supported currencies include CDN, USD, GBP, EUR, and JPY
delivery_end_date	timestamp	Delivery end date
delivery_Instructions	string	Delivery Instructions
delivery_start_date	timestamp	Delivery start date
delivery_time_zone	string	Delivery time zone
earliest_delivery_date	timestamp	Earliest delivery date
earliest_ship_date	timestamp	Earliest ship date
external_order_id	string	External order id
is_business_order	boolean	Indicates if the order is from an Amazon Business customer
item_price	bigdecimal	Price set for an item, minus VAT
item_tax	bigdecimal	The amount the buyer paid for item tax. Amount is aggregate of the quantity, not unit price
latest_delivery_date	timestamp	Latest delivery date
latest_ship_date	timestamp	Latest ship date
number_of_items	bigdecimal	The number of items that are included in the product (I.E. "2-pack", "Dozen")
order_channel	string	The sub channel through which a sale was made for CBA/WBA orders
order_channel_instance	string	Order channel instance
order_item_id	string	Amazon''s unique, displayable identifier for an item within the order
payment_method	string	Payment method
payment_method_details	string	Payment Method Details
payment_method_fee	bigdecimal	Payment method fee
payments_date	timestamp	The date the buyer''s credit card was charged and order processing was completed
price_designation	string	Indicates the type of business price that the buyer used
product_name	string	The name of your product
purchase_date	timestamp	The date the order was placed
purchase_order_number	string	Purchase order number
quantity_purchased	integer	Quantity purchased
recipient_name	string	Name field of a standard address
ship_address_1	string	The first line of a standard address
ship_address_2	string	The second line of a standard address
ship_address_3	string	The third line of a standard address
ship_city	string	The city of a standard address
ship_country	string	ISO 3166 standard two-letter country code
ship_phone_number	string	The phone number associated with the ship-to address
ship_postal_code	string	The postal (zip) code of a standard address
ship_service_level	string	An enumerated value that determines the type of fulfilment service that the buyer expects the merchant to use (e.g., Standard vs. Expedited)
ship_service_name	string	Ship service name
ship_state	string	The state or region of a standard address
shipping_price	bigdecimal	The amount the buyer paid for shipping. Amount is aggregate of the quantity, not unit price
shipping_tax	bigdecimal	The amount the buyer paid for shipping tax. Amount is aggregate of the quantity, not unit price
tax_collection_model	string	Tax Collection Model
tax_collection_responsible_party	string	Tax Collection Responsible Party

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_RequestedorScheduledFlatFileOrderShipping AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_RequestedorScheduledFlatFileOrderShipping (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_RequestedorScheduledFlatFileOrderTax

Requested or Scheduled Flat File Order Report (Tax)
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
order_id	string	Amazon''s unique, displayable identifier for an order
address_type	string	Address type
already_paid	boolean	Already paid
buyer_email	string	The encrypted email address of the buyer
buyer_phone_number	string	The phone number of the buyer
cod_collectible_amount	bigdecimal	Cod collectible amount
currency	string	The currency used for the purchase. Supported currencies include CDN, USD, GBP, EUR, and JPY
delivery_end_date	timestamp	Delivery end date
delivery_Instructions	string	Delivery Instructions
delivery_start_date	timestamp	Delivery_start_date
delivery_time_zone	string	Delivery time zone
earliest_delivery_date	timestamp	Earliest delivery date
earliest_ship_date	timestamp	Earliest ship date
external_order_id	string	External order id
is_business_order	boolean	Indicates if the order is from an Amazon Business customer
item_price	bigdecimal	Price set for an item, minus VAT
item_tax	bigdecimal	The amount the buyer paid for item tax. Amount is aggregate of the quantity, not unit price
latest_delivery_date	timestamp	Latest delivery date
latest_ship_date	timestamp	Latest ship date
number_of_items	bigdecimal	The number of items that are included in the product (I.E. "2-pack", "Dozen")
order_channel	string	The sub channel through which a sale was made for CBA/WBA orders
order_channel_instance	string	Order channel instance
order_item_id	string	Amazon''s unique, displayable identifier for an item within the order
payment_method	string	Payment method
payment_method_details	string	Payment Method Details
payment_method_fee	bigdecimal	Payment method fee
payments_date	date	The date the buyer''s credit card was charged and order processing was completed
price_designation	string	Indicates the type of business price that the buyer used
product_name	string	The name of your product
purchase_date	date	The date the order was placed
purchase_order_number	string	Purchase order number
quantity_purchased	integer	Quantity purchased
ship_address_1	string	The first line of a standard address
ship_address_2	string	The second line of a standard address
ship_address_3	string	The third line of a standard address
ship_city	string	The city of a standard address
ship_country	string	ISO 3166 standard two-letter country code
ship_phone_number	string	The phone number associated with the ship-to address
ship_postal_code	string	The postal (zip) code of a standard address
ship_service_level	string	An enumerated value that determines the type of fulfilment service that the buyer expects the merchant to use (e.g., Standard vs. Expedited)
ship_service_name	string	Ship service name
ship_state	string	The state or region of a standard address
shipping_price	bigdecimal	The amount the buyer paid for shipping. Amount is aggregate of the quantity, not unit price
shipping_tax	bigdecimal	The amount the buyer paid for shipping tax. Amount is aggregate of the quantity, not unit price
tax_collection_model	string	Tax Collection Model
tax_collection_responsible_party	string	Tax Collection Responsible Party

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_RequestedorScheduledFlatFileOrderTax AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_RequestedorScheduledFlatFileOrderTax (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_RestockInventory

Restock Inventory Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
ASIN	string	The Amazon Standard Identification Number of the item
Alert	string	Alert
Available	integer	Available
Condition	string	The condition of your product
Country	string	Country in which your products are stored
Currency_code	string	Currency code
Current_month_Maximum_inventory_threshold	bigdecimal	Current month - Maximum inventory threshold
Current_month_Minimum_inventory_threshold	bigdecimal	Current month - Minimum inventory threshold
Current_month_Very_high_inventory_threshold	bigdecimal	Current month - Very high inventory threshold
Current_month_Very_low_inventory_threshol	bigdecimal	Current month - Very low inventory threshold
Customer_Order	integer	Customer Order
Days_of_Supply	string	Days of Supply
Days_of_Supply_at_Amazon_Fulfillment_Network	string	Days of Supply at Amazon Fulfillment Network
FC_Processing	integer	FC Processing
FC_transfer	integer	FC transfer
FNSKU	string	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
Fulfilled_by	string	Fulfilled by
Inbound	integer	Inbound
Inventor_level_thresholds_published_Next_Month	boolean	Next month - Very low inventory threshold
Inventory_level_thresholds_published_Current_Month	boolean	Inventory level threshold's published - Current Month
Maximum_shipment_quantity	bigdecimal	Maximum shipment quantity
Merchant_SKU	string	Merchant SKU
Next_month_Maximum_inventory_threshold	bigdecimal	Next month - Maximum inventory threshold
Next_month_Minimum_inventory_threshold	bigdecimal	Next month - Minimum inventory threshold
Next_month_Very_high_inventory_threshold	bigdecimal	Next month - Very high inventory threshold
Next_month_Very_low_inventory_threshold	bigdecimal	Inventory level threshold's published - Next Month
Price	bigdecimal	Price per item in the currency of the marketplace where you are listing the product. Do not include the currency symbol. This field is required. You must provide a price to make the product available for purchase on Amazon
Product_Name	string	Product Name
Receiving	integer	Receiving
Recommended_action	string	The action recommended for your inventory. Recommendations are based on your current customer demand and on whether it would cost you less to take an action than to do nothing
Recommended_replenishment_qty	integer	Recommended replenishment qty
Recommended_ship_date	date	Recommended ship date
Sales_last_30_days	bigdecimal	Sales last 30 days
Shipped	integer	Shipments in shipped status
Supplier	string	Supplier
Supplier_part_no_	string	Supplier part no
Total_Days_of_Supply_including_units_from_open_shipments	string	Total Days of Supply including units from open shipments
Total_Units	integer	Total Units
Unfulfillable	integer	Unfulfillable
Unit_storage_size	string	Unit storage size
Units_Sold_Last_30_Days	integer	Units Sold Last 30 Days
Utilization	bigdecimal	Utilization
Working	integer	Shipments in working status

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_RestockInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_RestockInventory (
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x;;

Report_ReturnAttributesbyReturnDate

XML Return Attributes Report by Return Date
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
Header_DocumentVersion	string	Header DocumentVersion
MessageType	string	Message Type
Message	string	For select inactive offers, additional information is displayed here - for example, quality alerts

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_ReturnAttributesbyReturnDate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_ReturnAttributesbyReturnDate (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_ReturnsbyReturnDate

XML Returns Report by Return Date
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
order_id	string	Amazon order number
a_to_z_claim	boolean	Indicates whether an A-To-Z Claim was filed by the buyer. Either N for No or Y for Yes
amazon_rma_id	string	The RMA Id assigned by Amazon
is_prime	boolean	Notes whether or not the item purchased was a Prime order or not. Will report Y for Prime and N for not Prime
label_to_be_paid_by	string	Identifies who will pay for the return label. Will report Customer if customer will pay and Seller if seller will pay
order_amount	bigdecimal	Revenue of item for returns reporting
order_date	timestamp	Amazon order date
order_quantity	bigdecimal	Quantity ordered for Returns reporting, but not the quantity returned. Use Return Quantity to compare this metric to actual amount returned
return_request_date	timestamp	Return request date
return_request_status	string	The status of the Return (Approved, etc.)
return_type	string	The type of return. Will typically report C-Returns for a customer return

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_ReturnsbyReturnDate AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_ReturnsbyReturnDate (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_SalesandTrafficBusiness

Sales and Traffic Business Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<asinGranularity> (optional): ASIN aggregation levels: PARENT, CHILD, SKU. Default: PARENT
<save_asin_info> (optional): Save nodes with "by Asin" info
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
date	date	Date
childAsin	string	Child Asin
parentAsin	string	Parent Asin
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
salesByAsin_orderedProductSales_amount	bigdecimal	Ordered Product Sales Amount
salesByAsin_orderedProductSales_currencyCode	string	Ordered Product Sales Currency Code
salesByAsin_orderedProductSalesB2B_amount	bigdecimal	Ordered Product Sales B2B Amount
salesByAsin_orderedProductSalesB2B_currencyCode	string	Ordered Product Sales B2B Currency Code
salesByAsin_totalOrderItems	integer	Total Ordered
salesByAsin_totalOrderItemsB2B	integer	Total Ordered B2B
salesByAsin_unitsOrdered	integer	Units Ordered
salesByAsin_unitsOrderedB2B	integer	Units Ordered B2B
salesByDate_averageSalesPerOrderItem_amount	bigdecimal	Average Sales Per Order Item Amount
salesByDate_averageSalesPerOrderItem_currencyCode	string	Average Sales Per Order Item Currency Code
salesByDate_averageSalesPerOrderItemB2B_amount	bigdecimal	Average Sales Per Order Item B2B Amount
salesByDate_averageSalesPerOrderItemB2B_currencyCode	string
salesByDate_averageSellingPrice_amount	bigdecimal	Average Selling Price Amount
salesByDate_averageSellingPrice_currencyCode	string	Average Selling Price Currency Code
salesByDate_averageSellingPriceB2B_amount	bigdecimal	Average Selling Price B2B Amount
salesByDate_averageSellingPriceB2B_currencyCode	string	Average Selling Price B2B Currency Code
salesByDate_averageUnitsPerOrderItem	bigdecimal	Average Units Per Order Item
salesByDate_averageUnitsPerOrderItemB2B	bigdecimal	Average Units Per Order Item B2B
salesByDate_claimsAmount_amount	bigdecimal	Claims Amount
salesByDate_claimsAmount_currencyCode	string	Claims Amount Currency Code
salesByDate_claimsGranted	integer	Claims Granted
salesByDate_orderedProductSales_amount	bigdecimal	Ordered Product Sales Amount
salesByDate_orderedProductSales_currencyCode	string	Ordered Product Sales Currency Code
salesByDate_orderedProductSalesB2B_amount	bigdecimal	Ordered Product Sales B2B Amount
salesByDate_orderedProductSalesB2B_currencyCode	string	Ordered Product Sales B2B Currency Code
salesByDate_ordersShipped	integer	Orders Shipped
salesByDate_refundRate	bigdecimal	RefundvRate
salesByDate_shippedProductSales_amount	bigdecimal	Shipped Product Sales Amount
salesByDate_shippedProductSales_currencyCode	string	Shipped Product Sales Currency Code
salesByDate_totalOrderItems	integer	Total Order Items
salesByDate_totalOrderItemsB2B	integer	Total Order Items B2B
salesByDate_unitsOrdered	integer	Units Ordered
salesByDate_unitsOrderedB2B	integer	Units Ordered B2B
salesByDate_unitsRefunded	integer	Units Refunded
salesByDate_unitsShipped	integer	Units Shipped
trafficByAsin_browserPageViews	integer	Browser Page Views
trafficByAsin_browserPageViewsPercentage	bigdecimal	Browser Page Views Percentage
trafficByAsin_browserSessionPercentage	bigdecimal	Browser Sessions Percentage
trafficByAsin_browserSessions	integer	Browser Sessions
trafficByAsin_buyBoxPercentage	bigdecimal	Buy Box Percentage
trafficByAsin_mobileAppPageViews	integer	Mobile App Page Views
trafficByAsin_mobileAppPageViewsPercentage	bigdecimal	Mobile App Page Views Percentage
trafficByAsin_mobileAppSessionPercentage	bigdecimal	Mobile App Sessions Percentage
trafficByAsin_mobileAppSessions	integer	Mobile App Sessions
trafficByAsin_pageViews	integer	Page Views
trafficByAsin_pageViewsPercentage	bigdecimal	Page Views Percentage
trafficByAsin_sessionPercentage	bigdecimal	Sessions Percentage
trafficByAsin_sessions	integer	Sessions
trafficByAsin_unitSessionPercentage	bigdecimal	Unit Session Percentage
trafficByAsin_unitSessionPercentageB2B	bigdecimal	Unit Session Percentage B2B
trafficByDate_averageOfferCount	integer	Average Offer Count
trafficByDate_averageParentItems	integer	Average Parent Items
trafficByDate_browserPageViews	integer	Browser Page Views
trafficByDate_browserSessions	integer	Browser Sessions
trafficByDate_buyBoxPercentage	bigdecimal	Buy Box Percentage
trafficByDate_feedbackReceived	integer	Feedback Received
trafficByDate_mobileAppPageViews	integer	Mobile App Page Views
trafficByDate_mobileAppSessions	integer	Mobile App Sessions
trafficByDate_negativeFeedbackReceived	integer	Negative Feedback Received
trafficByDate_orderItemSessionPercentage	bigdecimal	Order Item Session Percentage
trafficByDate_orderItemSessionPercentageB2B	bigdecimal	Order Item Session Percentage B2B
trafficByDate_pageViews	integer	Page Views
trafficByDate_receivedNegativeFeedbackRate	bigdecimal	Received Negative Feedback Rate
trafficByDate_sessions	integer	Sessions
trafficByDate_unitSessionPercentage	bigdecimal	Unit Session Percentage
trafficByDate_unitSessionPercentageB2B	bigdecimal	Unit Session Percentage B2B

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_SalesandTrafficBusiness AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_SalesandTrafficBusiness (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_SalesTax

Sales Tax Report
Parameter
<reportId> (optional): Id of the report to parse
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
Order_ID	string	Amazon order number
ASIN	string	Amazon Standard Identification Number
Buyer_Exemption_Certificate_Id	string	Buyer exemption applied
Buyer_Exemption_Code	string	Buyer exemption applied
Buyer_Exemption_Domain	string	Buyer exemption applied
Currency	string	Currency used in tax calculation
Display_Price	bigdecimal	Price shown to buyer
Display_Price_Tax_Inclusive	boolean	Indicates if the price displayed to the customer includes tax (Yes = TRUE or No = FALSE)
Display_Promo_Amount	bigdecimal	Amount deducted as part of the promo (if any)
Display_Promo_Tax_Inclusive	boolean	Whether the amount of promo shown to buyer is inclusive of tax (if any)
Financial_Component	string	Item = OUR_PRICE, Shipping = SHIPPING, Tax Refund = TAXONLYREFUND, Retrocharge = RETROCHARGE
Fulfillment	string	Order fulfillment method (MFN - seller, AFN - Amazon)
isPromoApplied	boolean	Promotion Applied
Jurisdiction_Level	string	Country, State/Province/Territory, County, City, District
Jurisdiction_Name	string	Name of Country, State/Province/Territory, County, City or District
Marketplace	string	Store buyer shopped from (http://Amazon.com , http://Amazon.ca , http://Amazon.com.mx )
Merchant_ID	string	Your seller ID
NonTaxable_Amount	bigdecimal	Amount that jurisdiction tax rate did not apply to
Order_Date	date	Date buyer submitted order
Posted_Date	date	Date order payment was finalized
postPromoTaxableBasis	bigdecimal	Taxable amount for item, after promotion amount
prePromoTaxableBasis	bigdecimal	Taxable amount for item, before promotion amount
Product_Tax_Code	string	Your product tax code used in tax calculation
Promo_Amount_Basis	bigdecimal	Promotion amount applied to order
Promo_ID_Domain	string	Source of promotion in Amazon system
Promo_Rule_Reason_Code	string	Funding source of promotion
Promo_Tax_Price_Type	string	Whether the promotion amount changes the taxable basis for the item: - ReductionInTaxableBasis: Item tax calculation is based on item price after promotion amount; - NoReductionInTaxableBasis: Item tax calculation is based on item price before promotion amount
promoAmountTax	bigdecimal	Tax associated with the promotion amount (if any)
Promotion_Identifier	string	System ID associated with the applied promotion
Quantity	integer	Enter a quantity when you add a new SKU. This is a required field for seller-fulfilled products if product-id is provided, and to make the product available for purchase on Amazon. Products must be in-stock and on-hand at the time a purchase is made. Note: For Fulfillment by Amazon (FBA) products, do not enter a quantity. Instead, provide a fulfillment-center-id in the last column of the template
Ship_From_City	string	City item was shipped from (if self-fulfilled, your default shipping address). If FBA, fulfilment centre location)
Ship_From_Country	string	Country item was shipped from (if self-fulfilled, your default shipping address). If FBA, fulfilment centre location)
Ship_From_Postal_Code	string	Postal code item was shipped from (if self-fulfilled, your default shipping address). If FBA, fulfilment centre location)
Ship_From_State	string	State/province/territory item was shipped from (if self-fulfilled, your default shipping address). If FBA, fulfilment centre location)
Ship_From_Tax_Location_Code	string	Vertex location code of ship-from address
Ship_To_City	string	City buyer had item shipped to
Ship_To_Country	string	Country buyer had item shipped to
Ship_To_Location_Code	string	Vertex location code of buyer ship-to address
Ship_To_Postal_Code	string	Postal code buyer had item shipped to
Ship_To_State	string	State/province/territory buyer had item shipped to
Shipment_Date	date	Date order shipment was confirmed
Shipment_ID	string	Amazon shipment ID
SKU	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
Tax_Address_Role	string	The address used in tax calculation (ship from or ship to)
Tax_Amount	bigdecimal	Amount of tax per jurisdiction calculated using your tax setting
Tax_Amount_Collected_By_Amazon	bigdecimal	Amount of tax per jurisdiction calculated by Amazon via Marketplace Tax Collection
Tax_Calculated_Date_UTC	string
Tax_Calculation_Reason_Code	string	By jurisdiction level, an indicator of whether the transaction is taxable, not taxable, exempt or zero-rated
Tax_Category	string	For Canada, this will be GST or PST
Tax_Collection_Model	string	Responsible party (MarketplaceFacilitator or Standard)
Tax_Collection_Responsible_Party	string	Responsible party (Amazon or seller)
Tax_Type	string	Name of tax used in calculation
Taxable_Amount	bigdecimal	Amount that jurisdiction tax rate was calculated on
Taxed_Jurisdiction_Tax_Rate	bigdecimal	Percentage of tax per jurisdiction
Taxed_Location_Code	string	Vertex location code used in tax calculation
TaxExclusive_Selling_Price	bigdecimal	Price for item, before tax
Total_Tax	bigdecimal	Total tax amount calculated on item using your tax settings
Total_Tax_Collected_By_Amazon	bigdecimal	Total tax amount calculated on item by Amazon via Marketplace Tax Collection
Transaction_Type	string	Shipment, Refund or Retrocharge

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_SalesTax AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_SalesTax (
		)
	) AS x;;

Report_ScheduledOrderShipping

Scheduled XML Order Report (Shipping)
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
AmazonOrderID	string	Amazon Order ID
AmazonSessionID	string	Amazon session Id
BillingData_AlreadyPaid	boolean	Already paid
BillingData_BuyerEmailAddress	string	Buyer''s email address
BillingData_BuyerName	string	Buyer''s name
BillingData_BuyerPhoneNumber	string	Buyer''s phone number
BillingData_PaymentMethodDetails	string	Payment method details
FulfillmentData_Address_AddressFieldOne	string	Address field one
FulfillmentData_Address_AddressType	string	Address type
FulfillmentData_Address_City	string	Address city
FulfillmentData_Address_CountryCode	string	Country code
FulfillmentData_Address_Name	string	Address name
FulfillmentData_Address_PhoneNumber	string	Phone number
FulfillmentData_Address_PostalCode	string	FulfillmentData Address PostalCode
FulfillmentData_Address_StateOrRegion	string	State or region
FulfillmentData_FulfillmentMethod	string	Fulfillment method
FulfillmentData_FulfillmentServiceLevel	string	Fulfillment service level
FulfillmentData_ShipServiceName	string	Ship service name
IsBusinessOrder	boolean	Is Business Order
OrderDate	timestamp	Order date
OrderPostedDate	timestamp	Order posted date

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_ScheduledOrderShipping AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_ScheduledOrderShipping (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_ScheduledOrderTax

Scheduled XML Order Report (Tax)
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
AmazonOrderID	string	Amazon Order ID
AmazonSessionID	string	Amazon session Id
BillingData_AlreadyPaid	boolean	Already paid
BillingData_BuyerEmailAddress	string	Buyer''s email address
BillingData_BuyerPhoneNumber	string	Buyer''s phone number
BillingData_PaymentMethodDetails	string	Payment method details
FulfillmentData_Address_AddressFieldOne	string	Address field one
FulfillmentData_Address_AddressType	string	Address type
FulfillmentData_Address_City	string	Address city
FulfillmentData_Address_CountryCode	string	Country code
FulfillmentData_Address_PhoneNumber	string	Phone number
FulfillmentData_Address_PostalCode	string	FulfillmentData Address PostalCode
FulfillmentData_Address_StateOrRegion	string	State or region
FulfillmentData_FulfillmentMethod	string	Fulfillment method
FulfillmentData_FulfillmentServiceLevel	string	Fulfillment service level
FulfillmentData_ShipServiceName	string	Ship service name
IsBusinessOrder	boolean	Is Business Order
OrderDate	timestamp	Order date
OrderPostedDate	timestamp	Order posted date

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_ScheduledOrderTax AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_ScheduledOrderTax (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Report_SellerPerformance

Seller Performance Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	Specifies the marketplace
accountStatus	string	Account status
performanceMetric	string	Performance metric
fulfillmentType	string	Fulfillment type
reportingDateFrom	timestamp	Reporting date from
reportingDateTo	timestamp	Reporting date to
status	string	Status for performance metric
targetCondition	string	Target condition
targetValue	bigdecimal	Target value
rate	bigdecimal	Rate
defectsCount	bigdecimal	Defects count
cancellationCount	bigdecimal	Cancellation count
chargebacksCount	bigdecimal	Chargebacks count
chargebacksStatus	string	Chargebacks status
claimsCount	bigdecimal	Claims count
claimsStatus	string	Claims status
invoiceDefectCount	bigdecimal	Invoice defect count
invoiceDefectStatus	string	Invoice defect status
lateInvoiceCount	bigdecimal	Late invoice count
lateInvoiceStatus	string	Late invoice status
lateShipmentCount	bigdecimal	Late shipment count
missingInvoiceCount	bigdecimal	Missing invoice count
missingInvoiceStatus	string	Missing invoice status
negativeFeedbackCount	bigdecimal	Negative feedback count
negativeFeedbackStatus	string	Negative feedback status
onTimeDeliveryCount	bigdecimal	On time delivery count
orderCount	bigdecimal	Order count
orderWithDefectsCount	bigdecimal	Order with defects count
orderWithDefectsStatus	string	Order with defects status
shipmentCount	bigdecimal	Shipment count
shipmentCountWithValidTracking	bigdecimal	shipment count with valid tracking
validTrackingCount	bigdecimal	Valid tracking count

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_SellerPerformance AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_SellerPerformance ()
	) AS x

Report_Settlement

XML Settlement Report
Parameter
<createdSince> (optional): The earliest report creation date and time for reports to include in the response. The default is 90 days ago. Reports are retained for a maximum of 90 days
<createdUntil> (optional): The latest report creation date and time for reports to include in the response. The default is now
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
reportId	long	The identifier for the report. This identifier is unique only in combination with a seller ID
reportCreatedTime	timestamp	The date and time when the report was created
PostedDate	timestamp	The date and time that the item (order, adjustment, misc or other) was debited or credited to the seller's account
RecordType	string	Record Type
ItemType	string	Item Type
AdjustmentID	string	Adjustment ID
AmazonOrderID	string	Amazon Order ID
AmazonOrderItemCode	long	OrderItem Amazon Order Item Code
Amount	bigdecimal	Tax amount paid by customer
Amount_Currency	string	Currency of Fee Amount
Amount_Type	string	Amount type
Count	integer	The total number of active offers on each product (including Amazon Retail)
CouponFee_Amount	bigdecimal	CouponFee_Amount
CouponFee_Type	string	CouponFee_Type
CouponID	string	Coupon ID
InvoiceId	string	Invoice Id
MarketplaceName	string	Marketplace Name
MerchantAdjustmentItemID	string	Merchant Adjustment Item ID
MerchantFulfillmentID	string	Merchant Fulfillment ID
MerchantOrderID	string	Merchant Order ID
MerchantPromotionID	string	Merchant Promotion ID
PaymentReason	string	Payment Reason
Quantity	integer	The number of these items that were purchased
SKU	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
ShipmentID	string	Shipment ID
SellerCouponPayment_PaymentReason	string	Seller Coupon Payment, Payment Reason
SellerCouponPayment_Count	string	Seller Coupon, Payment Count
BaseAmount	bigdecimal	Base Amount
BaseAmount_Currency	string	Base Amount Currency
TaxAmount	bigdecimal	Tax Amount
TaxAmount_Currency	string	Tax Amount Currency
TransactionAmount	bigdecimal	Transaction Amount
TransactionAmount_Currency	string	Transaction Amount Currency
TransactionID	string	Transaction ID
TransactionType	string	Transaction Type
OtherTransactionItem_Amount	string	Other Transaction Item Amount
OtherTransactionItem_Amount_Currency	string	Other Transaction Item Amount Currency
OtherTransactionItem_Quantity	string	Other Transaction Item Quantity
OtherTransactionItem_SKU	string	Other Transaction Item SKU
SettlementData_AmazonSettlementID	string	Amazon's unique identifier for the settlement being reported. This is a numeric value. The minimum number of digits is 1 and the maximum number is 20
SettlementData_StartDate	timestamp	The start date of the settlement period. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
SettlementData_EndDate	timestamp	The end date of the settlement period. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
SettlementData_DepositDate	timestamp	The date that the fund transfer for the settlement period will be sent to the seller's bank account. This is an alphanumeric value. The total number of characters is 25. (Greenwich Mean Time)
SettlementData_TotalAmount	bigdecimal	The sales amount to be deposited into the seller's bank account
SettlementData_TotalAmount_Currency	string	The currency for the transaction. All order, adjustment, fee and event data will have the same currency

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_Settlement AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_Settlement ()
	) AS x

Report_SmallLightInventory

Small & Light Inventory Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
SKU	string	Stock Keeping Units (SKUs) are unique blocks of letters or numbers that identify each seller's products. SKUs are assigned by the seller
FNSKU	string	A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center
ASIN	string	The Amazon Standard Identification Number of the item
Product_Name	string	Product Name
Enrolled_in_SnL_	boolean	Enrolled in SnL
Marketplace	string	The marketplace in which the order was placed
Your_SnL_Price	string	Your SnL Price
Inventory_in_SnL_FC_units_	bigdecimal	Inventory in SnL FC (units)
Inventory_in_Non_SnL_FC_units_	string	Inventory in Non-SnL FC (units)

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_SmallLightInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_SmallLightInventory (
			marketplaceIds => 'ATVPDKIKX0DER',
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -2, CURDATE ())
		)
	) AS x

Report_SnsForecast

Subscribe and Save Forecast Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
snapshot_date	timestamp	Report data are current as of the date in this field
week_1_start_date	timestamp	Week 1 start date
product_name	string	The title of your product
active_subscriptions	integer	Total number of active subscriptions for this SKU
asin	string	The Amazon Standard Identification Number of the item
country	string	Country in which your products are stored
estimated_avg_sns_discount_next_8_weeks	bigdecimal	Estimated average discount expected to be applied to your Subscribe & Save orders over the next 8 weeks
fnsku	string	Amazon's Fulfillment network SKU identifier
offer_state	string	Offer state
scheduled_sns_units_week_1	integer	Number of Subscribe & Save items scheduled for week 1
scheduled_sns_units_week_2	integer	Number of Subscribe & Save items scheduled for week 2
scheduled_sns_units_week_3	integer	Number of Subscribe & Save items scheduled for week 3
scheduled_sns_units_week_4	integer	Number of Subscribe & Save items scheduled for week 4
scheduled_sns_units_week_5	integer	Number of Subscribe & Save items scheduled for week 5
scheduled_sns_units_week_6	integer	Number of Subscribe & Save items scheduled for week 6
scheduled_sns_units_week_7	integer	Number of Subscribe & Save items scheduled for week 7
scheduled_sns_units_week_8	integer	Number of Subscribe & Save items scheduled for week 8

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_SnsForecast AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_SnsForecast ()
	) AS x

Report_SnsPreformance

Subscribe and Save Performance Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
snapshot_date	timestamp	Report data are current as of the date in this field
week_1_start_date	timestamp	Week 1 start date
product_name	string	The title of your product
asin	string	The Amazon Standard Identification Number of the item
country	string	Country in which your products are stored
fnsku	string	Amazon's Fulfillment network SKU identifier
offer_state	string	Offer state
oos_rate_week_1	bigdecimal	Out-of-stock rate for week 1
oos_rate_week_2	bigdecimal	Out-of-stock rate for week 2
oos_rate_week_3	bigdecimal	Out-of-stock rate for week 3
oos_rate_week_4	bigdecimal	Out-of-stock rate for week 4
sns_discount_week_1	bigdecimal	Average discount applied to your orders for week 1
sns_discount_week_2	bigdecimal	Average discount applied to your orders for week 2
sns_discount_week_3	bigdecimal	Average discount applied to your orders for week 3
sns_discount_week_4	bigdecimal	Average discount applied to your orders for week 4
sns_sale_price_week_1	bigdecimal	Average sale price for items shipped for week 1
sns_sale_price_week_2	bigdecimal	Average sale price for items shipped for week 2
sns_sale_price_week_3	bigdecimal	Average sale price for items shipped for week 3
sns_sale_price_week_4	bigdecimal	Average sale price for items shipped for week 4
sns_units_shipped_week_1	integer	Number of items shipped for week 1
sns_units_shipped_week_2	integer	Number of items shipped for week 2
sns_units_shipped_week_3	integer	Number of items shipped for week 3
sns_units_shipped_week_4	integer	Number of items shipped for week 4

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_SnsPreformance AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_SnsPreformance ()
	) AS x

Report_SuppressedListings

Suppressed Listings Report
Parameter
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
ASIN	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
Condition	string	Condition
Issue_Description	string	Issue Description
Product_name	string	Product name
Reason	string	Reason
SKU	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
Status	string	Status
Status_Change_Date	date	Status Change Date

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_SuppressedListings AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_SuppressedListings (
		)
	) AS x;;

Report_UnshippedOrders

Unshipped Orders Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
sku	string	The merchant SKU (stock keeping unit) is the unique identifier you assigned to your product
order_id	string	Amazon''s unique, displayable identifier for an order
address_type	string	Address type
already_paid	boolean	Already paid
bill_city	string	The city of a standard address
bill_country	string	ISO 3166 standard two-letter country code
bill_postal_code	string	The postal (zip) code of a standard address
bill_state	string	The state or region of a standard address
buyer_company_name	string	Company Name that made a purchase
buyer_email	string	The encrypted email address of the buyer
buyer_phone_number	string	The phone number of the buyer
buyer_requested_cancel_reason	string	Buyer Requested Cancel Reason
cod_collectible_amount	bigdecimal	Cod collectible amount
customized_page	string	Customized page
customized_url	string	Customized URL
days_past_promise	integer	Days past promise
gift_message_text	string	Gift message text
gift_wrap_type	string	Gift wrap type
ioss_number	string	IOSS number
is_business_order	boolean	Indicates if the order is from an Amazon Business customer
is_buyer_requested_cancellation	boolean	Is Buyer Requested Cancellation
is_iba	boolean	Shows whether or not the order was invoiced by Amazon
is_premium_order	boolean	Is premium order
is_prime	boolean	Is prime
is_replacement_order	boolean	Identifies if an order is for a replacement for a prior order
number_of_items	bigdecimal	The number of items that are included in the product
order_invoice_type	string	Order invoice type
order_item_id	string	Amazon''s unique, displayable identifier for an item within the order
original_order_id	string	Original Order ID
payments_date	timestamp	The date the buyer''s credit card was charged and order processing was completed
payment_method	string	Payment method
payment_method_details	string	Payment Method Details
payment_method_fee	bigdecimal	Payment method fee
price_designation	string	Indicates the type of business price that the buyer used
product_name	string	The name of your product
purchase_order_number	string	Purchase order number
promise_date	timestamp	The date of the promise
purchase_date	timestamp	The date the order was placed
quantity_purchased	bigdecimal	Quantity purchased
quantity_shipped	integer	The number of this item that were shipped
quantity_to_ship	bigdecimal	Quantity to ship
recipient_name	string	Name field of a standard address
reporting_date	timestamp	The date the data for this report became available in the FBA data store
ship_address_1	string	The first line of a standard address
ship_address_2	string	The second line of a standard address
ship_address_3	string	The third line of a standard address
ship_city	string	The city of a standard address
ship_country	string	ISO 3166 standard two-letter country code
ship_postal_code	string	The postal (zip) code of a standard address
ship_service_level	string	An enumerated value that determines the type of fulfilment service that the buyer expects the merchant to use (e.g., Standard vs. Expedited)
ship_service_name	string	Ship service name
ship_state	string	The state or region of a standard address
signature_confirmation_recommended	boolean	Signature confirmation recommended
tax_collection_model	string	Tax Collection Model
tax_collection_responsible_party	string	Tax Collection Responsible Party

Example

SQL

CREATE VIEW amazon_sp_examples.example_Report_UnshippedOrders AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Report_UnshippedOrders (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Reports

Reports that match the filters that you specify
Parameter
<createdSince> (optional): The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days
<createdUntil> (optional): The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now
<marketplaceIds> (optional): A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. Min count : 1 Max count : 10
<processingStatuses> (optional): A list of processing statuses used to filter reports. Min count : 1
<reportTypes> (optional): A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. Min count : 1 Max count : 10
<reportId> (optional): The identifier for the report. This identifier is unique only in combination with a seller ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
reportId	long	The identifier for the report. This identifier is unique only in combination with a seller ID
reportDocumentId	string	The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve and decrypt the report document's contents
reportType	string	The report type
reportScheduleId	string	The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID
createdTime	timestamp	The date and time when the report was created
dataStartTime	timestamp	The start of a date and time range used for selecting the data to report
dataEndTime	timestamp	The end of a date and time range used for selecting the data to report
marketplaceIds	string	A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. Min count : 1 Max count : 10
processingStartTime	timestamp	The date and time when the report processing started, in ISO 8601 date time format
processingEndTime	timestamp	The date and time when the report processing completed, in ISO 8601 date time format
processingStatus	string	The processing status of the report

Example

SQL

CREATE VIEW amazon_sp_examples.example_Reports AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Reports (
			reportTypes => 'FEE_DISCOUNTS_REPORT,GET_AFN_INVENTORY_DATA',
			processingStatuses => 'IN_QUEUE,IN_PROGRESS',
			marketplaceIds => NULL,
			createdUntil => NULL,
			createdSince => NULL
		)
	) AS x

ReturnReasonCodes

Return reason codes for a seller SKU in a given marketplace
Parameter
<language> (required): The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into
<marketplaceId> (optional): The marketplace for which the seller wants return reason codes
<sellerFulfillmentOrderId> (optional): The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes
<sellerSku> (required): The seller SKU for which return reason codes are required
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	The marketplace for which the seller wants return reason codes
description	string	A human readable description of the return reason code
returnReasonCode	string	A code that indicates a valid return reason
translatedDescription	string	A translation of the description. The translation is in the language specified in the Language request parameter

Example

SQL

CREATE VIEW amazon_sp_examples.example_ReturnReasonCodes AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ReturnReasonCodes (
			sellerSku => 'A3I7QN1ITY7Z3O',
			sellerFulfillmentOrderId => NULL,
			marketplaceId => 'ATVPDKIKX0DER',
			"language" => 'en'
		)
	) AS x

SelfShipAppointmentSlots

Available self-ship appointment slots used to drop off a shipment at a warehouse
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<shipmentId> (optional): Identifier of a shipment. A shipment contains the boxes and units being inbounded
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38), shipmentIds of type string(100)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
expiresAt	timestamp	The time at which the self ship appointment slot expires. In ISO 8601 datetime format
slots	string	A list of appointment slots
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_SelfShipAppointmentSlots AS 
	SELECT * 
	FROM (
		CALL amazon_sp.SelfShipAppointmentSlots (
			inboundPlanId => NULL,
			shipmentId => NULL
		)
	) AS x;;

ServiceJobs

Service job details for the specified filter query
Parameter
<createdAfter> (optional): A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error
<createdBefore> (optional): A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format
<lastUpdatedAfter> (optional): A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error
<lastUpdatedBefore> (optional): A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format
<marketplaceIds> (optional): Used to select jobs that were placed in the specified marketplaces. Max count : 1
<scheduleEndDate> (optional): A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date
<scheduleStartDate> (optional): A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date
<serviceJobStatus> (optional): A list of one or more job status by which to filter the list of jobs
<serviceOrderIds> (optional): List of service order ids for the query you want to perform.Max values supported 20. Min count : 1 Max count : 20
<sortField> (optional): Sort fields on which you want to sort the output
<sortOrder> (optional): Sort order for the query you want to perform
<serviceJobId> (optional): A service job identifier. minLength : 1 maxLength : 100
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
MarketplaceId	string	The marketplace identifier.
serviceJobId	string	The service job identifier
serviceOrderId	string	The Amazon-defined identifier for an order placed by the buyer, in 3-7-7 format
buyer_buyerId	string	The identifier of the buyer.
buyer_isPrimeMember	boolean	When true, the service is for an Amazon Prime buyer
buyer_name	string	The name of the buyer
buyer_phone	string	The phone number of the buyer
createTime	timestamp	The date and time of the creation of the job, in ISO 8601 format
preferredAppointmentTimes	string	A list of appointment windows preferred by the buyer. Included only if the buyer selected appointment windows when creating the order
scopeOfWork_asin	string	The Amazon Standard Identification Number (ASIN) of the service job
scopeOfWork_quantity	integer	The number of service jobs
scopeOfWork_requiredSkills	string	A list of skills required to perform the job
scopeOfWork_title	string	The title of the service job
seller_sellerId	string	The identifier of the seller of the service job.
serviceJobProvider_serviceJobProviderId	string	The identifier of the service job provider.
serviceJobStatus	string	The status of the service job
serviceLocation_address_addressLine1	string	The first line of the address
serviceLocation_address_addressLine2	string	Additional address information, if required
serviceLocation_address_addressLine3	string	Additional address information, if required
serviceLocation_address_city	string	The city
serviceLocation_address_CountryCode	string	The two digit country code, in ISO 3166-1 alpha-2 format
serviceLocation_address_county	string	The county
serviceLocation_address_district	string	The district
serviceLocation_address_name	string	The name of the person, business, or institution
serviceLocation_address_phone	string	The phone number
serviceLocation_address_postalCode	string	The postal code. This can contain letters, digits, spaces, and/or punctuation
serviceLocation_address_stateOrRegion	string	The state or region
serviceLocation_serviceLocationType	string	The location of the service job

Example

SQL

CREATE VIEW amazon_sp_examples.example_ServiceJobs AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ServiceJobs (
			sortOrder => NULL,
			sortField => NULL,
			serviceOrderIds => NULL,
			serviceJobStatus => NULL,
			scheduleStartDate => NULL,
			scheduleEndDate => NULL,
			marketplaceIds => 'A1PA6795UKMFR9',
			lastUpdatedBefore => NULL,
			lastUpdatedAfter => NULL,
			createdBefore => NULL,
			createdAfter => NULL
		)
	) AS x

Shipment

Shipment within an inbound plan
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<shipmentId> (optional): Identifier of a shipment. A shipment contains the boxes and units being inbounded
<inboundPlan_table> (optional): Table with inboundPlan containing columns: inboundPlanId of type string(38), shipmentIds of type string(100)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
placementOptionId	string	The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs
amazonReferenceId	string	A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment
contactInformation_email	string	The email address
contactInformation_name	string	The contact's name
contactInformation_phoneNumber	string	The phone number
dates_readyToShipWindow_editableUntil	timestamp	The timestamp at which this Window can no longer be edited
dates_readyToShipWindow_end	timestamp	The end timestamp of the window
dates_readyToShipWindow_start	timestamp	The start timestamp of the window
destination_address_addressLine1	string	Street address information
destination_address_addressLine2	string	Additional street address information
destination_address_city	string	The city
destination_address_companyName	string	The name of the business
destination_address_countryCode	string	The country code in two-character ISO 3166-1 alpha-2 format
destination_address_email	string	The email address
destination_address_name	string	The name of the individual who is the primary contact
destination_address_phoneNumber	string	The phone number
destination_address_postalCode	string	The postal code
destination_address_stateOrProvinceCode	string	The state or province code
destination_destinationType	string	The type of destination for this shipment. Possible values: AMAZON_OPTIMIZED, AMAZON_WAREHOUSE
destination_warehouseId	string	The warehouse that the shipment should be sent to. Empty if the destination type is AMAZON_OPTIMIZED
freightInformation_declaredValue_amount	bigdecimal	Decimal value of the currency
freightInformation_declaredValue_code	string	ISO 4217 standard of a currency code
freightInformation_freightClass	string	Freight class. Possible values: 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
name	string	The name of the shipment
selectedDeliveryWindow_availabilityType	string	Identifies type of Delivery Window Availability. Values: AVAILABLE, CONGESTED
selectedDeliveryWindow_deliveryWindowOptionId	string	Identifier of a delivery window option. A delivery window option represent one option for when a shipment is expected to be delivered
selectedDeliveryWindow_editableUntil	timestamp	The timestamp at which this Window can no longer be edited
selectedDeliveryWindow_endDate	timestamp	The end timestamp of the window
selectedDeliveryWindow_startDate	timestamp	The start timestamp of the window
selectedTransportationOptionId	string	Identifier of a transportation option. A transportation option represent one option for how to send a shipment
shipmentConfirmationId	string	The confirmed shipment ID which shows up on labels (for example, FBA1234ABCD )
source_address_addressLine1	string	Street address information
source_address_addressLine2	string	Additional street address information
source_address_city	string	The city
source_address_companyName	string	The name of the business
source_address_countryCode	string	The country code in two-character ISO 3166-1 alpha-2 format
source_address_email	string	The email address
source_address_name	string	The name of the individual who is the primary contact
source_address_phoneNumber	string	The phone number
source_address_postalCode	string	The postal code
source_address_stateOrProvinceCode	string	The state or province code
source_sourceType	string	The type of source for this shipment. Possible values: SELLER_FACILITY
status	string	The status of a shipment. The state of the shipment will typically start as UNCONFIRMED , then transition to WORKING after a placement option has been confirmed, and then to READY_TO_SHIP once labels are generated. Possible values: ABANDONED, CANCELLED, CHECKED_IN, CLOSED, DELETED, DELIVERED, IN_TRANSIT, MIXED, READY_TO_SHIP, RECEIVING, SHIPPED, UNCONFIRMED, WORKING
trackingDetails_ltlTrackingDetail_billOfLadingNumber	string	The number of the carrier shipment acknowledgement document
trackingDetails_ltlTrackingDetail_freightBillNumber	string	The number associated with the freight bill
trackingDetails_spdTrackingDetail_spdTrackingItems	string	List of Small Parcel Delivery (SPD) tracking items
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_Shipment AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Shipment (
			inboundPlanId => NULL,
			shipmentId => NULL
		)
	) AS x;;

ShipmentBoxes

Box packages in a shipment
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<shipmentId> (optional): Identifier of a shipment. A shipment contains the boxes and units being inbounded
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38), shipmentIds of type string(100)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
packageId	string	Primary key to uniquely identify a Package (Box or Pallet)
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
contentInformationSource	string	Indication of how box content is meant to be provided. Values : BOX_CONTENT_PROVIDED, MANUAL_PROCESS, BARCODE_2D. BOX_CONTENT_PROVIDED - Box contents have been provided by the seller MANUAL_PROCESS - Box contents will be manually processed during receive. This service incurs charges BARCODE_2D - Box contents information is provided by a barcode on the shipment. For more information, refer to Using 2D barcodes for box content information on Seller Central
destinationRegion_countryCode	string	ISO 3166 standard alpha-2 country code
destinationRegion_state	string	State
destinationRegion_warehouseId	string	An identifier for a warehouse, such as a FC, IXD, upstream storage
dimensions_height	bigdecimal	The height of a package
dimensions_length	bigdecimal	The length of a package
dimensions_unitOfMeasurement	string	Unit of linear measure. Values : IN, CM. IN - Inches CM - Centimeters
dimensions_width	bigdecimal	The width of a package
quantity	integer	The number of containers where all other properties like weight or dimensions are identical
templateName	string	Template name of the box
weight_unit	string	Unit of the weight being measured. Values : LB, KG. LB - Pounds KG - Kilograms
weight_value	bigdecimal	Value of a weight
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_ShipmentBoxes AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ShipmentBoxes (
			inboundPlanId => NULL,
			shipmentId => NULL
		)
	) AS x;;

ShipmentContentUpdatePreviews

Shipment content update previews for a given shipment
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<shipmentId> (optional): Identifier of a shipment. A shipment contains the boxes and units being inbounded
<contentUpdatePreviewId> (optional): Identifier of a content update preview
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38), shipmentIds of type string(100)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
contentUpdatePreviewId	string	Identifier of a content update preview
expiration	timestamp	The time at which this transportation option quote expires. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ss.sssZ
transportationOption_carrier_alphaCode	string	The carrier code. For example, USPS or DHLEX
transportationOption_carrier_name	string	The name of the carrier
transportationOption_carrierAppointment_endTime	timestamp	The end timestamp of the appointment in UTC
transportationOption_carrierAppointment_startTime	timestamp	The start timestamp of the appointment in UTC
transportationOption_preconditions	string	Identifies a list of preconditions for confirming the transportation option
transportationOption_quote_cost_amount	string	Decimal value of the currency
transportationOption_quote_cost_code	string	ISO 4217 standard of a currency code
transportationOption_quote_expiration	string	The time at which this transportation option quote expires. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ss.sssZ
transportationOption_quote_voidableUntil	string	Voidable until timestamp
transportationOption_shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
transportationOption_shippingMode	string	Mode of shipment transportation that this option will provide. Possible values: GROUND_SMALL_PARCEL, FREIGHT_LTL, FREIGHT_FTL_PALLET, FREIGHT_FTL_NONPALLET, OCEAN_LCL, OCEAN_FCL, AIR_SMALL_PARCEL, AIR_SMALL_PARCEL_EXPRESS
transportationOption_shippingSolution	string	Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER, USE_YOUR_OWN_CARRIER
transportationOption_transportationOptionId	string	Identifier of a transportation option. A transportation option represent one option for how to send a shipment
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_ShipmentContentUpdatePreviews AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ShipmentContentUpdatePreviews (
			inboundPlanId => NULL,
			shipmentId => NULL
		)
	) AS x;;

ShipmentItems

Items in a specified inbound shipment, or a list of items that were updated within a specified time frame
Parameter
<LastUpdatedAfter> (optional): A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller
<LastUpdatedBefore> (optional): A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller
<MarketplaceId> (optional): A marketplace identifier. Specifies the marketplace where the product would be stored
<shipmentIds> (optional): A CSV list of shipment identifiers used for selecting items in a specific inbound shipment
<shipment_table> (optional): Table with shipmentId column, that contains shipment Ids
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
ShipmentId	string	A shipment identifier originally returned by the createInboundShipmentPlan operation
FulfillmentNetworkSKU	string	Amazon's fulfillment network SKU of the item
PrepDetailsList	string	A list of preparation instructions and who is responsible for that preparation
QuantityInCase	integer	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. Also note that all of the boxes of an inbound shipment must either be case packed or individually packed. For that reason, when you submit the createInboundShipment or the updateInboundShipment operation, the value of QuantityInCase must be provided for every item in the shipment or for none of the items in the shipment
QuantityReceived	integer	The item quantity that has been received at an Amazon fulfillment center
QuantityShipped	integer	The item quantity that you are shipping
ReleaseDate	date	The date that a pre-order item will be available for sale
SellerSKU	string	The seller SKU of the item

Example

SQL

CREATE VIEW amazon_sp_examples.example_ShipmentItems AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ShipmentItems (
			LastUpdatedAfter => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

SQL

CREATE VIEW amazon_sp_examples.example_ShipmentItemsByShipmentId AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ShipmentItems (
			shipmentIds => 'FBA15DJ9SVVD'
		)
	) AS x;;

ShipmentPallets

Pallet packages in a shipment
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<shipmentId> (optional): Identifier of a shipment. A shipment contains the boxes and units being inbounded
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId(containing inboundPlanId) of type string(38), shipmentIds of type string(100)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
packageId	string	Primary key to uniquely identify a Package (Box or Pallet)
dimensions_height	bigdecimal	The height of a package
dimensions_length	bigdecimal	The length of a package
dimensions_unitOfMeasurement	string	Unit of linear measure. Values : IN, CM. IN - Inches CM - Centimeters
dimensions_width	bigdecimal	The width of a package
quantity	integer	The number of containers where all other properties like weight or dimensions are identical
stackability	string	Indicates whether pallets will be stacked when carrier arrives for pick-up. Values : STACKABLE, NON_STACKABLE. STACKABLE - A pallet that can be stacked on top of another pallet NON_STACKABLE - A pallet that cannot be stacked on top of another pallet
weight_unit	string	Unit of the weight being measured. Values : LB, KG. LB - Pounds KG - Kilograms
weight_value	bigdecimal	Value of a weight
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_ShipmentPallets AS 
	SELECT * 
	FROM (
		CALL amazon_sp.ShipmentPallets (
			inboundPlanId => NULL,
			shipmentId => NULL
		)
	) AS x;;

Shipments

Inbound shipments based on criteria that you specify
Parameter
<MarketplaceId> (optional): A marketplace identifier. Specifies the marketplace where the product would be stored
<ShipmentIdList> (optional): A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
ShipmentId	string	The shipment identifier submitted in the request
ShipmentName	string	The name for the inbound shipment
ShipmentStatus	string	Indicates the status of the inbound shipment. When used with the createInboundShipment operation, WORKING is the only valid value. When used with the updateInboundShipment operation, possible values are WORKING, SHIPPED or CANCELLED
AreCasesRequired	boolean	Indicates whether or not an inbound shipment contains case-packed boxes. When AreCasesRequired = true for an inbound shipment, all items in the inbound shipment must be case packed
BoxContentsSource	string	Where the seller provided box contents information for a shipment
ConfirmedNeedByDate	date	Date by which the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items
DestinationFulfillmentCenterId	string	An Amazon fulfillment center identifier created by Amazon
EstimatedBoxContentsFee_FeePerUnit_CurrencyCode	string	The currency code
EstimatedBoxContentsFee_FeePerUnit_Value	bigdecimal	The amount
EstimatedBoxContentsFee_TotalFee_CurrencyCode	string	The currency code
EstimatedBoxContentsFee_TotalFee_Value	bigdecimal	The amount
EstimatedBoxContentsFee_TotalUnits	integer	The number of units to ship
LabelPrepType	string	The type of label preparation that is required for the inbound shipment
ShipFromAddress_AddressLine1	string	The street address information
ShipFromAddress_AddressLine2	string	Additional street address information, if required
ShipFromAddress_City	string	The city
ShipFromAddress_CountryCode	string	The country code in two-character ISO 3166-1 alpha-2 format
ShipFromAddress_DistrictOrCounty	string	The district or county
ShipFromAddress_Name	string	Name of the individual or business
ShipFromAddress_PostalCode	string	The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan
ShipFromAddress_StateOrProvinceCode	string	The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_Shipments AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Shipments ()
	) AS x;;

SmallAndLightEligibilityBySellerSKU

Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned
Parameter
<marketplaceIds> (optional): The marketplace for which the eligibility status is retrieved. NOTE: Accepts a single marketplace only. Max count : 1
<sellerSKU> (required): The seller SKU that identifies the item
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	A marketplace identifier
sellerSKU	string	The seller SKU that identifies the item
status	string	The Small and Light eligibility status of the item

Example

SQL

CREATE VIEW amazon_sp_examples.example_SmallAndLightEligibilityBySellerSKU AS 
	SELECT * 
	FROM (
		CALL amazon_sp.SmallAndLightEligibilityBySellerSKU (
			sellerSKU => 'A3I7QN1ITY7Z3O',
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

SmallAndLightEnrollmentBySellerSKU

Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace
Parameter
<marketplaceIds> (optional): The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only. Max count : 1
<sellerSKU> (required): The seller SKU that identifies the item
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	A marketplace identifier
sellerSKU	string	The seller SKU that identifies the item
status	string	The Small and Light enrollment status of the item

Example

SQL

CREATE VIEW amazon_sp_examples.example_SmallAndLightEnrollmentBySellerSKU AS 
	SELECT * 
	FROM (
		CALL amazon_sp.SmallAndLightEnrollmentBySellerSKU (
			sellerSKU => 'A3I7QN1ITY7Z3O',
			marketplaceIds => 'ATVPDKIKX0DER'
		)
	) AS x

Subscription

Subscriptions of the specified notification type. You can use this API to get subscription information when you do not have a subscription identifier
Parameter
<notificationType> (required): The type of notification to which you want to subscribe. For more information about notification types, see the Notifications API Use Case Guide
<subscriptionId> (optional): The identifier for the subscription that you want to get
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
destinationId	string	The identifier for the destination where notifications will be delivered
payloadVersion	string	The version of the payload object to be used in the notification
subscriptionId	string	The subscription identifier generated when the subscription is created

Example

SQL

CREATE VIEW amazon_sp_examples.example_Subscription AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Subscription (
			notificationType => 'TEST_CASE_200'
		)
	) AS x

TrackingInformation

Return the tracking information of a shipment
Parameter
<trackingId> (required): trackingId
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
trackingId	string	trackingId
eventCode	string	The event code of a shipment, such as Departed, Received, and ReadyForReceive
eventTime	timestamp	The date and time of an event for a shipment
location_city	string	The city where the person, business or institution is located
location_CountryCode	string	The two digit country code. In ISO 3166-1 alpha-2 format
location_postalCode	string	The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation
location_stateOrRegion	string	The state or region where the person, business or institution is located
promisedDeliveryDate	timestamp	The promised delivery date and time of a shipment
summary_status	string	The derived status based on the events in the eventHistory

Example

SQL

CREATE VIEW amazon_sp_examples.example_TrackingInformation AS 
	SELECT * 
	FROM (
		CALL amazon_sp.TrackingInformation (
			trackingId => 'TEST_CASE_200'
		)
	) AS x

TransportationOptions

Transportation options for a shipment
Parameter
<inboundPlanId> (optional): Identifier of an inbound plan
<placementOptionId> (optional): The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified
<shipmentId> (optional): The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified
<inboundPlan_table> (optional): Table with inboundPlan containing column inboundPlanId and (placementOptionId or shipmentId) of type string(38)
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
inboundPlanId	string	Identifier of an inbound plan
shipmentId	string	Identifier of a shipment. A shipment contains the boxes and units being inbounded
transportationOptionId	string	Identifier of a transportation option. A transportation option represent one option for how to send a shipment
carrier_alphaCode	string	The carrier code. For example, USPS or DHLEX
carrier_name	string	The name of the carrier
carrierAppointment_endTime	timestamp	The end timestamp of the appointment in UTC
carrierAppointment_startTime	timestamp	The start timestamp of the appointment in UTC
preconditions	string	Identifies a list of preconditions for confirming the transportation option
quote_cost_amount	bigdecimal	Decimal value of the currency
quote_cost_code	string	ISO 4217 standard of a currency code
quote_expiration	timestamp	The time at which this transportation option quote expires. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ss.sssZ
quote_voidableUntil	timestamp	Voidable until timestamp
shippingMode	string	Mode of shipment transportation that this option will provide. Possible values: GROUND_SMALL_PARCEL, FREIGHT_LTL, FREIGHT_FTL_PALLET, FREIGHT_FTL_NONPALLET, OCEAN_LCL, OCEAN_FCL, AIR_SMALL_PARCEL, AIR_SMALL_PARCEL_EXPRESS
shippingSolution	string	Shipping program for the option. Possible values: AMAZON_PARTNERED_CARRIER, USE_YOUR_OWN_CARRIER
error_message	string	Identifier of an inbound plan

Example

SQL

CREATE VIEW amazon_sp_examples.example_TransportationOptions AS 
	SELECT * 
	FROM (
		CALL amazon_sp.TransportationOptions (
			inboundPlanId => NULL,
			placementOptionId => NULL,
			shipmentId => NULL
		)
	) AS x;

Vendor_DirectFulfillment_CustomerInvoices

customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days
Parameter
<createdAfter> (optional): Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format
<createdBefore> (optional): Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format
<shipFromPartyId> (optional): The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses
<purchaseOrderNumber> (optional): The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
purchaseOrderNumber	string	The purchase order number for this order. Pattern : "^a-zA-Z0-9+$"
content	string	The Base64encoded customer invoice

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_CustomerInvoice AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_CustomerInvoices (
			purchaseOrderNumber => 'X4QyqFZrr'
		)
	) AS x;;

Vendor_DirectFulfillment_Orders

Purchase orders created during the time frame that you specify
Parameter
<createdAfter> (optional): Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format
<createdBefore> (optional): Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format
<shipFromPartyId> (optional): The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses
<status> (optional): Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status
<purchaseOrderNumber> (optional): The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
orderDate	timestamp	The date the order was placed. This field is expected to be 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. If no time zone is specified, UTC should be assumed
purchaseOrderNumber	string	The purchase order number for this order. Formatting Notes: alpha-numeric code
customerOrderNumber	string	The customer order number
orderStatus	string	Current status of the order
billToParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
sellingParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
shipFromParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
shipmentDetails_isGift	boolean	When true, the order contain a gift. Include the gift message and gift wrap information
shipmentDetails_isPriorityShipment	boolean	When true, this is a priority shipment
shipmentDetails_isPslipRequired	boolean	When true, a packing slip is required to be sent to the customer
shipmentDetails_isScheduledDeliveryShipment	boolean	When true, this order is part of a scheduled delivery program
shipmentDetails_shipmentDates_promisedDeliveryDate	timestamp	Delivery date promised to the Amazon customer
shipmentDetails_shipmentDates_requiredShipDate	timestamp	Time by which the vendor is required to ship the order
shipmentDetails_shipMethod	string	Ship method to be used for shipping the order. Amazon defines ship method codes indicating the shipping carrier and shipment service level. To see the full list of ship methods in use, including both the code and the friendly name, search the 'Help' section on Vendor Central for 'ship methods'
shipToParty_addressLine1	string	First line of the address
shipToParty_addressLine2	string	Additional address information, if required
shipToParty_addressLine3	string	Additional address information, if required
shipToParty_city	string	The city where the person, business or institution is located
shipToParty_countryCode	string	The two digit country code. In ISO 3166-1 alpha-2 format
shipToParty_county	string	The county where person, business or institution is located
shipToParty_name	string	The name of the person, business or institution at that address
shipToParty_phone	string	The phone number of the person, business or institution located at that address
shipToParty_postalCode	string	The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation
shipToParty_stateOrRegion	string	The state or region where person, business or institution is located

Examples

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_CustomerInvoice AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_CustomerInvoices (
			purchaseOrderNumber => 'X4QyqFZrr'
		)
	) AS x;;

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_CustomerInvoices AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_CustomerInvoices (
			createdAfter => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ()),
			createdBefore => CURDATE (),
			shipFromPartyId => NULL
		)
	) AS x;;

Vendor_DirectFulfillment_Orders

Purchase orders created during the time frame that you specify
Parameter
<createdAfter> (optional): Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format
<createdBefore> (optional): Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format
<shipFromPartyId> (optional): The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses
<status> (optional): Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status
<purchaseOrderNumber> (optional): The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
orderDate	timestamp	The date the order was placed. This field is expected to be 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. If no time zone is specified, UTC should be assumed
purchaseOrderNumber	string	The purchase order number for this order. Formatting Notes: alpha-numeric code
customerOrderNumber	string	The customer order number
orderStatus	string	Current status of the order
billToParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
sellingParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
shipFromParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
shipmentDetails_isGift	boolean	When true, the order contain a gift. Include the gift message and gift wrap information
shipmentDetails_isPriorityShipment	boolean	When true, this is a priority shipment
shipmentDetails_isPslipRequired	boolean	When true, a packing slip is required to be sent to the customer
shipmentDetails_isScheduledDeliveryShipment	boolean	When true, this order is part of a scheduled delivery program
shipmentDetails_shipmentDates_promisedDeliveryDate	timestamp	Delivery date promised to the Amazon customer
shipmentDetails_shipmentDates_requiredShipDate	timestamp	Time by which the vendor is required to ship the order
shipmentDetails_shipMethod	string	Ship method to be used for shipping the order. Amazon defines ship method codes indicating the shipping carrier and shipment service level. To see the full list of ship methods in use, including both the code and the friendly name, search the 'Help' section on Vendor Central for 'ship methods'
shipToParty_addressLine1	string	First line of the address
shipToParty_addressLine2	string	Additional address information, if required
shipToParty_addressLine3	string	Additional address information, if required
shipToParty_city	string	The city where the person, business or institution is located
shipToParty_countryCode	string	The two digit country code. In ISO 3166-1 alpha-2 format
shipToParty_county	string	The county where person, business or institution is located
shipToParty_name	string	The name of the person, business or institution at that address
shipToParty_phone	string	The phone number of the person, business or institution located at that address
shipToParty_postalCode	string	The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation
shipToParty_stateOrRegion	string	The state or region where person, business or institution is located

Examples

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_Order AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_Orders (
			purchaseOrderNumber => 'XxYynQsG1'
		)
	) AS x;;

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_Orders AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_Orders (
			createdAfter => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ()),
			createdBefore => CURDATE (),
			shipFromPartyId => NULL,
			status => NULL
		)
	) AS x;;

Vendor_DirectFulfillment_PackingSlips

packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days
Parameter
<createdAfter> (optional): Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format
<createdBefore> (optional): Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format
<shipFromPartyId> (optional): The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses
<purchaseOrderNumber> (optional): The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
purchaseOrderNumber	string	Purchase order number of the shipment that the packing slip is for. Pattern : "^a-zA-Z0-9+$"
content	string	A Base64encoded string of the packing slip PDF
contentType	string	The format of the file such as PDF, JPEG etc

Examples

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_PackingSlip AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_PackingSlips (
			purchaseOrderNumber => 'X4QyqFZrr'
		)
	) AS x;;

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_PackingSlips AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_PackingSlips (
			createdAfter => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ()),
			createdBefore => CURDATE (),
			shipFromPartyId => NULL
		)
	) AS x;;

Vendor_DirectFulfillment_ShippingLabels

shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days
Parameter
<createdAfter> (optional): Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format
<createdBefore> (optional): Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format
<shipFromPartyId> (optional): The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses
<purchaseOrderNumber> (optional): The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
purchaseOrderNumber	string	This field will contain the Purchase Order Number for this order. Pattern : "^a-zA-Z0-9+$"
sellingParty_partyId	string	Assigned Identification for the party
shipFromParty_partyId	string	Assigned Identification for the party
labelFormat	string	Format of the label
content	string	This field will contain the Base64encoded string of the shipment label content
packageIdentifier	string	Identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level
shipMethod	string	Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation
shipMethodName	string	Shipping method name for internal reference
trackingNumber	string	Package tracking identifier from the shipping carrier

Examples

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_ShippingLabel AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_ShippingLabels (
			purchaseOrderNumber => 'X4QyqFZrr'
		)
	) AS x;;

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_DirectFulfillment_ShippingLabels AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_DirectFulfillment_ShippingLabels (
			createdAfter => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ()),
			createdBefore => CURDATE (),
			shipFromPartyId => NULL
		)
	) AS x;;

Vendor_PurchaseOrders

Purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order
Parameter
<changedAfter> (optional): Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format
<changedBefore> (optional): Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format
<createdAfter> (optional): Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format
<createdBefore> (optional): Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format
<orderingVendorCode> (optional): Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned
<poItemState> (optional): Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero
<purchaseOrderState> (optional): Filters purchase orders based on the purchase order state
<purchaseOrderNumber> (optional): The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
purchaseOrderNumber	string	The purchase order number for this order. Formatting Notes: 8-character alpha-numeric code
purchaseOrderState	string	This field will contain the current state of the purchase order
orderDetails_purchaseOrderDate	timestamp	The date the purchase order was placed
orderDetails_purchaseOrderChangedDate	timestamp	The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than 'purchaseOrderDate'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation
orderDetails_purchaseOrderStateChangedDate	timestamp	The date when current purchase order state was changed. Current purchase order state is available in the field 'purchaseOrderState'
orderDetails_purchaseOrderType	string	Type of purchase order
orderDetails_paymentMethod	string	Payment method used
orderDetails_buyingParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
orderDetails_sellingParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
orderDetails_shipToParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
orderDetails_billToParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
orderDetails_deliveryWindow_from	timestamp	This indicates the delivery window 'from' border
orderDetails_deliveryWindow_to	timestamp	This indicates the delivery window 'to' border
orderDetails_shipWindow_from	timestamp	This indicates the delivery window 'from' border
orderDetails_shipWindow_to	timestamp	This indicates the delivery window 'to' border
orderDetails_items_amazonProductIdentifier	string	Amazon Standard Identification Number (ASIN) of an item
orderDetails_items_isBackOrderAllowed	boolean	When true, we will accept backorder confirmations for this item
orderDetails_items_itemSequenceNumber	string	Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on
orderDetails_items_listPrice_amount	bigdecimal	A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies
orderDetails_items_listPrice_currencyCode	string	Three digit currency code in ISO 4217 format. String of length 3
orderDetails_items_netCost_amount	bigdecimal	A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies
orderDetails_items_netCost_currencyCode	string	Three digit currency code in ISO 4217 format. String of length 3
orderDetails_items_orderedQuantity_amount	integer	Acknowledged quantity. This value should not be zero
orderDetails_items_orderedQuantity_unitOfMeasure	string	Unit of measure for the acknowledged quantity
orderDetails_items_orderedQuantity_unitSize	integer	The case size, in the event that we ordered using cases
orderDetails_items_vendorProductIdentifier	string	The vendor selected product identification of the item

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_PurchaseOrders AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_PurchaseOrders (
			changedAfter => NULL,
			purchaseOrderState => NULL,
			changedBefore => NULL,
			createdAfter => TIMESTAMPADD (SQL_TSI_MONTH, -1, CURDATE ()),
			createdBefore => CURDATE (),
			orderingVendorCode => NULL,
			poItemState => NULL
		)
	) AS x;;

Vendor_PurchaseOrdersStatus

Purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number
Parameter
<createdAfter> (optional): Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format
<createdBefore> (optional): Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format
<itemConfirmationStatus> (optional): Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included
<itemReceiveStatus> (optional): Filters purchase orders based on the purchase order's item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included
<orderingVendorCode> (optional): Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned
<purchaseOrderNumber> (optional): Provides purchase order status for the specified purchase order number
<purchaseOrderStatus> (optional): Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses
<shipToPartyId> (optional): Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor group purchase orders
<updatedAfter> (optional): Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format
<updatedBefore> (optional): Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
purchaseOrderNumber	string	The buyer's purchase order number for this order. Formatting Notes: 8-character alpha-numeric code
purchaseOrderStatus	string	The status of the buyer's purchase order for this order
purchaseOrderDate	timestamp	The date the purchase order was placed
lastUpdatedDate	timestamp	The date when the purchase order was last updated
sellingParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
shipToParty_partyId	string	Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details
acknowledgementStatus_acceptedQuantity_amount	integer	Acknowledged quantity. This value should not be zero
acknowledgementStatus_acceptedQuantity_unitOfMeasure	string	Unit of measure for the acknowledged quantity
acknowledgementStatus_acceptedQuantity_unitSize	integer	The case size, in the event that we ordered using cases
acknowledgementStatus_confirmationStatus	string	Confirmation status of line item
acknowledgementStatus_rejectedQuantity_amount	integer	Acknowledged quantity. This value should not be zero
acknowledgementStatus_rejectedQuantity_unitOfMeasure	string	Unit of measure for the acknowledged quantity
acknowledgementStatus_rejectedQuantity_unitSize	integer	The case size, in the event that we ordered using cases
buyerProductIdentifier	string	Buyer's Standard Identification Number (ASIN) of an item
itemSequenceNumber	string	Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on
listPrice_amount	bigdecimal	A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies
listPrice_currencyCode	string	Three digit currency code in ISO 4217 format. String of length 3
netCost_amount	bigdecimal	A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies
netCost_currencyCode	string	Three digit currency code in ISO 4217 format. String of length 3
orderedQuantity_orderedQuantity_amount	integer	Acknowledged quantity. This value should not be zero
orderedQuantity_orderedQuantity_unitOfMeasure	string	Unit of measure for the acknowledged quantity
orderedQuantity_orderedQuantity_unitSize	integer	The case size, in the event that we ordered using cases
receivingStatus_receiveStatus	string	Receive status of the line item
receivingStatus_receivedQuantity_amount	integer	Acknowledged quantity. This value should not be zero
receivingStatus_receivedQuantity_unitOfMeasure	string	Unit of measure for the acknowledged quantity
receivingStatus_receivedQuantity_unitSize	integer	The case size, in the event that we ordered using cases
vendorProductIdentifier	string	The vendor selected product identification of the item

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_PurchaseOrdersStatus AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_PurchaseOrdersStatus (
			createdAfter => TIMESTAMPADD (SQL_TSI_MONTH, -1, CURDATE ()),
			updatedBefore => NULL,
			createdBefore => CURDATE (),
			itemConfirmationStatus => NULL,
			itemReceiveStatus => NULL,
			orderingVendorCode => NULL,
			purchaseOrderNumber => NULL,
			purchaseOrderStatus => NULL,
			shipToPartyId => NULL,
			updatedAfter => NULL
		)
	) AS x

Vendor_Report_CouponPerformance

Vendor Coupon Performance Report
Parameter
<promotionStartDateFrom> (optional): The start of a date and time range used for selecting coupon campaigns to report on
<promotionStartDateTo> (optional): The end of a date and time range used for selecting coupon campaigns to report on
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceId	string	MarketplaceId Id
creationDateTime	timestamp	Creation Date Time
campaignId	string	Campaign Id
campaignName	string	Campaign Name
vendorCode	string	Vendor Code
lastUpdatedDateTime	timestamp	Last Updated Date Time
isSubscribeAndSave	boolean	Is Subscribe And Save
budgetType	string	Budget Type
totalClips	integer	Total Clips
totalRedemptions	integer	Total Redemptions
currencyCode	string	Currency Code

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_CouponPerformance AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_CouponPerformance (
			promotionStartDateFrom => NOW(),
			promotionStartDateTo => NOW()
		)
	) AS x;;

Vendor_Report_Forecasting

Vendor Forecasting Report
Parameter
<sellingProgram> (optional): Selling program for the report. Values include RETAIL and FRESH. Default: all
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<maintain_history> (optional): Do not delete earlier data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
sellingProgram	string	Selling program for the report. Values include RETAIL and FRESH
marketplace_id	string	The encrypted marketplace value
forecastGenerationDate	date	Forecast generation date
startDate	date	Start date
endDate	date	End date
asin	string	Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. ASINs are assigned by Amazon. You can find the ASIN on the product detail page
meanForecastUnits	bigdecimal	Mean forecast units
p70ForecastUnits	bigdecimal	P70 forecast units
p80ForecastUnits	bigdecimal	P80 forecast units
p90ForecastUnits	bigdecimal	P90 forecast units

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_Forecasting AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_Forecasting (
			preview => true
		)
	) AS x;;

Vendor_Report_Inventory

Vendor Inventory Report
Parameter
<distributorView> (optional): Specifies the distributor view of the report. Values include MANUFACTURING and SOURCING. Default: both
<sellingProgram> (optional): Selling program for the report. Values include RETAIL and FRESH. Default: all
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportPeriod> (optional): Specifies the reporting period for the report. Values include DAY, WEEK, MONTH, QUARTER, and YEAR
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
distributorView	string	Specifies the distributor view of the report. Values include MANUFACTURING and SOURCING
sellingProgram	string	Selling program for the report. Values include RETAIL, BUSINESS, and FRESH
marketplaceIds	string	Marketplace ids
part	string	Part of the report
asin	string	The Amazon Standard Identification Number of the item
startDate	date	Start date of the date range
endDate	date	End date of the date range
aged90PlusDaysSellableInventoryCost_amount	bigdecimal	Amount of the aged 90+ days sellable inventory cost
aged90PlusDaysSellableInventoryCost_currencyCode	string	Currency code of the aged 90+ Days sellable inventory cost
aged90PlusDaysSellableInventoryUnits	bigdecimal	Units of the aged 90+ days sellable inventory
averageVendorLeadTimeDays	bigdecimal	Average vendor lead time days
netReceivedInventoryCost_amount	bigdecimal	Amount of the aged net received inventory cost
netReceivedInventoryCost_currencyCode	string	Currency code of the net received inventory cost
netReceivedInventoryUnits	bigdecimal	Units of the net received inventory
openPurchaseOrderUnits	bigdecimal	Open purchase order units
procurableProductOutOfStockRate	bigdecimal	Out of stock (OOS) rate on all products that are procurable
receiveFillRate	bigdecimal	Purchase order units received by Amazon in comparison to purchase order units confirmed by the vendor. The fill rate here applies only to procurable ASINs
sellableOnHandInventoryCost_amount	bigdecimal	Amount of the sellable on hand inventory cost
sellableOnHandInventoryCost_currencyCode	string	Currency code of the sellable on hand inventory cost
sellableOnHandInventoryUnits	bigdecimal	Units of the sellable on hand inventory
sellThroughRate	bigdecimal	Sell through rate
uft	string
unfilledCustomerOrderedUnits	bigdecimal	Unfilled customer ordered units
unhealthyInventoryCost_amount	bigdecimal	Amount of the unhealthy inventory cost
unhealthyInventoryCost_currencyCode	string	Currency code of the unhealthy inventory cost
unhealthyInventoryUnits	bigdecimal	Units of the unhealthy inventory
unsellableOnHandInventoryCost_amount	bigdecimal	Amount of the unsellable on hand inventory cost
unsellableOnHandInventoryCost_currencyCode	string	Currency code of the unsellable on hand inventory cost
unsellableOnHandInventoryUnits	bigdecimal	Units of the unsellable on hand inventory
vendorConfirmationRate	bigdecimal	How many units vendors confirm out of the units Amazon asks for, accounting for procurable ASINs only

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_Inventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_Inventory (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -15, CURDATE ()),
			distributorView => NULL
		)
	) AS x;;

Vendor_Report_NetPureProductMargin

Net Pure Product Margin Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
asin	string	The Amazon Standard Identification Number of the item
startDate	date	The date the data for this report became available
endDate	date	The date the data for this report became available
type	string
netPureProductMargin	bigdecimal	The Net PPM allows you to know the level of profitability of Amazon on your products. If the Net PPM decreases, it means that Amazon is losing profitability on the product and may stop selling it

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_NetPureProductMargin AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_NetPureProductMargin (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x

Vendor_Report_RapidRetailAnalyticsInventory

Rapid Retail Analytics Inventory Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
asin	string	Amazon Standard Inventory Number
startTime	timestamp	The start of a date-time range representing the beginning of the hour for this object
endTime	timestamp	The end of a date-time range representing the end of the hour for this object
highlyAvailableInventory	integer	The number of units available to be sold on the website, based on units in Amazon fulfillment centers that are in sellable condition less units in customer shopping carts or otherwise bound for other orders (e.g. known subscribe-and-save orders)

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_RapidRetailAnalyticsInventory AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_RapidRetailAnalyticsInventory (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Vendor_Report_RapidRetailAnalyticsSales

Rapid Retail Analytics Sales Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
asin	string	Amazon Standard Inventory Number
startTime	timestamp	The start of a date-time range representing the beginning of the hour for this object
endTime	timestamp	The end of a date-time range representing the end of the hour for this object
orderedRevenue	bigdecimal	Ordered Product Sales in the specified hour as of the time the report is generated. Adjustments are made for cancellation
orderedUnits	integer	Number of units ordered by Amazon customers. This number can be negative if there are more cancellations than orders

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_RapidRetailAnalyticsSales AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_RapidRetailAnalyticsSales (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Vendor_Report_RapidRetailAnalyticsTraffic

Rapid Retail Analytics Traffic Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplace_id	string	The encrypted marketplace value
asin	string	Amazon Standard Inventory Number
startTime	timestamp	The start of a date-time range representing the beginning of the hour for this object
endTime	timestamp	The end of a date-time range representing the end of the hour for this object
glanceViews	integer	The number of customer views of the product detail page for this ASIN

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_RapidRetailAnalyticsTraffic AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_RapidRetailAnalyticsTraffic (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;

Vendor_Report_Sales

Vendor Sales Report
Parameter
<distributorView> (optional): Specifies the distributor view of the report. Values include MANUFACTURING and SOURCING. Default: both
<sellingProgram> (optional): Selling program for the report. Values include RETAIL, BUSINESS, and FRESH. Default: all
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportPeriod> (optional): Specifies the reporting period for the report. Values include DAY, WEEK, MONTH, QUARTER and YEAR
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
distributorView	string	Specifies the distributor view of the report. Values include MANUFACTURING and SOURCING
sellingProgram	string	Selling program for the report. Values include RETAIL, BUSINESS, and FRESH
marketplaceIds	string	Marketplace ids
part	string	Part of the report
asin	string	The Amazon Standard Identification Number of the item
startDate	date	Start date of the date range
endDate	date	End date of the date range
customerReturns	bigdecimal	Goods returned by customers are the number of units returned by customers
orderedRevenue_amount	bigdecimal	Ordered Revenue is the number of units ordered multiplied by the average retail price of each unit. It's how much revenue you can expect based on orders that have been actually placed, but these units have not necessarily shipped
orderedRevenue_currencyCode	string	Currency code of the Ordered Revenue
orderedUnits	bigdecimal	Ordered Units
shippedCogs_amount	bigdecimal	Shipped COGS (cost of goods sold) is shipped units multiplied by the average wholesale price of units. Shipped COGS tends to be the number most brands care about the most because it relates the most to their sales
shippedCogs_currencyCode	string	Currency code of the Shipped COGS
shippedRevenue_amount	bigdecimal	Shipped Revenue is also important, but is not as important to vendors as shipped COGS because it is a measure of revenue going to Amazon - not the vendor. Shipped COGS specifically refers to the revenue that goes to the vendor
shippedRevenue_currencyCode	string	Currency code of the Shipped Revenue
shippedUnits	bigdecimal	Number of product units shipped to Amazon customers

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_Sales AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_Sales (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ()),
			distributorView => NULL
		)
	) AS x;;

Vendor_Report_Traffic

Vendor Traffic Report
Parameter
<startDate> (optional): The start of a date range used for selecting the data to report
<endDate> (optional): The END of a date range used for selecting the data to report
<marketplaceIds> (optional): A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify
<reportPeriod> (optional): Specifies the reporting period for the report. Values include DAY, WEEK, MONTH, QUARTER and YEAR
<reportId> (optional): Id of the report to parse
<days_step> (optional): Number of days to query in a single batch
<days_redownload> (optional): Number of days to redownload
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
marketplaceIds	string	Marketplace ids
part	string	Part of the report
asin	string	The Amazon Standard Identification Number of the item
startDate	date	Start date of the date range
endDate	date	End date of the date range
glanceViews	bigdecimal	A glance view if the number of times someone viewed your Product Detail Page

Example

SQL

CREATE VIEW amazon_sp_examples.example_Vendor_Report_Traffic AS 
	SELECT * 
	FROM (
		CALL amazon_sp.Vendor_Report_Traffic (
			startDate => TIMESTAMPADD (SQL_TSI_DAY, -5, CURDATE ())
		)
	) AS x;;