Skip to main content

Carrier Accounts

Carrier account management and FedEx registration

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List carrier accounts​

GET/api/v1/carrier-accounts

Responses​

200 Carrier account list

GET/api/v1/carrier-accounts

List carrier accounts

https://api-test.orderly-hub.com/api/v1/carrier-accounts

Create a carrier account​

POST/api/v1/carrier-accounts

Request body​

FieldTypeDescription
carrierstring
accountNamestring
accountNumberstring
credentialsobject
testModeboolean
{
"carrier": "string",
"accountName": "string",
"accountNumber": "string",
"credentials": {},
"testMode": true
}

Responses​

201 Carrier account created

POST/api/v1/carrier-accounts

Create a carrier account

https://api-test.orderly-hub.com/api/v1/carrier-accounts

Start FedEx registration​

POST/api/v1/carrier-accounts/fedex/register

Request body​

{}

Responses​

200 Registration initiated

POST/api/v1/carrier-accounts/fedex/register

Start FedEx registration

https://api-test.orderly-hub.com/api/v1/carrier-accounts/fedex/register

Request FedEx verification PIN​

POST/api/v1/carrier-accounts/fedex/request-pin

Request body​

{}

Responses​

200 PIN requested

POST/api/v1/carrier-accounts/fedex/request-pin

Request FedEx verification PIN

https://api-test.orderly-hub.com/api/v1/carrier-accounts/fedex/request-pin

Verify FedEx invoice for account activation​

POST/api/v1/carrier-accounts/fedex/verify-invoice

Request body​

{}

Responses​

200 Invoice verified

POST/api/v1/carrier-accounts/fedex/verify-invoice

Verify FedEx invoice for account activation

https://api-test.orderly-hub.com/api/v1/carrier-accounts/fedex/verify-invoice

Verify FedEx PIN​

POST/api/v1/carrier-accounts/fedex/verify-pin

Request body​

{}

Responses​

200 PIN verified

POST/api/v1/carrier-accounts/fedex/verify-pin

Verify FedEx PIN

https://api-test.orderly-hub.com/api/v1/carrier-accounts/fedex/verify-pin

Get carrier account details​

GET/api/v1/carrier-accounts/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Carrier account details

GET/api/v1/carrier-accounts/{id}

Get carrier account details

https://api-test.orderly-hub.com/api/v1/carrier-accounts/

Update a carrier account​

PATCH/api/v1/carrier-accounts/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Request body​

{}

Responses​

200 Carrier account updated

PATCH/api/v1/carrier-accounts/{id}

Update a carrier account

https://api-test.orderly-hub.com/api/v1/carrier-accounts/

Delete a carrier account​

DELETE/api/v1/carrier-accounts/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Carrier account deleted

DELETE/api/v1/carrier-accounts/{id}

Delete a carrier account

https://api-test.orderly-hub.com/api/v1/carrier-accounts/

Test carrier account connectivity​

POST/api/v1/carrier-accounts/{id}/test

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Test result

POST/api/v1/carrier-accounts/{id}/test

Test carrier account connectivity

https://api-test.orderly-hub.com/api/v1/carrier-accounts//test