Get Defaults By ID

Request

This operation fetches the values set for the Defaults.

Security

bearerAuth

Path

defaultIDstringrequired

This is unique identifier assigned to Defaults while its creation using CreateDefaults API.

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

Responses

Defaults values have been retrieved successfully.

Bodyapplication/json

namestring

Name of the created Default. For example: Domestic.

Example:"Domestic"

defaultIDstring

Unique identifier assigned to the Default while its creation using CreateDefaults API.

Example:"0d4f3c51-059b-4c28-a83b-a8defa2962cc"

createdDatestring

The timestamp when the Default is created.

Example:"2024-08-06T06:12:46.258Z"

updatedDatestring

The timestamp when the Default is updated.

Example:"2024-08-06T06:12:46.258Z"

sendingOptionsobject(sendingOptionsResponse)

Sending Options includes used carrier related details, sender details, and parcel details.

Response

{
  "name": "Domestic",
  "defaultID": "0d4f3c51-059b-4c28-a83b-a8defa2962cc",
  "createdDate": "2024-08-06T06:12:46.258Z",
  "updatedDate": "2024-08-06T06:12:46.258Z",
  "sendingOptions": {
    "carrier": "FedEx",
    "service": "2DA",
    "carrierAccounts": {
      "USPS": "JYKEb4VQvoVx!",
      "FEDEX": "WRF4VFUUJDx!"
    },
    "labelSize": "DOC_4X6",
    "labelType": "SHIPPING_LABEL",
    "labelFormat": "PDF",
    "fromAddress": {
      "name": "Sender Name",
      "addressLine1": "1600 Amphitheatre Parkway",
      "addressLine2": "near abc street",
      "addressLine3": "near xyz street",
      "company": "PB",
      "email": "testuser@gmail.com",
      "phone": "6502530000",
      "cityTown": "Mountain View",
      "stateProvince": "CA",
      "postalCode": "94043",
      "inductionPostalCode": "06905",
      "countryCode": "US",
      "residential": true
    },
    "altReturnAddress": {
      "addressLine1": "500 Terry Francois Blvd",
      "addressLine2": "near abc street",
      "addressLine3": "near xyz street",
      "company": "PB",
      "email": "user@email.com",
      "residential": true,
      "cityTown": "San Francisco",
      "countryCode": "US",
      "name": "User Name",
      "phone": "415-555-7890",
      "postalCode": "94158",
      "stateProvince": "CA"
    },
    "parcel": {
      "length": 2,
      "width": 1,
      "height": 1,
      "dimUnit": "IN",
      "weightUnit": "OZ",
      "weight": 2,
      "packageValue": 2
    }
  }
}