Create a carrier account

How to create a carrier account via API

To create a new carrier account, send a POST request to the /api/carrier_accounts endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/carrier_accounts

Arguments

Body ParameterTypeRequired

type

string

Required

attributes.name

string

Required

attributes.easypost_type

string

Required

attributes.credentials

object

Required

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

relationships.market

object

Optional

Example

The following request creates a new carrier account:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/carrier_accounts' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "carrier_accounts",
    "attributes": {
      "name": "Accurate",
      "easypost_type": "AccurateAccount",
      "credentials": {
        "username": "xxxx",
        "password": "secret"
      }
    }
  }
}'

Last updated