List Inbound Shipments with Selling Partner API (SP-API) API on New Scan from CodeREADr API

Pipedream makes it easy to connect APIs for Selling Partner API (SP-API), CodeREADr and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scan from the CodeREADr API

Next, do this

List Inbound Shipments with the Selling Partner API (SP-API) 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 CodeREADr trigger and Selling Partner API (SP-API) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scan trigger
1. Connect your CodeREADr account
2. Configure Polling schedule
3. Select one or more Status
Configure the List Inbound Shipments action
1. Connect your Selling Partner API (SP-API) account
2. Select a Marketplace ID
3. Select one or more Status
4. Optional- Configure Last Updated After
5. Optional- Configure Last Updated Before
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 Scan on CodeREADr

Description:Emit new event when there is a new scan. [See the documentation](https://secure.codereadr.com/apidocs/Scans.md#retrieve)

Version:0.0.1

Key:codereadr-new-scan

View on GitHub

CodeREADr Overview#

The CodeREADr API allows you to integrate barcode scanning and data collection into your workflows on Pipedream. With this API, you can automate barcode validation, track event attendance, manage inventory, and more by creating, updating, and retrieving scan records. Pipedream's serverless platform enables you to connect CodeREADr with other apps, triggering actions based on scan data, or enriching CodeREADr data with information from other sources.

Trigger Code#

import utils from "../../common/utils.mjs";
import common from "../common/polling.mjs";

export default {
  ...common,
  key: "codereadr-new-scan",
  name: "New Scan",
  description: "Emit new event when there is a new scan. [See the documentation](https://secure.codereadr.com/apidocs/Scans.md#retrieve)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    status: {
      propDefinition: [
        common.props.app,
        "status",
      ],
    },
  },
  methods: {
    ...common.methods,
    getResourceName() {
      return "scan";
    },
    getResourceFn() {
      return this.app.listScans;
    },
    getResourceFnArgs() {
      const {
        getLastTimestamp,
        status,
      } = this;

      const lastTimestamp = getLastTimestamp();

      const args = {
        params: {
          status: utils.parseArray(status).join(","),
          order_by: "timestamp",
        },
      };

      if (!lastTimestamp) {
        return args;
      }

      return {
        params: {
          ...args.params,
          start_date: lastTimestamp.split(" ")[0],
        },
      };
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Scan: ${resource.id}`,
        ts: Date.parse(resource.timestamp),
      };
    },
  },
};

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
CodeREADr	`app`	`app`	This component uses the CodeREADr app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the API
Status	`status`	`string[]`	Select a value from the drop down menu:`{ "label": "Valid", "value": "1" }{ "label": "Invalid", "value": "0" }{ "label": "Not Validated Due To Lost Internet Connectivity", "value": "-1" }`

Trigger Authentication#

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

About CodeREADr#

A barcode scanning and data collection workflow app using smartphones, tablets, and rugged mobile computers. Record, validate, and export scans.

Action#

List Inbound Shipments on Selling Partner API (SP-API)

Description:Fetches inbound shipment details to track stock movement and replenishment. [See the documentation](https://developer-docs.amazon.com/sp-api/reference/getshipments)

Version:0.0.2

Key:amazon_selling_partner-list-inbound-shipments

View on GitHub

Action Code#

import amazonSellingPartner from "../../amazon_selling_partner.app.mjs";

export default {
  key: "amazon_selling_partner-list-inbound-shipments",
  name: "List Inbound Shipments",
  description: "Fetches inbound shipment details to track stock movement and replenishment. [See the documentation](https://developer-docs.amazon.com/sp-api/reference/getshipments)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    amazonSellingPartner,
    marketplaceId: {
      propDefinition: [
        amazonSellingPartner,
        "marketplaceId",
      ],
    },
    status: {
      propDefinition: [
        amazonSellingPartner,
        "status",
      ],
    },
    lastUpdatedAfter: {
      type: "string",
      label: "Last Updated After",
      description: "A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.",
      optional: true,
    },
    lastUpdatedBefore: {
      type: "string",
      label: "Last Updated Before",
      description: "A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.",
      optional: true,
    },
  },
  async run({ $ }) {
    const shipments = await this.amazonSellingPartner.getPaginatedResources({
      fn: this.amazonSellingPartner.listInboundShipments,
      params: {
        MarketplaceId: this.marketplaceId,
        ShipmentStatusList: this.status?.length
          ? this.status.join(",")
          : undefined,
        LastUpdatedAfter: this.lastUpdatedAfter,
        LastUpdatedBefore: this.lastUpdatedBefore,
      },
      resourceKey: "ShipmentData",
    });
    $.export("$summary", `Fetched ${shipments.length} shipment${shipments.length === 1
      ? ""
      : "s"}`);
    return shipments;
  },
};

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
Selling Partner API (SP-API)	`amazonSellingPartner`	`app`	This component uses the Selling Partner API (SP-API) app.
Marketplace ID	`marketplaceId`	`string`	Select a value from the drop down menu.
Status	`status`	`string[]`	Select a value from the drop down menu:`WORKINGSHIPPEDRECEIVINGCANCELLEDDELETEDCLOSEDERRORIN_TRANSITDELIVEREDCHECKED_IN`
Last Updated After	`lastUpdatedAfter`	`string`	A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
Last Updated Before	`lastUpdatedBefore`	`string`	A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

Action Authentication#

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

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

About Selling Partner API (SP-API)#

Selling Partner API (SP-API) allow you to 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.