Skip to content

Settings

Open Add-ons > Manage add-ons > FedEx REST Rates & Labels > Settings.

Setting Default Description
Enable On When off, no new work is started. Jobs of work that is already under way are still processed.
Marketplace owner mode On Multi-Vendor. On: every order is processed with the marketplace owner’s account and vendors have no connection page. Off: each vendor connects their own account.
Vendors may create labels Off Multi-Vendor, owner mode only. Lets vendors buy labels and book pickups for their own orders with the owner’s FedEx account (the owner is billed).
Debug log Off Also stores every HTTP call with masked request and response. Secrets are never stored.
Log retention (days) 90 Older log entries are removed by the cron run.
Create the label when the order status becomes empty Empty = create labels by hand on the order page.
Set the order status when FedEx delivers empty Order status to set when tracking reports “delivered”.
Also create a CS-Cart shipment On Records the tracking number as a regular shipment so the customer’s order page and notifications show it.
Fallback shipping rate empty Offered for every FedEx method when FedEx does not answer or has no rate. Empty = hide the method. A method can have its own fallback.

Credentials are not ordinary settings: they are entered on the Connection page and stored encrypted (AES-256-GCM, key derived from your store’s own secret). They are never shown again; leave a secret field empty to keep the saved value.

Field Description
Mode Test uses the sandbox (apis-sandbox.fedex.com) and the test keys; Live uses production (apis.fedex.com) and the live keys.
Client ID / Client secret The API key and secret key of your FedEx Developer Portal project, one pair for test and one for live.
Child secret, Child key Only for FedEx-compatible providers and integrators that give you a child key and secret (OAuth grant csp_credentials). Leave empty for a normal project.
FedEx account number The 9-digit account billed for rates and labels. Required for rating and shipping.
Ship-from address Name, company, street, city, state, ZIP, country (ISO), phone, e-mail. Empty fields use the company details of the store (or of the vendor).
Prices at checkout Your account (negotiated) rates or FedEx list rates.
Pickup type for rates Drop off at a FedEx location, regular scheduled pickup, or contact FedEx to schedule. Affects the rate FedEx quotes.
Packaging type Your own packaging, or FedEx Pak / Box / Tube / Envelope.
Deliveries are residential Used for rates until the address has been validated; a validated address uses the FedEx classification.
Label file type / Label stock PDF, PNG or ZPL II, and the FedEx labelStockType (empty = a default that fits the file type).
Default package length, width, height In inches (US) or centimetres, used when a product has no box size.
Heaviest package Orders heavier than this are pre-split into several packages (FedEx accepts 150 lb / 68 kg).
Country of manufacture, default HS code Pre-filled on customs lines of international shipments.

Markup (percent plus fixed amount), round up, free shipping from a package value, fallback rate, show the delivery date, direct signature, declare the value of the package.

The queue runs from cron. Use either the command line or the secret web address shown in the Cron section of the settings:

  • php /path/to/store/admin.php --dispatch=kv_fedex_rest.cron
  • https://your-store.example/index.php?dispatch=kv_fedex_rest.cron&key=<secret>

The queue creates labels at the chosen order status, refreshes the tracking of open shipments every 30 minutes and checks each connection once a day.

  • Log lists every call and job with filters (level, action, text, dates) and a CSV export.
  • Jobs lists the queue. A job that fails is retried after 5 minutes, 15 minutes, 1 hour, 3 hours and 12 hours, then marked “Gave up”; use Retry to queue it again.

In the vendor panel a vendor sees only their own records. With the marketplace owner mode off the vendor also gets the Connection tab for their own account. Running the queue, retrying or removing jobs is for the marketplace owner only.