Get All Defaults

The operation fetches all created Defaults. If query parameters are not provided, it will consider default page as 1 and default size as 10.

SecuritybearerAuth

Request

query Parameters

page	string The page of the Defaults search result list.
size	string The size/count of the searched result list.

header Parameters

X-PB-Developer-Partner-ID

string

The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required.

Responses

200

List of Defaults.

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/defaults

Request samples

Response samples

application/json

{"pageInfo": {"total": 78,
"pages": 8,
"page": 1
},
"data": [{"defaultsResponse": {"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": "3010 Summer Street",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"company": "PB",
"email": "testuser@gmail.com",
"phone": "416 123-4567",
"cityTown": "OTTAWA",
"stateProvince": "ON",
"postalCode": "K1A0B2",
"inductionPostalCode": "06905",
"countryCode": "CA",
"residential": true
},
"parcel": {"length": 2,
"width": 1,
"height": 1,
"dimUnit": "IN",
"weightUnit": "OZ",
"weight": 2,
"packageValue": 2
}
}
}
}
]
}