Qodex.ai

Create a carrier account

POST https://{{subdomain}}.commercelayer.io/api/carrier_accounts

Request Body

{"data"=>{"type"=>"carrier_accounts", "attributes"=>{"name"=>"{{carrier_account_name}}", "easypost_type"=>"{{carrier_account_easypost_type}}", "credentials"=>"{{carrier_account_credentials}}"}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring

RESPONSES

status: Created

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