View as Markdown
Everstox icon

Everstox ACTION

Search Orders by Order Number

Search orders from Everstox. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Everstox account once, then configure and run Search Orders by Order Number 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: "everstox-search-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    everstox: { authProvisionId: "apn_xxxxxxx" },
    warehouseIds: ["Warehouse IDs"],
    fields: ["Fields"],
  },
})

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.

Search Orders by Order Number inputs
Property Type Description
warehouseIds Warehouse IDs string[]
Warehouse IDs
Optional Dynamic
fields Fields string[]
Fields to filter for
Optional
orderNumber Order Number string
Filter for order number
Optional Dynamic
hoursLateLte Hours Late Less Than or Equal to integer
Filter for orders late for the amount of hours less or equal than the provided value
Optional
hoursLateGte Hours Late Greater Than or Equal to integer
Filter for orders late for the amount of hours greater or equal than the provided value
Optional
search Search string
Multi-attribute-search filters either for Customer Email or Billing Address or Order Number. Returns set of orders where at least one of those attributes match the search term
Optional
fulfillmentState Fulfillment State string
Fulfillment State to filter for order where the corresponding fulfillment is in the given state
Optional
fulfillmentStategroup Fulfillment Stategroup string
Fulfillment Stategroup to filter for order where the corresponding fulfillment is in the given stategroup
Optional
stategroup Stategroup string
Stategroup to filter for, e.g. open includes states like new, in_progress etc
Optional
cancellationState Cancellation State string
Cancellation State to filter for order with min 1 cancellation in that state
Optional
shipmentDateGte Shipment Date Greater Than or Equal string
Find orders whose shipment date is greater than or equal to the provided value
Optional
updatedDateGte Updated Date Greater Than or Equal string
Find orders whose updated date is greater than or equal to the provided value
Optional
createdDateGte Created Date Greater Than or Equal string
Find orders whose creation date is greater than or equal to the provided value
Optional
createdDateLte Created Date Less Than or Equal string
Find orders whose created date is less than or equal to the provided value
Optional
shipmentsForwardedToShop Shipments Forwarded to Shop boolean
Boolean returning orders with shipments forwarded to shop
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
everstox-search-orders
Version
0.0.2
App
Everstox
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes