Get Ship via Code by Code

This operation retrieves the details of a specific ship via code mapping by its unique code.
A ship via code represents a saved configuration of carrier, carrier account, parcel, service, and special services.

SecuritybearerAuth
Request
path Parameters
code
required
string

Unique ship via code identifier. This value is defined when the ship via code is created and cannot be changed.

Responses
200

Specified ship via codes has beed retreived successfully.

400

Invalid request.

401

The request could not be authorized.

500

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

get/api/v1/shipviacode/{code}
Request samples 
Response samples 
application/json
{
  • "id": "68b6bf44e10c804a9c1441df",
  • "code": "FEDEX-custom-code",
  • "subID": "sac4c3a",
  • "carrier": "FEDEX",
  • "carrierAccountId": "B9PZAR2QZzn01Xo",
  • "parcelType": "PKG",
  • "serviceId": "NDA",
  • "specialServices": [
    ],
  • "residential": false,
  • "insertTimestamp": "2025-09-02T09:56:20.851Z",
  • "updateTimestamp": "0001-01-01T00:00:00Z",
  • "createdBy": "0oa2fok3669kX7can0h8",
  • "archived": false
}