Skip to main content

AfterShip

Integrating AfterShip with ToolJet enables teams to build custom internal tools for tracking and managing shipments in real time. With this integration, you can fetch delivery statuses, monitor carrier updates, and centralize logistics data within your ToolJet application, streamlining operations and improving customer support efficiency.

Connection

To connect AfterShip with ToolJet you will need the API Key, which you can generate from Aftership Tracking API.

Aftership Configuration

Supported Operations

Tracking

Basic Tracking Operations

MethodEndpointDescription
GET/trackingsRetrieve list of trackings.
POST/trackingsCreate a new tracking.
GET/couriersGet supported courier list.

ID

MethodEndpointDescription
GET/trackings/{id}Get tracking by ID.
PUT/trackings/{id}Update tracking by ID.
DELETE/trackings/{id}Delete tracking by ID.
POST/trackings/{id}/retrackRetrack an expired tracking.
POST/trackings/{id}/mark-as-completedMark tracking as completed.

Detect

MethodEndpointDescription
POST/couriers/detectDetect courier by tracking number.

All

MethodEndpointDescription
GET/couriers/allGet all available couriers.

Predict Batch

MethodEndpointDescription
POST/estimated-delivery-date/predict-batchPredict estimated delivery for batch.

Shipping

Labels

MethodEndpointDescription
GET/labelsGet labels
POST/labelsCreate a label
GET/labels/{id}Get a label by ID

Cancel Labels

MethodEndpointDescription
GET/cancel-labelsGet the cancelled labels
POST/cancel-labelsCancel a label
GET/cancel-labels/{id}Get a cancelled label by ID

Rates

MethodEndpointDescription
GET/ratesGet rates
POST/ratesCalculate rates
GET/rates/{id}Get a rate by ID

Manifests

MethodEndpointDescription
GET/manifestsGet manifests
POST/manifestsCreate a manifest
GET/manifests/{id}Get a manifest by ID

Couriers

MethodEndpointDescription
GET/couriersGet all couriers

Address Validations

MethodEndpointDescription
POST/address-validationsCreate an address validation

Location

MethodEndpointDescription
GET/locationsGet carrier locations (requires production)

Pickup

MethodEndpointDescription
GET/pickupsGet pickups
POST/pickupsCreate a pickup (FedEx, UPS, DHL Express, Purolator)
GET/pickups/{id}Get a pickup by ID

Cancel Pickups

MethodEndpointDescription
GET/cancel-pickupsGet the cancelled pickups
POST/cancel-pickupsCancel a pickup
GET/cancel-pickups/{id}Get a cancelled pickup by ID

Shipper Accounts

MethodEndpointDescription
GET/shipper-accountsGet shipper accounts
POST/shipper-accountsCreate a shipper account
GET/shipper-accounts/{id}Get a shipper account by ID
DELETE/shipper-accounts/{id}Delete a shipper account
PUT/shipper-accounts/{id}/infoUpdate shipper account's information
PUT/shipper-accounts/{id}/credentialsUpdate shipper account's credentials
PUT/shipper-accounts/{id}/settingsUpdate shipper account's settings (FedEx)

Return

Returns Management

MethodEndpointDescription
GET/returnsGet returns with optional filtering
POST/returnsCreate a new return (supports only "Refund")
GET/returns/{return_id}Get return detail by return ID
GET/returns/rma/{rma_number}Get return detail by RMA number

Return Status Management

MethodEndpointDescription
POST/returns/{return_id}/approveApprove return by return ID
POST/returns/rma/{rma_number}/approveApprove return by RMA number
POST/returns/{return_id}/resolveResolve return by return ID
POST/returns/rma/{rma_number}/resolveResolve return by RMA number
POST/returns/{return_id}/rejectReject return by return ID
POST/returns/rma/{rma_number}/rejectReject return by RMA number

Item Management

MethodEndpointDescription
POST/returns/{return_id}/receive-itemsRecord received items by return ID
POST/returns/rma/{rma_number}/receive-itemsRecord received items by RMA number
PUT/returns/{return_id}/items/{item_id}Update return item (tags/images) by return ID
PUT/returns/rma/{rma_number}/items/{item_id}Update return item (tags/images) by RMA number
POST/returns/{return_id}/remove-itemsRemove items from return by return ID
POST/returns/rma/{rma_number}/remove-itemsRemove items from return by RMA number

Shipping Management

MethodEndpointDescription
POST/returns/{return_id}/attach-shipmentsUpload shipment info by return ID
POST/returns/rma/{rma_number}/attach-shipmentsUpload shipment info by RMA number

Dropoff Management

MethodEndpointDescription
POST/returns/rma/{rma_number}/dropoffs/{dropoff_id}/dropsRecord dropped-off items (QR dropoffs)

Utility Endpoints

MethodEndpointDescription
POST/returns/linkGenerate returns page deep link with pre-filled info
GET/item-tagsRetrieve all available item tags