Shipping Companies

Shipping company management is an Admin-only feature. Integrates with external courier services for order fulfillment.

List Shipping Companies

GET/shipping-companies🔒 Session — can viewAny

Paginated list of shipping companies.

Create Shipping Company

POST/shipping-companies/store🔒 Session — can create

Register a new shipping company integration. The integration is tested (pinged) after creation — if the ping fails, the creation is rolled back.

Field	Type	Required	Description
name	string	Yes	Company name (1–100 chars)
type	number	Yes	Integration type (see types below)
can_track_status	boolean	No	Whether status tracking is supported
payload	object	Yes	Integration credentials (varies by type)

Payload fields per type:

Type	Required Payload Fields
Digylog	payload.token, payload.referer, payload.baseUrl
ZR Express	payload.token, payload.cle
Ameex	payload.id, payload.key
Ecotrack	payload.token
Chamelexpress	payload.token
FoxLivraison	payload.email, payload.token
ForceLog	payload.api_key

Show Shipping Company

GET/shipping-companies/{item}/show🔒 Session — can view

View shipping company details.

Update Shipping Company

PATCH/shipping-companies/{item}/update🔒 Session — can update

Update shipping company credentials. The type cannot be changed after creation. Integration is re-tested after update.

Same payload fields as creation, based on the existing type.

Toggle Status

PATCH/shipping-companies/{item}/toggle🔒 Session

Toggle shipping company status or tracking capability.

Delete Shipping Companies (Bulk)

DELETE/shipping-companies/delete🔒 Session — can delete

Bulk delete shipping companies.

Field	Type	Required	Description
ids	array	Yes	Array of shipping company IDs

Export Shipping Companies

POST/shipping-companies/export🔒 Session

Export shipping companies to a file. Processed asynchronously.

Search Shipping Companies

GET/search/shipping-companies🔒 Session — can search

Search shipping companies for autocomplete. Returns [{id, text}].