Get Ship via Code by Code

Request

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.

Security

bearerAuth

Path

codestringrequired

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

curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/shipviacode/{code}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Specified ship via codes has beed retreived successfully.

Bodyapplication/json

idstring

Unique identifier generated by the system for the ship via code.

Example:"68b6bf44e10c804a9c1441df"

codestring

Ship via code value.

Example:"FEDEX-custom-code"

subIDstring

Subscription ID associated with this ship via code.

Example:"sac4c3a"

carrierstring

Carrier name.

Example:"FEDEX"

carrierAccountIdstring

Unique identifier of the carrier account.

Example:"B9PZAR2QZzn01Xo"

parcelTypestring

Parcel type (e.g., PKG, LTR).

Example:"PKG"

serviceIdstring

Identifier of the service selected for the shipment.

Example:"NDA"

specialServicesArray of objects

List of special services applied to the ship via code.

residentialboolean

Example:false

insertTimestampstring, (date-time)

Timestamp when the entry was created.

Example:"2025-09-02T09:56:20.851Z"

updateTimestampstring, (date-time)

Timestamp when the entry was last updated.

Example:"0001-01-01T00:00:00Z"

createdBystring

User ID of the creator.

Example:"0oa2fok3669kX7can0h8"

archivedboolean

Indicates whether the record is archived.

Example:false

Response

{
  "id": "68b6bf44e10c804a9c1441df",
  "code": "FEDEX-custom-code",
  "subID": "sac4c3a",
  "carrier": "FEDEX",
  "carrierAccountId": "B9PZAR2QZzn01Xo",
  "parcelType": "PKG",
  "serviceId": "NDA",
  "specialServices": [
    {
      "specialServiceId": "INS",
      "inputParameters": [ … ],
      "fee": 0
    }
  ],
  "residential": false,
  "insertTimestamp": "2025-09-02T09:56:20.851Z",
  "updateTimestamp": "0001-01-01T00:00:00Z",
  "createdBy": "0oa2fok3669kX7can0h8",
  "archived": false
}