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 Parameter	Type	Required
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

Request

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"
      }
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "carrier_accounts",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/carrier_accounts/xYZkjABcde"
    },
    "attributes": {
      "name": "Accurate",
      "easypost_type": "AccurateAccount",
      "easypost_id": "xxxx-yyyy-zzzz",
      "credentials": {
        "username": "xxxx",
        "password": "secret"
      },
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "market": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/carrier_accounts/xYZkjABcde/relationships/market",
          "related": "https://yourdomain.commercelayer.io/api/carrier_accounts/xYZkjABcde/market"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/carrier_accounts/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/carrier_accounts/xYZkjABcde/attachments"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/carrier_accounts/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/carrier_accounts/xYZkjABcde/versions"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}