Carriers (admin API)

Admin routes of the carriers module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.

GET /v1/admin/carriers

List carriers

Parameters:

• isActive in query (boolean, optional).
• page in query (number, min 1, optional).
• pageSize in query (number, min 1, max 100, optional).
• provider in query ("aramex", "dhl", "fedex", "manual", "ups", optional).

Responses:

• 200: Carriers retrieved.

POST /v1/admin/carriers

Create carrier

Request body: CreateCarrierDto.

Responses:

• 201: Created.
• 409: Code already in use.

DELETE /v1/admin/carriers/{id}

Soft-delete carrier

Parameters:

• id in path (string, required).

Responses:

• 204: Deleted.
• 404: Not found.

GET /v1/admin/carriers/{id}

Get carrier

Parameters:

• id in path (string, required).

Responses:

• 200: Carrier retrieved.
• 404: Not found.

PATCH /v1/admin/carriers/{id}

Update carrier

Parameters:

• id in path (string, required).

Request body: UpdateCarrierDto.

Responses:

• 200: Updated.
• 404: Not found.

Schemas

CarrierTranslatableDto

• fr (string, optional).
• en (string, optional).
• ar (string, optional).
• default (string, required).

CreateCarrierDto

• code (string, pattern ^[a-z0-9_]+$, min length 2, max length 50, required).
• name (CarrierTranslatableDto, required).
• provider ("aramex", "dhl", "fedex", "manual", "ups", required).
• services (array of string, optional).
• zones (array of string, pattern ^[A-Z]{2}$, optional).
• isActive (boolean, optional).
• sortOrder (number, min 0, optional).
• config (object, optional).

OptionalTranslatableDto

• fr (string, optional).
• en (string, optional).
• ar (string, optional).
• default (string, optional).

UpdateCarrierDto

• name (OptionalTranslatableDto, optional).
• services (array of string, optional).
• zones (array of string, pattern ^[A-Z]{2}$, optional).
• isActive (boolean, optional).
• sortOrder (number, min 0, optional).
• config (object, optional).