This is an API Binding in .Net C# for the new Amazon Selling Partner API.
This library is based on the output of swagger-codegen with the OpenAPI files provided by Amazon (Models) and has been modified by the contributors.
The purpose of this package is to have an easy way of getting started with the Amazon Selling Partner API using C#, you can watch this 📷 Youtube 📣 video for easy start your project
- AWSSDK.SecurityToken
- AWSSDK.SQS
- Microsoft.CSharp
- Newtonsoft.Json
- RestSharp
- System.ComponentModel.Annotations
- System.Reflection
Install-Package CSharpAmazonSpAPI
- OrdersV0
- Reports
- FinancesV0
- Feeds Use Case Guide feedType
- ListingsItems Use Case Guide
- Restrictions Use Case Guide
- ProductTypes Use Case Guide
- Uploads Use Case Guide
- shipmentInvoicingV0
- Shippings
- CatalogItemsV0
- CatalogItemsV20220401
- FBAInventory
- FBASmallAndLight
- FBAInboundEligibility
- FulFillmentInbound
- FulFillmentOutbound
- MerchantFulFillment
- Messaging
- Notifications Use Case Guide
- ProductFeesV0
- ProductPricingV0
- Sales
- Sellers
- Services
- Solicitations
- Token Use Case Guide
- Authorization
- VendorDirectFulfillmentInventoryV1
- VendorDirectFulfillmentOrdersV1
- VendorDirectFulfillmentPaymentsV1
- VendorDirectFulfillmentShippingV1
- VendorDirectFulfillmentTransactionsV1
- VendorOrders
- vendorInvoices
- VendorShipments
- VendorTransactionStatus
To get all keys needed you need to follow this step Creating and configuring IAM policies and entities and then you need to Registering your Application then Authorizing Selling Partner API applications
⚠️ Use role ARN created in step 5 when you register your application: and dont use IAM user
Name | Description |
---|---|
AccessKey | AWS USER ACCESS KEY |
SecretKey | AWS USER SECRET KEY |
RoleArn | AWS IAM Role ARN (needs permission to “Assume Role” STS) |
Region | Marketplace region List of Marketplaces |
ClientId | Your amazon app id |
ClientSecret | Your amazon app secret |
RefreshToken | Check how to get RefreshToken |
For more information about keys please check New Amazon doc for create keys Developer , If you are not registered as developer please Register to be able to create application.
AmazonConnection amazonConnection = new AmazonConnection(new AmazonCredential()
{
AccessKey = "AKIAXXXXXXXXXXXXXXX",
SecretKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
RoleArn = "arn:aws:iam::XXXXXXXXXXXXX:role/XXXXXXXXXXXX",
ClientId = "amzn1.application-XXX-client.XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
ClientSecret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
RefreshToken= "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
MarketPlace = MarketPlace.UnitedArabEmirates, //MarketPlace.GetMarketPlaceByID("A2VIGQ35RCS4UG")
});
Order List, For more orders sample please check Here.
ParameterOrderList serachOrderList = new ParameterOrderList();
serachOrderList.CreatedAfter = DateTime.UtcNow.AddMinutes(-600000);
serachOrderList.OrderStatuses = new List<OrderStatuses>();
serachOrderList.OrderStatuses.Add(OrderStatuses.Canceled);
var orders = amazonConnection.Orders.GetOrders(serachOrderList);
ParameterOrderList serachOrderList = new ParameterOrderList();
serachOrderList.CreatedAfter = DateTime.UtcNow.AddHours(-24);
serachOrderList.OrderStatuses = new List<OrderStatuses>();
serachOrderList.OrderStatuses.Add(OrderStatuses.Unshipped);
serachOrderList.MarketplaceIds = new List<string> { MarketPlace.UnitedArabEmirates.ID };
var orders = amazonConnection.Orders.GetOrders(serachOrderList);
var parameterOrderList = new ParameterOrderList
{
CreatedAfter = DateTime.UtcNow.AddHours(-24),
OrderStatuses = new List<OrderStatuses> { OrderStatuses.Unshipped },
MarketplaceIds = new List<string> { MarketPlace.UnitedArabEmirates.ID },
IsNeedRestrictedDataToken = true,
RestrictedDataTokenRequest = new CreateRestrictedDataTokenRequest
{
restrictedResources = new List<RestrictedResource>
{
new RestrictedResource
{
method = Method.GET.ToString(),
path = ApiUrls.OrdersApiUrls.Orders,
dataElements = new List<string> { "buyerInfo", "shippingAddress" }
}
}
}
};
var orders = _amazonConnection.Orders.GetOrders(parameterOrderList);
AmazonConnection amazonConnection = new AmazonConnection(new AmazonCredential()
{
AccessKey = "AKIAXXXXXXXXXXXXXXX",
SecretKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
RoleArn = "arn:aws:iam::XXXXXXXXXXXXX:role/XXXXXXXXXXXX",
ClientId = "amzn1.application-XXX-client.XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
ClientSecret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
RefreshToken= "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
Environment=Environments.Sandbox
});
var orders = amazonConnection.Orders.GetOrders
(
new FikaAmazonAPI.Parameter.Order.ParameterOrderList
{
TestCase = Constants.TestCase200
}
);
Report List, For more report sample please check Here.
var parameters = new ParameterReportList();
parameters.pageSize = 100;
parameters.reportTypes = new List<ReportTypes>();
parameters.reportTypes.Add(ReportTypes.GET_AFN_INVENTORY_DATA);
parameters.marketplaceIds = new List<string>();
parameters.marketplaceIds.Add(MarketPlace.UnitedArabEmirates.ID);
var reports=amazonConnection.Reports.GetReports(parameters);
var parameters = new ParameterCreateReportSpecification();
parameters.reportType = ReportTypes.GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_GENERAL;
parameters.dataStartTime = DateTime.UtcNow.AddDays(-30);
parameters.dataEndTime = DateTime.UtcNow.AddDays(-10);
parameters.marketplaceIds = new MarketplaceIds();
parameters.marketplaceIds.Add(MarketPlace.UnitedArabEmirates.ID);
parameters.reportOptions = new AmazonSpApiSDK.Models.Reports.ReportOptions();
var report= amazonConnection.Reports.CreateReport(parameters);
//use this method automatically know if the report are RDT or not
var data2 = amazonConnection.Reports.CreateReportAndDownloadFile(ReportTypes.GET_EASYSHIP_DOCUMENTS, startDate, null, null);
// OR USE this method to get the document and pass parameter isRestrictedReport = true in case the report will return PII data
var data = amazonConnection.Reports.GetReportDocument("50039018869997",true);
Easy way to get the report you need and convert the file return from amazon to class or list, this feature only ready for some reports as its will take much times to finish for All report type ....
ReportManager reportManager = new ReportManager(amazonConnection);
var products = reportManager.GetProducts(); //GET_MERCHANT_LISTINGS_ALL_DATA
var inventoryAging = reportManager.GetInventoryAging(); //GET_FBA_INVENTORY_AGED_DATA
var ordersByDate = reportManager.GetOrdersByOrderDate(90); //GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL
var ordersByLastUpdate = reportManager.GetOrdersByLastUpdate(90); //GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_GENERAL
var settlementOrder = reportManager.GetSettlementOrder(90); //GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE_V2
var returnMFNOrder = reportManager.GetReturnMFNOrder(90); //GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE
var returnFBAOrder = reportManager.GetReturnFBAOrder(90); //GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA
var reimbursementsOrder = reportManager.GetReimbursementsOrder(180); //GET_FBA_REIMBURSEMENTS_DATA
var feedbacks = reportManager.GetFeedbackFromDays(180); //GET_SELLER_FEEDBACK_DATA
var parameters = new ParameterCreateReportSpecification();
parameters.reportType = ReportTypes.GET_MERCHANT_LISTINGS_ALL_DATA;
parameters.marketplaceIds = new MarketplaceIds();
parameters.marketplaceIds.Add(MarketPlace.UnitedArabEmirates.ID);
parameters.reportOptions = new FikaAmazonAPI.AmazonSpApiSDK.Models.Reports.ReportOptions();
var reportId = amazonConnection.Reports.CreateReport(parameters);
var filePath = string.Empty;
string ReportDocumentId = string.Empty;
while (string.IsNullOrEmpty(ReportDocumentId))
{
Thread.Sleep(1000 * 60);
var reportData = amazonConnection.Reports.GetReport(reportId);
if (!string.IsNullOrEmpty(reportData.ReportDocumentId))
{
filePath = amazonConnection.Reports.GetReportFile(reportData.ReportDocumentId);
break;
}
}
//filePath for report
var data = await amazonConnection.CatalogItem.GetCatalogItem202204Async(
new Parameter.CatalogItems.ParameterGetCatalogItem
{
ASIN = "B00JK2YANC",
includedData = new[] { IncludedData.attributes,
IncludedData.salesRanks,
IncludedData.summaries,
IncludedData.productTypes,
IncludedData.relationships,
IncludedData.dimensions,
IncludedData.identifiers,
IncludedData.images }
});
var data = await amazonConnection.CatalogItem.SearchCatalogItems202204Async(
new Parameter.CatalogItems.ParameterSearchCatalogItems202204
{
keywords = new[] { "vitamin c" },
includedData = new[] { IncludedData.attributes,
IncludedData.salesRanks,
IncludedData.summaries,
IncludedData.productTypes,
IncludedData.relationships,
IncludedData.dimensions,
IncludedData.identifiers,
IncludedData.images }
});
Product Pricing, For more Pricing sample please check Here.
var data = amazonConnection.ProductPricing.GetPricing(
new Parameter.ProductPricing.ParameterGetPricing()
{
MarketplaceId = MarketPlace.UnitedArabEmirates.ID,
Asins = new string[] { "B00CZC5F0G" }
});
var data = amazonConnection.ProductPricing.GetCompetitivePricing(
new Parameter.ProductPricing.ParameterGetCompetitivePricing()
{
MarketplaceId = MarketPlace.UnitedArabEmirates.ID,
Asins = new string[] { "B00CZC5F0G" },
});
Notifications Create Destination, For more Notifications sample please check Here.
//EventBridge
var data = amazonConnection.Notification.CreateDestination(
new Notifications.CreateDestinationRequest()
{
Name = "CompanyName",
ResourceSpecification = new Notifications.DestinationResourceSpecification()
{
EventBridge = new Notifications.EventBridgeResourceSpecification("us-east-2", "999999999")
}
});
//SQS
var dataSqs = amazonConnection.Notification.CreateDestination(
new Notifications.CreateDestinationRequest()
{
Name = "CompanyName_AE",
ResourceSpecification = new Notifications.DestinationResourceSpecification
{
Sqs = new Notifications.SqsResource("arn:aws:sqs:us-east-2:9999999999999:NAME")
}
});
var SQS_URL = "https://sqs.us-east-2.amazonaws.com/9999999999999/IUSER_SQS";
ParameterMessageReceiver param = new ParameterMessageReceiver(
Environment.GetEnvironmentVariable("AccessKey"),
Environment.GetEnvironmentVariable("SecretKey"),
SQS_URL, Amazon.RegionEndpoint.USEast2);
CustomMessageReceiver messageReceiver = new CustomMessageReceiver();
amazonConnection.Notification.StartReceivingNotificationMessages(param, messageReceiver);
public class CustomMessageReceiver : IMessageReceiver
{
public void ErrorCatch(Exception ex)
{
//Your code here
}
public void NewMessageRevicedTriger(NotificationMessageResponce message)
{
//Your Code here
}
}
Here full sample for submit feed to change price and generate XML and get final report for result same as in doc. Notes: not all feed type finished as it's big work and effort but all classes are partial for easy change and you can generate XML outside and use our library to get data, now we support only submit existing product, change quantity and change price , I list most of XSD here Source\FikaAmazonAPI\ConstructFeed\xsd its will help you easy generate class and add it in your app to generate final feed xml.
ConstructFeedService createDocument = new ConstructFeedService("{SellerID}", "1.02");
var list = new List<PriceMessage>();
list.Add(new PriceMessage()
{
SKU = "8201031206122...",
StandardPrice = new StandardPrice()
{
currency = BaseCurrencyCode.AED.ToString(),
Value = (201.0522M).ToString("0.00")
}
});
createDocument.AddPriceMessage(list);
var xml = createDocument.GetXML();
var feedID = amazonConnection.Feed.SubmitFeed(xml, FeedType.POST_PRODUCT_PRICING_DATA);
Thread.Sleep(1000*30);
var feedOutput=amazonConnection.Feed.GetFeed(feedID);
var outPut=amazonConnection.Feed.GetFeedDocument(feedOutput.ResultFeedDocumentId);
var reportOutpit = outPut.Url;
var processingReport = amazonConnection.Feed.GetFeedDocumentProcessingReport(outPut.Url);
ConstructFeedService createDocument = new ConstructFeedService("{SellerID}", "1.02");
var list = new List<InventoryMessage>();
list.Add(new InventoryMessage()
{
SKU = "82010312061.22...",
Quantity = 2,
FulfillmentLatency = "11",
});
createDocument.AddInventoryMessage(list);
var xml = createDocument.GetXML();
var feedID = amazonConnection.Feed.SubmitFeed(xml, FeedType.POST_INVENTORY_AVAILABILITY_DATA);
Thread.Sleep(1000*30);
var feedOutput=amazonConnection.Feed.GetFeed(feedID);
var outPut=amazonConnection.Feed.GetFeedDocument(feedOutput.ResultFeedDocumentId);
var reportOutpit = outPut.Url;
var processingReport = amazonConnection.Feed.GetFeedDocumentProcessingReport(outPut.Url);
public void SubmitFeedProductImage()
{
ConstructFeedService createDocument = new ConstructFeedService("A3J37AJU4O9RHK", "1.02");
var list = new List<ProductImageMessage>();
list.Add(new ProductImageMessage()
{
SKU = "8201031206122...",
ImageLocation = "http://xxxx.com/1.jpeg",
ImageType = ImageType.Main
}) ;
createDocument.AddProductImageMessage(list);
var xml = createDocument.GetXML();
var feedID = amazonConnection.Feed.SubmitFeed(xml, FeedType.POST_PRODUCT_IMAGE_DATA);
}
Please read this doc to get all information about this limitation https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/usage-plans-rate-limits/Usage-Plans-and-Rate-Limits.md
we calc waiting time by read x-amzn-RateLimit-Limit header
int sleepTime = (int)((1 / header["x-amzn-RateLimit-Limit"] ) * 1000);
You can also disable libary from handelling limitaion by set IsActiveLimitRate=false in AmazonCredential
var amazonConnection = new AmazonConnection(new AmazonCredential()
{
.
.
IsActiveLimitRate=false
});
var result = amazonConnection.Restrictions.GetListingsRestrictions(
new Parameter.Restrictions.ParameterGetListingsRestrictions
{
asin = "AAAAAAAAAA",
sellerId = "AXXXXXXXXXXXX"
});
ShipmentRequestDetails shipmentRequestDetails = new ShipmentRequestDetails()
{
AmazonOrderId = "999-9999-999999",
ItemList = new ItemList()
{
new FikaAmazonAPI.AmazonSpApiSDK.Models.MerchantFulfillment.Item()
{
OrderItemId = "52986411826454",
Quantity = 1
}
},
ShipFromAddress = new Address()
{
AddressLine1 = "300 St",
City = "City",
PostalCode = "48123",
Email = "[mail@yahoo.com](mailto:mail@yahoo.com)",
Phone = "999999999",
StateOrProvinceCode = "MI",
CountryCode = "US",
Name = "FirstName LastName"
},
PackageDimensions = new PackageDimensions()
{
Height = 10,
Width = 10,
Length = 10,
Unit = UnitOfLength.Inches
},
Weight = new Weight()
{
Value = 10,
Unit = UnitOfWeight.Oz
},
ShippingServiceOptions = new ShippingServiceOptions()
{
DeliveryExperience = DeliveryExperienceType.NoTracking,
CarrierWillPickUp = false,
CarrierWillPickUpOption = CarrierWillPickUpOption.ShipperWillDropOff
}
};
var shipmentRequest = new CreateShipmentRequest(
shipmentRequestDetails,
shippingServiceId: "UPS_PTP_2ND_DAY_AIR",
shippingServiceOfferId: "WHgxtyn6qjGGaC");
var shipmentResponse = amazonConnection.MerchantFulfillment.CreateShipment(shipmentRequest);
var list = amazonConnection.ProductType.SearchDefinitionsProductTypes(
new Parameter.ProductTypes.SearchDefinitionsProductTypesParameter()
{
keywords = new List<string> { String.Empty },
});
var def = amazonConnection.ProductType.GetDefinitionsProductType(
new Parameter.ProductTypes.GetDefinitionsProductTypeParameter()
{
productType = "PRODUCT",
requirements = RequirementsEnum.LISTING,
locale = AmazonSpApiSDK.Models.ProductTypes.LocaleEnum.en_US
});
If you have questions, please ask in GitHub discussions
- Improve documentation
- Fork it (https://github.com/abuzuhri/Amazon-SP-API-CSharp/fork)
- Clone it (
git clone https://github.com/{YOUR_USERNAME}/Amazon-SP-API-CSharp
) - Create your feature branch (
git checkout -b your_branch_name
) - Commit your changes (
git commit -m 'Description of a commit'
) - Push to the branch (
git push origin your_branch_name
) - Create a new Pull Request
If you are looking for a complete Feedback solution, you might want to consider giving Soon.se a shot.
We offer consultation on everything SP-API related. Book your meeting here:
Thanks go out to everybody who worked on this package.