Overview
ParcelPerform works as a label-booking carrier in Luminous — you connect it under Manage > Carrier Accounts, exactly like FedEx or UPS, but instead of quoting rates it selects the carrier and service itself when the label is booked.
Access: This feature is enabled per tenant. Contact your Luminous account manager to have it turned on before following these steps.
Step 1 — Connect the carrier account
- Go to Manage > Carrier Accounts.
- Click Add Carrier Account, choose Bring my own carrier account, and select ParcelPerform from the Carrier list.
- Fill in the credential fields:
| Field | Required | Notes |
|---|---|---|
| Client ID | Yes | OAuth2 client ID from ParcelPerform |
| Client Secret | Yes | OAuth2 client secret from ParcelPerform |
| Carrier Reference | No | Only needed if your ParcelPerform account has no default carrier configured, or if you want to pin a specific one. Leave blank to let ParcelPerform route automatically. |
| Webhook Authentication Key | No | Required only if you want tracking status updates pushed back to Luminous (see Step 2). |
- Click Test Credentials to verify the connection. Luminous calls ParcelPerform's carrier configuration endpoint — a success means the OAuth2 token was issued and the credentials are valid. If the credentials are valid but your ParcelPerform account has no carriers configured yet, Luminous will say so; address that in the ParcelPerform portal before printing.
- Save the account.
Step 2 — Configure the tracking webhook (optional)
If you want shipment tracking events from ParcelPerform to update Luminous automatically:
-
In the ParcelPerform portal, create a webhook pointing to:
https://<your-luminous-domain>/external/v1/parcelperform/webhook/<carrier-account-id>Replace
<carrier-account-id>with the numeric ID of the carrier account you just created (visible in the URL when you open it in Manage > Carrier Accounts). -
Copy the Webhook Authentication Key that ParcelPerform provides and paste it into the Webhook Authentication Key field on the Luminous carrier account, then save.
Luminous validates each delivery using HMAC-SHA256; events that do not match the key are rejected.
Step 3 — Print labels
- Go to Operations > Fulfillment Orders and switch to the Shipping view.
- Select the orders you want to ship.
- In the carrier selector, choose your ParcelPerform account.
- ParcelPerform does not return rates, so it will not appear in the "Shop All Carriers" comparison. Select it directly.
- The rate display shows Carrier selects service instead of a cost — pricing lands on your ParcelPerform invoice, not at print time.
- Click Print.
Single-parcel only: ParcelPerform currently supports one parcel per label request. Multi-parcel shipments must be printed one at a time.
Notes and limitations
- Voiding labels: ParcelPerform's API does not expose a cancellation endpoint. If you need to void a label, cancel the booking in the ParcelPerform portal first, then mark it voided in Luminous manually.
- Carrier Reference field: This field pins a specific carrier configuration from your ParcelPerform account. If it is set to a returns-configured reference, ParcelPerform will book a return label instead of an outbound one — Luminous will surface this as an error. Verify the reference in the ParcelPerform portal if this happens.
- Fulfillment Order required: Labels can only be printed against a Fulfillment Order. Ad-hoc label requests without a Fulfillment Order are not supported for this carrier.