Create Custom Carrier Code

Create a custom carrier code that represents a specific combination of carrier, carrier account, parcel type, service, and special services.
This custom carrier code can then be used in the Create Shipment API, so users don't need to manually re-enter these parameters each time.
Once generated, the code can be reused across multiple shipments to reduce effort in shipping requests.

SecuritybearerAuth
Request
Request Body schema: application/json
code
required
string

Unique custom carrier code value defined by the client.

carrier
required
string

Carrier name associated with the custom configuration.

carrierAccountId
required
string

Unique identifier of the carrier account under which shipments will be processed.

parcelType
string

Parcel type (e.g., PKG for package, LTR for letter).

parcelName
string

Human-readable name for the parcel type (optional).

serviceId
string

Identifier of the shipping service to be used.

serviceName
string

Human-readable name of the shipping service (optional).

Array of objects

List of special services applied to the custom carrier code.

Responses
201

Custom Carrier Code successfully created.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/custom-carrier-codes
Request samples
application/json
{
  • "code": "FEDEX-custom-code1",
  • "carrier": "FEDEX",
  • "carrierAccountId": "xxxxxxxxxxx",
  • "parcelType": "PKG",
  • "parcelName": "Package",
  • "serviceId": "GRD",
  • "serviceName": "Ground",
  • "specialServices": [
    ]
}
Response samples
application/json
{
  • "code": "FEDEX-custom-code1"
}