API

API endpoints > carriers > carrier > post

Activate a new carrier and set the allowed options.

Add the required carrierId to the end of the URL to identify the object for the request.

JSON data structure

  • AvailableBooleanrequiredIs this carrier available for use to the client?
  • OptionsArray of single valuesrequiredAll allowed option id's, except the service level option id which is always allowed
  • ServiceLevelsArray of single valuesAll allowed servicelevel codes
  • AuthInfoID list of objectsKeys and other carrier specifics, defined by carrier.
    • IdStringrequiredMinimum length: 1The id of the field
    • ValueInteger numberrequiredMinimum value: 1The value of the field

JSON reply data

No data is returned, only a http code to tell you if the operation was succesful or not.

GET/carriers/
GET/carriers/allowed/
POST/carriers/carrier/:carrierId
PATCH/carriers/carrier/:carrierId