Save credentials for a carrier

PUT

https://numueg.app/api/v1/stores/{store_id}/shipments/carriers/{slug}/credentials

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

x-numu-scope:orders:write

Encrypt and store a carrier's credentials, then verify them.

Verification runs inline and its result is persisted, so the response
already tells the merchant whether the keys actually work. Saving no
longer implies "connected" — that was the bug behind the green badge
for a typo'd key.

A carrier is not auto-enabled on save. Enabling stays an explicit
action in shipping settings.

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//shipments/carriers//credentials' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "credentials": {
        "property1": "string",
        "property2": "string"
    },
    "auto_create_shipment": true
}'

Response Example

200 - Example 1

null

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

Carrier catalog with this store's connection state

Disconnect a carrier