Retrieve Sales Performance Reports with Amazon Selling Partner API on New Model Added from Summit API

Pipedream makes it easy to connect APIs for Amazon Selling Partner, Summit and 2,700+ other apps remarkably fast.

Trigger workflow on

New Model Added from the Summit API

Next, do this

Retrieve Sales Performance Reports with the Amazon Selling Partner API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Summit trigger and Amazon Selling Partner action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Model Added trigger
1. Connect your Summit account
2. Configure timer
Configure the Retrieve Sales Performance Reports action
1. Connect your Amazon Selling Partner account
2. Select a Marketplace ID
3. Configure Interval
4. Select a Granularity
5. Optional- Configure Granularity Time Zone
6. Optional- Select a Buyer Type
7. Optional- Configure Fulfillment Network
8. Optional- Select a First Day of Week
9. Optional- Configure ASIN
10. Optional- Configure SKU
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Model Added on Summit

Description:Emit new event when a new model is added to your organization in Summit. [See the documentation](https://summit.readme.io/reference/apps)

Version:0.0.1

Key:summit-new-model-added

View on GitHub

Trigger Code#

import summit from "../../summit.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "summit-new-model-added",
  name: "New Model Added",
  description: "Emit new event when a new model is added to your organization in Summit. [See the documentation](https://summit.readme.io/reference/apps)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    summit,
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    generateMeta(model) {
      return {
        id: model.id,
        summary: `New Modle ${model.name}`,
        ts: Date.now(),
      };
    },
    async processEvent(max) {
      const results = this.summit.paginate({
        resourceFn: this.summit.listModels,
        resourceType: "apps",
        max,
      });
      for await (const model of results) {
        const meta = this.generateMeta(model);
        this.$emit(model, meta);
      }
    },
  },
  async run() {
    await this.processEvent();
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Summit	`summit`	`app`	This component uses the Summit app.
	`timer`	`$.interface.timer`

Trigger Authentication#

Summit uses API keys for authentication. When you connect your Summit account, Pipedream securely stores the keys so you can easily authenticate to Summit APIs in both code and no-code steps.

About Summit#

Summit gives you the triggers, actions, and models to extend what's possible inside your favorite platforms.

Action#

Retrieve Sales Performance Reports on Amazon Selling Partner

Description:Fetches sales reports for visualization in third-party dashboarding tools. [See the documentation](https://developer-docs.amazon.com/sp-api/reference/getordermetrics)

Version:0.0.1

Key:amazon_selling_partner-retrieve-sales-performance-reports

View on GitHub

Action Code#

import amazonSellingPartner from "../../amazon_selling_partner.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "amazon_selling_partner-retrieve-sales-performance-reports",
  name: "Retrieve Sales Performance Reports",
  description: "Fetches sales reports for visualization in third-party dashboarding tools. [See the documentation](https://developer-docs.amazon.com/sp-api/reference/getordermetrics)",
  version: "0.0.1",
  type: "action",
  props: {
    amazonSellingPartner,
    marketplaceId: {
      propDefinition: [
        amazonSellingPartner,
        "marketplaceId",
      ],
    },
    interval: {
      type: "string",
      label: "Interval",
      description: "A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: `2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00` requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone.",
    },
    granularity: {
      type: "string",
      label: "Granularity",
      description: "The granularity of the grouping of order metrics, based on a unit of time",
      options: [
        "Hour",
        "Day",
        "Week",
        "Month",
        "Year",
        "Total",
      ],
    },
    granularityTimeZone: {
      type: "string",
      label: "Granularity Time Zone",
      description: "An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour.",
      optional: true,
    },
    buyerType: {
      type: "string",
      label: "Buyer Type",
      description: "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.",
      options: [
        "All",
        "B2B",
        "B2C",
      ],
      optional: true,
    },
    fulfillmentNetwork: {
      type: "string",
      label: "Fulfillment Network",
      description: "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.",
      optional: true,
    },
    firstDayOfWeek: {
      type: "string",
      label: "First Day of Week",
      description: "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.",
      options: [
        "Monday",
        "Sunday",
      ],
      optional: true,
    },
    asin: {
      type: "string",
      label: "ASIN",
      description: "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.",
      optional: true,
    },
    sku: {
      type: "string",
      label: "SKU",
      description: "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.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.asin && this.sku) {
      throw new ConfigurationError("Cannot specify both ASIN and SKU parameters");
    }
    const { payload } = await this.amazonSellingPartner.getOrderMetrics({
      $,
      params: {
        marketplaceIds: this.marketplaceId,
        interval: this.interval,
        granularity: this.granularity,
        granularityTimeZone: this.granularityTimeZone,
        buyerType: this.buyerType,
        fulfillmentNetwork: this.fulfillmentNetwork,
        firstDayOfWeek: this.firstDayOfWeek,
        asin: this.asin,
        sku: this.sku,
      },
    });
    $.export("$summary", "Fetched sales performance reports");
    return payload;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Amazon Selling Partner	`amazonSellingPartner`	`app`	This component uses the Amazon Selling Partner app.
Marketplace ID	`marketplaceId`	`string`	Select a value from the drop down menu.
Interval	`interval`	`string`	A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: `2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00` requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone.
Granularity	`granularity`	`string`	Select a value from the drop down menu:`HourDayWeekMonthYearTotal`
Granularity Time Zone	`granularityTimeZone`	`string`	An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour.
Buyer Type	`buyerType`	`string`	Select a value from the drop down menu:`AllB2BB2C`
Fulfillment Network	`fulfillmentNetwork`	`string`	Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network.
First Day of Week	`firstDayOfWeek`	`string`	Select a value from the drop down menu:`MondaySunday`
ASIN	`asin`	`string`	Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
SKU	`sku`	`string`	Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.

Action Authentication#

Amazon Selling Partner uses OAuth authentication. When you connect your Amazon Selling Partner account, Pipedream will open a popup window where you can sign into Amazon Selling Partner and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Amazon Selling Partner API.

Pipedream requests the following authorization scopes when you connect your account:

About Amazon Selling Partner#

For Amazon selling partners, programmatically access data on your orders, shipments, payments, and much more. Applications using the SP-API can increase selling efficiency, reduce labor requirements, and improve response time to customers, helping selling partners grow their businesses.