Update Ship Via Code

Request

This operation Updates the configuration for the specified ship via code.
The ship via code itself cannot be changed. If provided in the body, it will be ignored.

Security

bearerAuth

Path

codestringrequired

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

Bodyapplication/jsonrequired

carrierstringrequired

Carrier name associated with the custom configuration.

Example:"FEDEX"

carrierAccountIdstringrequired

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

Example:"xxxxxxxxxxx"

parcelTypestring

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

Example:"PKG"

parcelNamestring

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

Example:"Package"

serviceIdstring

Identifier of the shipping service to be used.

Example:"GRD"

serviceNamestring

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

Example:"Ground"

specialServicesArray of objects

List of special services applied to the ship via code.

curl -i -X PUT \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/shipviacode/{code}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrier": "FEDEX",
    "carrierAccountId": "xxxxxxxxxxx",
    "parcelType": "PKG",
    "parcelName": "Package",
    "serviceId": "GRD",
    "serviceName": "Ground",
    "specialServices": [
      {
        "specialServiceId": "INS",
        "inputParameters": [
          {
            "name": "INPUT_VALUE",
            "value": "101"
          }
        ],
        "fee": 0
      }
    ]
  }'

Responses

ship via code successfully updated.

Bodyapplication/json

codestring

The updated ship via code that can be used in Create Shipment API.

Example:"myups-test2"

Response

{
  "code": "myups-test2"
}