View as Markdown
ShipHero icon

ShipHero ACTION

List Products

List products. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ShipHero account once, then configure and run List Products from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "shiphero-list-products",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shiphero: { authProvisionId: "apn_xxxxxxx" },
    sku: "SKU",
    createdFrom: "Created From",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Products inputs
Property Type Description
sku SKU string
The SKU of the product.
Optional
createdFrom Created From string

The date the product was created from. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg.

  • YYYY-mm-dd
  • YYYY-mm-dd HH:MM:SS
  • YYYY-mm-ddTHH:MM:SS
Optional
createdTo Created To string

The date the product was created to. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg.

  • YYYY-mm-dd
  • YYYY-mm-dd HH:MM:SS
  • YYYY-mm-ddTHH:MM:SS
Optional
updatedFrom Updated From string

The date the product was updated from. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg.

  • YYYY-mm-dd
  • YYYY-mm-dd HH:MM:SS
  • YYYY-mm-ddTHH:MM:SS
Optional
updatedTo Updated To string

The date the product was updated to. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg.

  • YYYY-mm-dd
  • YYYY-mm-dd HH:MM:SS
  • YYYY-mm-ddTHH:MM:SS
Optional
customerAccountId Customer Account ID string
The ID of the customer account.
Optional
hasKits Has Kits boolean
Whether the product has kits.
Optional
analyze Analyze boolean
Whether to analyze the product.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
shiphero-list-products
Version
0.0.2
App
ShipHero
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes