StyloDocs
Workflow blocks

AfterShip

Look up live shipment tracking status across 1,100+ carriers — answer 'where is my order' with the current carrier status and ETA

View as Markdown

aftership/manage — Look up live shipment tracking status across 1,100+ carriers — answer 'where is my order' with the current carrier status and ETA.

Where it appears

The AfterShip block lives in the Integrations group of the Workflow Builder. Connect the Aftership integration before adding it.

Fields

FieldTypeRequiredDefaultDescription
resourceselectYestrackingWhich AfterShip resource to work with. Options: tracking, courier.
operationselectYesWhich action to perform on the selected resource.
trackingNumbertext (supports references)NoThe carrier tracking number (e.g. from the Shopify order).
courierSlugtext (supports references)NoAfterShip courier slug. Leave blank to let AfterShip auto-detect from the number.
keywordtextNoFree-text search across tracking number, title, order ID, and customer fields.
statusFilterselectNoanyOnly return trackings with this delivery status. Options: any, Pending, InfoReceived, InTransit, OutForDelivery, AttemptFail, AvailableForPickup, Delivered, Exception, Expired.
trackingTitletextNoOptional human-readable title for the tracking.
trackingOrderIdtext (supports references)NoOptionally associate the tracking with an order ID.
returnAlltoggleNofalseFetch every matching record by paginating automatically. When on, Limit is ignored.
limitnumberNo100Maximum number of records to return. AfterShip caps this at 200. Ignored when Return All is on.

Inputs and outputs

Inputs are the configurable fields above. The block produces these outputs:

Outputs

Reference an output downstream with <AfterShip.field>.

NameTypeDescription
successbooleanOperation success status
trackingjsonSingle tracking (Get Tracking / Create Tracking) (object — fields: id, tracking_number, slug, tag, subtag, title, order_id, transit_time, origin_country_region, destination_country_region, estimated_delivery_date, shipment_delivery_date, checkpoints, updated_at)
trackingsarrayMatching trackings (List Trackings)
couriersarrayDetected couriers (Detect Courier)
errorstringError message if failed

Example

A minimal configuration for this block:

{
  "type": "aftership/manage",
  "config": {
    "resource": "tracking",
    "operation": "...",
    "statusFilter": "any",
    "returnAll": false,
    "limit": 100
  }
}

Limits and failure modes

  • Requires a connected Aftership integration. Calls fail if that integration is disconnected or its authorization has expired.
  • Required fields (resource, operation) must be set, or the block fails validation before it runs.
  • On failure the error output is populated; downstream blocks that reference other outputs may not receive values.

On this page