Save Bosta credentials

PUT

https://numueg.app/api/v1/stores/{store_id}/settings/shipping/bosta/credentials

Last modified:2026-09-19 16:39:33

x-numu-scope:settings:write

Save or update Bosta shipping credentials for the store.

Credentials are encrypted at rest using AES-128 (Fernet).

Superseded by PUT /shipments/carriers/{slug}/credentials, which
works for every registered carrier. Kept because existing clients call
this path, but it now runs the same shared logic so both routes behave
identically.

Two behaviours changed here, deliberately:

It used to set is_configured: True without ever calling
Bosta, so a typo'd API key showed a green "Live" badge. It now
verifies and persists the result.

It used to set enabled: True, silently switching the carrier on
as a side effect of saving a key. Enabling is an explicit action in
shipping settings; a carrier whose credentials Bosta rejects must
not be enabled at all.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://numueg.app/api/v1/stores//settings/shipping/bosta/credentials' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "api_key": "stringstri",
    "business_id": "string",
    "webhook_secret": "string",
    "auto_create_shipment": false
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "is_configured": true,
        "api_key_masked": "string",
        "business_id": "string",
        "auto_create_shipment": false,
        "last_configured": "string"
    },
    "message": "string"
}

Modified at 2026-09-19 16:39:33

Delete shipping zone

Get Bosta credentials status