@itentialopensource/adapter-pitney_bowes 0.1.1

package/pronghorn.json

@@ -0,0 +1,2918 @@
+{
+  "id": "@itentialopensource/adapter-pitney_bowes",
+  "type": "Adapter",
+  "export": "PitneyBowes",
+  "title": "Pitney_bowes",
+  "src": "adapter.js",
+  "roles": [
+    "admin"
+  ],
+  "methods": [
+    {
+      "name": "iapUpdateAdapterConfiguration",
+      "summary": "Updates the adapter configuration",
+      "description": "Updates the adapter configuration file with the provided changes",
+      "input": [
+        {
+          "name": "configFile",
+          "type": "string",
+          "info": "The name of the file to change",
+          "required": true,
+          "schema": {
+            "title": "configFile",
+            "type": "string"
+          }
+        },
+        {
+          "name": "changes",
+          "type": "object",
+          "info": "JSON object containing the configuration changes",
+          "required": true,
+          "schema": {
+            "title": "changes",
+            "type": "object"
+          }
+        },
+        {
+          "name": "entity",
+          "type": "string",
+          "info": "The entity in which the changes are being made",
+          "required": false,
+          "schema": {
+            "title": "entity",
+            "type": "string"
+          }
+        },
+        {
+          "name": "type",
+          "type": "string",
+          "info": "The type of file to change - action, schema, or mock",
+          "required": false,
+          "schema": {
+            "title": "type",
+            "type": "string"
+          }
+        },
+        {
+          "name": "action",
+          "type": "string",
+          "info": "The action to be changed",
+          "required": false,
+          "schema": {
+            "title": "action",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapUpdateAdapterConfiguration"
+      },
+      "task": true
+    },
+    {
+      "name": "iapFindAdapterPath",
+      "summary": "Provides the ability to see if a particular API path is supported by the adapter",
+      "description": "Provides the ability to see if a particular API path is supported by the adapter",
+      "input": [
+        {
+          "name": "apiPath",
+          "type": "string",
+          "info": "The API Path you want to check - make sure to not include base path and version",
+          "description": "The API Path you want to check - make sure to not include base path and version",
+          "schema": {
+            "title": "apiPath",
+            "type": "string"
+          },
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapFindAdapterPath"
+      },
+      "task": true
+    },
+    {
+      "name": "iapSuspendAdapter",
+      "summary": "Suspends the adapter",
+      "description": "Suspends the adapter",
+      "input": [
+        {
+          "name": "mode",
+          "type": "enum",
+          "enumerals": [
+            "pause",
+            "error"
+          ],
+          "info": "How incoming requests are handled. Defaults to 'pause'",
+          "description": "How incoming requests are handled. Defaults to 'pause'",
+          "schema": {
+            "title": "mode",
+            "type": "string"
+          },
+          "required": false
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapSuspendAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapUnsuspendAdapter",
+      "summary": "Unsuspends the adapter",
+      "description": "Unsuspends the adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapUnsuspendAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapGetAdapterQueue",
+      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
+      "description": "Return the requests that are waiting in the queue if throttling is enabled",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter queue",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapGetAdapterQueue"
+      },
+      "task": true
+    },
+    {
+      "name": "iapTroubleshootAdapter",
+      "summary": "Runs troubleshoot script for adapter",
+      "description": "Runs troubleshoot script for adapter",
+      "input": [
+        {
+          "name": "props",
+          "type": "object",
+          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
+          "required": true,
+          "schema": {
+            "title": "props",
+            "type": "object"
+          }
+        },
+        {
+          "name": "persistFlag",
+          "type": "boolean",
+          "info": "Whether the input properties should be saved",
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapTroubleshootAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterHealthcheck",
+      "summary": "Runs healthcheck script for adapter",
+      "description": "Runs healthcheck script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "Whether healthcheck passed or failed"
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterHealthcheck"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterConnectivity",
+      "summary": "Runs connectivity check script for adapter",
+      "description": "Runs connectivity check script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterConnectivity"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterBasicGet",
+      "summary": "Runs basicGet script for adapter",
+      "description": "Runs basicGet script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterBasicGet"
+      },
+      "task": true
+    },
+    {
+      "name": "iapMoveAdapterEntitiesToDB",
+      "summary": "Moves entities from an adapter into the IAP database",
+      "description": "Moves entities from an adapter into the IAP database",
+      "input": [],
+      "output": {
+        "name": "res",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
+        "schema": {
+          "title": "res",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapMoveAdapterEntitiesToDB"
+      },
+      "task": true
+    },
+    {
+      "name": "genericAdapterRequest",
+      "summary": "Makes the requested generic call",
+      "description": "Makes the requested generic call",
+      "input": [
+        {
+          "name": "uriPath",
+          "type": "string",
+          "info": "the path of the api call - do not include the host, port, base path or version",
+          "description": "the path of the api call",
+          "schema": {
+            "title": "uriPath",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "restMethod",
+          "type": "string",
+          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "schema": {
+            "title": "restMethod",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "the query parameters to be put on the url (optional)",
+          "description": "the query parameters to be put on the url (optional)",
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "requestBody",
+          "type": "object",
+          "info": "the payload to be sent with the request (optional)",
+          "description": "the payload to be sent with the request (optional)",
+          "schema": {
+            "title": "requestBody",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "addlHeaders",
+          "type": "object",
+          "info": "additional headers to be put on the call (optional)",
+          "description": "additional headers to be put on the call (optional)",
+          "schema": {
+            "title": "addlHeaders",
+            "type": "object"
+          },
+          "required": false
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/genericAdapterRequest"
+      },
+      "task": true
+    },
+    {
+      "name": "genericAdapterRequestNoBasePath",
+      "summary": "Makes the requested generic call",
+      "description": "Makes the requested generic call",
+      "input": [
+        {
+          "name": "uriPath",
+          "type": "string",
+          "info": "the path of the api call - do not include the host, port, base path or version",
+          "description": "the path of the api call",
+          "schema": {
+            "title": "uriPath",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "restMethod",
+          "type": "string",
+          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "schema": {
+            "title": "restMethod",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "the query parameters to be put on the url (optional)",
+          "description": "the query parameters to be put on the url (optional)",
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "requestBody",
+          "type": "object",
+          "info": "the payload to be sent with the request (optional)",
+          "description": "the payload to be sent with the request (optional)",
+          "schema": {
+            "title": "requestBody",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "addlHeaders",
+          "type": "object",
+          "info": "additional headers to be put on the call (optional)",
+          "description": "additional headers to be put on the call (optional)",
+          "schema": {
+            "title": "addlHeaders",
+            "type": "object"
+          },
+          "required": false
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/genericAdapterRequestNoBasePath"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevice",
+      "summary": "Get the Appliance",
+      "description": "Get the Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevice"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevicesFiltered",
+      "summary": "Get Appliances that match the filter",
+      "description": "Get Appliances that match the filter",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
+          "required": true,
+          "schema": {
+            "title": "options",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "array",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "array"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevicesFiltered"
+      },
+      "task": true
+    },
+    {
+      "name": "isAlive",
+      "summary": "Checks the status for the provided Appliance",
+      "description": "Checks the status for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/isAlive"
+      },
+      "task": true
+    },
+    {
+      "name": "getConfig",
+      "summary": "Gets a config for the provided Appliance",
+      "description": "Gets a config for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        },
+        {
+          "name": "format",
+          "type": "string",
+          "info": "The format to be returned - this is ignored as we always return json",
+          "required": false,
+          "schema": {
+            "title": "format",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getConfig"
+      },
+      "task": true
+    },
+    {
+      "name": "iapGetDeviceCount",
+      "summary": "Gets a device count from the system",
+      "description": "Gets a device count from the system",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapGetDeviceCount"
+      },
+      "task": true
+    },
+    {
+      "name": "oauthToken",
+      "summary": "oauthToken",
+      "description": "This API call generates the OAuth token based on the Base64-encoded value of the API key and secret associated with your PB Shipping APIs developer account. The token expires after 10 hours, after which you must create a new one.",
+      "input": [
+        {
+          "name": "grantType",
+          "type": "string",
+          "info": ": string",
+          "required": false,
+          "schema": {
+            "title": "grantType",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/oauthToken"
+      },
+      "task": true
+    },
+    {
+      "name": "getCarrierServiceRules",
+      "summary": "getCarrierServiceRules",
+      "description": "This operation retrieves the rules governing the carrier's services, including the available parcel types and the limits on weights and dimensions. **This API currently returns rules only for USPS** . Find more information at [Get Carrier Rules](https://shipping.pitneybowes.com/api/get-carrier-rules.html)",
+      "input": [
+        {
+          "name": "carrier",
+          "type": "string",
+          "info": "The carrier name. **Currently this must be set to: USPS**: ",
+          "required": true,
+          "schema": {
+            "title": "carrier",
+            "type": "string"
+          }
+        },
+        {
+          "name": "originCountryCode",
+          "type": "string",
+          "info": "The [two-character ISO country code](https://www.iso.org/obp/ui/#search) for the country where the shipment originates.: ",
+          "required": true,
+          "schema": {
+            "title": "originCountryCode",
+            "type": "string"
+          }
+        },
+        {
+          "name": "destinationCountryCode",
+          "type": "string",
+          "info": "The [two-character ISO country code](https://www.iso.org/obp/ui/#search) for the country of the shipment's destination address.: ",
+          "required": true,
+          "schema": {
+            "title": "destinationCountryCode",
+            "type": "string"
+          }
+        },
+        {
+          "name": "rateTypeId",
+          "type": "string",
+          "info": "The type of rate requested, such as COMMERCIAL_BASE. If a rate type is not specified, all eligible rate types are returned.: string",
+          "required": false,
+          "schema": {
+            "title": "rateTypeId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "futureShipmentDate",
+          "type": "string",
+          "info": "If the shipment is for a future date, and if a rate change is expected before the shipment date, use this field to ensure you get the correct rates and correct rate rules...(description truncated): string",
+          "required": false,
+          "schema": {
+            "title": "futureShipmentDate",
+            "type": "string"
+          }
+        },
+        {
+          "name": "returnShipment",
+          "type": "string",
+          "info": "If set to true, provides only services applicable for return shipment.: string",
+          "required": false,
+          "schema": {
+            "title": "returnShipment",
+            "type": "string"
+          }
+        },
+        {
+          "name": "compactResponse",
+          "type": "boolean",
+          "info": "If set to true, returns only summary, without special service details.: boolean",
+          "required": false,
+          "schema": {
+            "title": "compactResponse",
+            "type": "boolean"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getCarrierServiceRules"
+      },
+      "task": true
+    },
+    {
+      "name": "getCarrierLicenseAgreement",
+      "summary": "getCarrierLicenseAgreement",
+      "description": "This operation retrieves a carrier's license agreement. The operation is used in the [Carrier Registration Tutorial](https://shipping.pitneybowes.com/carrier-registration.html).",
+      "input": [
+        {
+          "name": "carrier",
+          "type": "string",
+          "info": "The carrier name. Currently this must be set to: UPS: ",
+          "required": true,
+          "schema": {
+            "title": "carrier",
+            "type": "string"
+          }
+        },
+        {
+          "name": "originCountryCode",
+          "type": "string",
+          "info": "The two-character ISO country code for the country where the shipment originates.: ",
+          "required": true,
+          "schema": {
+            "title": "originCountryCode",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "allOf": [
+            {
+              "title": "ShippingservicesV1CarrierLicenseAgreementsResponse",
+              "type": "object",
+              "properties": {
+                "licenseText": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "example": {
+                "licenseText": "<text>"
+              }
+            }
+          ]
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getCarrierLicenseAgreement"
+      },
+      "task": true
+    },
+    {
+      "name": "getCarrierSupportedDestination",
+      "summary": "getCarrierSupportedDestination",
+      "description": "This operation returns a list of supported destination countries to which the carrier offers international shipping services.",
+      "input": [
+        {
+          "name": "carrier",
+          "type": "string",
+          "info": "The carrier name. Currently this must be set to: USPS: ",
+          "required": true,
+          "schema": {
+            "title": "carrier",
+            "type": "string"
+          }
+        },
+        {
+          "name": "originCountryCode",
+          "type": "string",
+          "info": "The two-character ISO country code for the country where the shipment originates.: ",
+          "required": true,
+          "schema": {
+            "title": "originCountryCode",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getCarrierSupportedDestination"
+      },
+      "task": true
+    },
+    {
+      "name": "getCarrierFacilities",
+      "summary": "getCarrierFacilities",
+      "description": "This operation locates Post Offices and other facilities for a given carrier. You can use this operation, for example, to locate all USPS Post Offices near to a given postal code.If you use the Standard Return API and if you use the option to print a QR code, use this API to locate facilities where the buyer can print the label from the QR code.",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "example": {
+                  "address": {
+                    "addressLines": [
+                      "6525 Greenway Dr"
+                    ],
+                    "cityTown": "Roanoke",
+                    "stateProvince": "VA",
+                    "countryCode": "US"
+                  },
+                  "carrier": "USPS",
+                  "carrierFacilityOptions": [
+                    {
+                      "name": "FACILITY_TYPE_SERVICE",
+                      "value": "LABEL_BROKER_RETAIL"
+                    },
+                    {
+                      "name": "FACILITY_TYPE",
+                      "value": "POST_OFFICE"
+                    },
+                    {
+                      "name": "FACILITY_WITHIN_RADIUS",
+                      "value": "10"
+                    },
+                    {
+                      "name": "NUMBER_OF_FACILITIES",
+                      "value": "5"
+                    }
+                  ]
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getCarrierFacilities"
+      },
+      "task": true
+    },
+    {
+      "name": "rateParcel",
+      "summary": "rateParcel",
+      "description": "Use this operation to rate a parcel before you print and purchase a shipment label. You can rate a parcel for multiple services and multiple parcel types with a single API request.",
+      "input": [
+        {
+          "name": "xPBShipperRatePlan",
+          "type": "string",
+          "info": "Shipper rate plan, if applicable",
+          "required": false,
+          "schema": {
+            "title": "xPBShipperRatePlan",
+            "type": "string"
+          }
+        },
+        {
+          "name": "xPBIntegratorCarrierId",
+          "type": "string",
+          "info": "Negotiated services rate, if applicable.",
+          "required": false,
+          "schema": {
+            "title": "xPBIntegratorCarrierId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "xPBShipperCarrierAccountId",
+          "type": "string",
+          "info": "The unique identifier for the carrier account",
+          "required": false,
+          "schema": {
+            "title": "xPBShipperCarrierAccountId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "includeDeliveryCommitment",
+          "type": "boolean",
+          "info": "When set to true, returns estimated transit time in days.: boolean",
+          "required": false,
+          "schema": {
+            "title": "includeDeliveryCommitment",
+            "type": "boolean"
+          }
+        },
+        {
+          "name": "carrier",
+          "type": "string",
+          "info": "Cross-Border only. Required for PB Cross-Border. Set this to PBI.: string",
+          "required": false,
+          "schema": {
+            "title": "carrier",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Shipment request for Rates: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "Shipment request for Rates",
+                "example": {
+                  "fromAddress": {
+                    "company": "Supplier",
+                    "name": "J. Smith",
+                    "phone": "303-555-1213",
+                    "email": "js@example.com",
+                    "residential": false,
+                    "addressLines": [
+                      "4750 Walnut Street"
+                    ],
+                    "cityTown": "Boulder",
+                    "stateProvince": "CO",
+                    "postalCode": "80301",
+                    "countryCode": "US"
+                  },
+                  "toAddress": {
+                    "company": "Shop",
+                    "name": "J. Jones",
+                    "phone": "203-000-1234",
+                    "email": "jjones@example.com",
+                    "residential": false,
+                    "addressLines": [
+                      "771 Orange St"
+                    ],
+                    "cityTown": "New Haven",
+                    "stateProvince": "CT",
+                    "postalCode": "06511",
+                    "countryCode": "US"
+                  },
+                  "parcel": {
+                    "weight": {
+                      "weight": 1,
+                      "unitOfMeasurement": "OZ"
+                    },
+                    "dimension": {
+                      "length": 5,
+                      "width": 0.25,
+                      "height": 4,
+                      "unitOfMeasurement": "IN",
+                      "irregularParcelGirth": 1
+                    }
+                  },
+                  "rates": [
+                    {
+                      "carrier": "USPS",
+                      "parcelType": "PKG",
+                      "inductionPostalCode": "06484"
+                    }
+                  ]
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/rateParcel"
+      },
+      "task": true
+    },
+    {
+      "name": "createShipmentLabel",
+      "summary": "createShipmentLabel",
+      "description": "The API returns the label as either a Base64 string or a link to a PDF. For more information visit [Create Shipment Documents](https://shipping.pitneybowes.com/api/post-shipments.html). Following are samples of different carriers -\n\n* [Create a USPS (U.S. Postal Service) Label](https://shipping.pitneybowes.com/api/post-shipments-usps.html)\n\n* [Create a USPS PMOD Label](https://shipping.pitneybowes.com/api/post-shipments-pmod.html)\n* [Create a USPS Scan-Based Return Label](https://shipping.pitney...(description truncated)",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "xPBIntegratorCarrierId",
+          "type": "string",
+          "info": "Negotiated services rate",
+          "required": false,
+          "schema": {
+            "title": "xPBIntegratorCarrierId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "xPBShipperRatePlan",
+          "type": "string",
+          "info": "Shipper rate plan",
+          "required": false,
+          "schema": {
+            "title": "xPBShipperRatePlan",
+            "type": "string"
+          }
+        },
+        {
+          "name": "xPBShipmentGroupId",
+          "type": "string",
+          "info": "**[Required parameter for PBPresort service](https://shipping.pitneybowes.com/api/post-shipments-presort.html)**.The job number that represents the agreement between the merchant and PB Presort. This was provided by Pitney Bowes during [merchant onboarding for PB Presort](https://shipping.pitneybowes.com/carriers/pb-presort.html).",
+          "required": false,
+          "schema": {
+            "title": "xPBShipmentGroupId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "xPBShipperCarrierAccountId",
+          "type": "string",
+          "info": "**[Required parameter for PBPresort service](https://shipping.pitneybowes.com/api/post-shipments-presort.html)**. The merchant's Mailer ID (MID), as provided by Pitney Bowes during merchant onboarding for PB Presort.",
+          "required": false,
+          "schema": {
+            "title": "xPBShipperCarrierAccountId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "includeDeliveryCommitment",
+          "type": "string",
+          "info": "If set to true, returns estimated transit times in days. Only for USPS Create Shipment. See also [Pitney Bowes Delivery Guarantee](https://shipping.pitneybowes.com/faqs/d...(description truncated): string",
+          "required": false,
+          "schema": {
+            "title": "includeDeliveryCommitment",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "request: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "request"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/createShipmentLabel"
+      },
+      "task": true
+    },
+    {
+      "name": "retryShipment",
+      "summary": "retryShipment",
+      "description": "retryShipment",
+      "input": [
+        {
+          "name": "originalTransactionId",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "originalTransactionId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retryShipment"
+      },
+      "task": true
+    },
+    {
+      "name": "reprintShipment",
+      "summary": "reprintShipment",
+      "description": "reprintShipment",
+      "input": [
+        {
+          "name": "shipmentId",
+          "type": "string",
+          "info": "Required. The shipment ID that was issued when shipment label was generated.: string",
+          "required": true,
+          "schema": {
+            "title": "shipmentId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/reprintShipment"
+      },
+      "task": true
+    },
+    {
+      "name": "cancelShipment",
+      "summary": "cancelShipment",
+      "description": "cancelShipment",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "xPBShipperCarrierAccountId",
+          "type": "string",
+          "info": "The unique identifier returned in the shipperCarrierAccountId field by the [Register an Existing Carrier Account API.(https://shipping.pitneybowes.com/api/post-carrier-accounts-register.html)",
+          "required": false,
+          "schema": {
+            "title": "xPBShipperCarrierAccountId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "cancelInitiator",
+          "type": "string",
+          "info": "Indicates that this refund request is initiated by the shipper. Set this to: SHIPPER: string",
+          "required": false,
+          "schema": {
+            "title": "cancelInitiator",
+            "type": "string"
+          }
+        },
+        {
+          "name": "carrier",
+          "type": "string",
+          "info": "Conditional. The carrier. This is required if the carrier is not USPS: ",
+          "required": false,
+          "schema": {
+            "title": "carrier",
+            "type": "string"
+          }
+        },
+        {
+          "name": "shipmentId",
+          "type": "string",
+          "info": "shipmentId: string",
+          "required": true,
+          "schema": {
+            "title": "shipmentId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/cancelShipment"
+      },
+      "task": true
+    },
+    {
+      "name": "createManifest",
+      "summary": "createManifest",
+      "description": "This operation creates an end-of-day manifest that either combines all parcels into a single form or electronically closes the day, depending on the carrier. Use the instructions appropriate to the carrier.\n* Create a [USPS SCAN Form](https://shipping.pitneybowes.com/api/post-manifests-scan.html)\n\n* Create a [Newgistics Closeout](https://shipping.pitneybowes.com/api/post-manifests-newgistics.html)\n* Create a [PB Presort Pickup Slip](https://shipping.pitneybowes.com/api/post-manifests-presort.htm...(description truncated)",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "manifest: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "manifest"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/createManifest"
+      },
+      "task": true
+    },
+    {
+      "name": "retryManifest",
+      "summary": "retryManifest",
+      "description": "retryManifest",
+      "input": [
+        {
+          "name": "originalTransactionId",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "originalTransactionId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retryManifest"
+      },
+      "task": true
+    },
+    {
+      "name": "reprintManifest",
+      "summary": "reprintManifest",
+      "description": "reprintManifest",
+      "input": [
+        {
+          "name": "manifestId",
+          "type": "string",
+          "info": "manifestId: string",
+          "required": true,
+          "schema": {
+            "title": "manifestId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/reprintManifest"
+      },
+      "task": true
+    },
+    {
+      "name": "getTransactionReport",
+      "summary": "getTransactionReport",
+      "description": "This operation retrieves all transactions for a specified period of time.",
+      "input": [
+        {
+          "name": "developerId",
+          "type": "string",
+          "info": "developerId: string",
+          "required": true,
+          "schema": {
+            "title": "developerId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "fromDate",
+          "type": "string",
+          "info": "fromDate: string",
+          "required": false,
+          "schema": {
+            "title": "fromDate",
+            "type": "string"
+          }
+        },
+        {
+          "name": "shipDetails",
+          "type": "number",
+          "info": ": 123",
+          "required": false,
+          "schema": {
+            "title": "shipDetails",
+            "type": "number"
+          }
+        },
+        {
+          "name": "page",
+          "type": "number",
+          "info": ": 123",
+          "required": false,
+          "schema": {
+            "title": "page",
+            "type": "number"
+          }
+        },
+        {
+          "name": "size",
+          "type": "number",
+          "info": ": 123",
+          "required": false,
+          "schema": {
+            "title": "size",
+            "type": "number"
+          }
+        },
+        {
+          "name": "printStatus",
+          "type": "string",
+          "info": "printStatus: ",
+          "required": false,
+          "schema": {
+            "title": "printStatus",
+            "type": "string"
+          }
+        },
+        {
+          "name": "toDate",
+          "type": "string",
+          "info": "toDate: string",
+          "required": false,
+          "schema": {
+            "title": "toDate",
+            "type": "string"
+          }
+        },
+        {
+          "name": "transactionType",
+          "type": "string",
+          "info": "transactionType: ",
+          "required": false,
+          "schema": {
+            "title": "transactionType",
+            "type": "string"
+          }
+        },
+        {
+          "name": "merchantId",
+          "type": "string",
+          "info": "The value of the postalReportingNumber element in the [merchant object](https://shipping.pitneybowes.com/reference/resource-objects.html). This value is also the merchant...(description truncated): string",
+          "required": false,
+          "schema": {
+            "title": "merchantId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "sort",
+          "type": "string",
+          "info": "Defines a property to sort on and the sort order. Sort order can be ascending (asc) or descending (desc). Use the following form-\n\n* **sort= , ** For example-\n**sort=tran...(description truncated): string",
+          "required": false,
+          "schema": {
+            "title": "sort",
+            "type": "string"
+          }
+        },
+        {
+          "name": "parcelTrackingNumber",
+          "type": "string",
+          "info": "Parcel tracking number of the shipment.: string",
+          "required": false,
+          "schema": {
+            "title": "parcelTrackingNumber",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getTransactionReport"
+      },
+      "task": true
+    },
+    {
+      "name": "getPickupschedule",
+      "summary": "getPickupschedule",
+      "description": "This operation schedules a USPS package pickup from a residential or commercial location and provides a pickup confirmation number.",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Schedule Pickup request.: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "Schedule Pickup request."
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getPickupschedule"
+      },
+      "task": true
+    },
+    {
+      "name": "cancelPickup",
+      "summary": "cancelPickup",
+      "description": "This operation schedules a USPS package pickup from a residential or commercial location and provides a pickup confirmation number.",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "pickupId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters: string",
+          "required": true,
+          "schema": {
+            "title": "pickupId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/cancelPickup"
+      },
+      "task": true
+    },
+    {
+      "name": "verifyAddress",
+      "summary": "verifyAddress",
+      "description": "Address validation verifies and cleanses postal addresses within the United States to help ensure packages are rated accurately and shipments arrive at their final destinations on time.",
+      "input": [
+        {
+          "name": "minimalAddressValidation",
+          "type": "boolean",
+          "info": "When set to true, the complete address (delivery line and last line) is validated but only the last line (city, state, and postal code) would be changed by the validation...(description truncated): boolean",
+          "required": false,
+          "schema": {
+            "title": "minimalAddressValidation",
+            "type": "boolean"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Address object that needs to be validated.: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "Address object that needs to be validated."
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/verifyAddress"
+      },
+      "task": true
+    },
+    {
+      "name": "verifyAndSuggestAddress",
+      "summary": "verifyAndSuggestAddress",
+      "description": "This operation returns suggested addresses. Use this if the [Address Validation API](https://shipping.pitneybowes.com/api/post-address-verify.html) call has returned an error.",
+      "input": [
+        {
+          "name": "returnSuggestions",
+          "type": "string",
+          "info": "To return suggested addresses, set this to true.: string",
+          "required": true,
+          "schema": {
+            "title": "returnSuggestions",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Address object that needs to be validated.: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "Address object that needs to be validated."
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/verifyAndSuggestAddress"
+      },
+      "task": true
+    },
+    {
+      "name": "getParcelProtectionQuote",
+      "summary": "getParcelProtectionQuote",
+      "description": "This API provides a quote for covering a shipment through Pitney Bowes [Parcel Protection](https://www.pitneybowes.com/us/ecommerce-delivery-services/parcel-protection.html).",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "manifest: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "manifest",
+                "example": {
+                  "shipmentInfo": {
+                    "carrier": "USPS",
+                    "serviceId": "PM",
+                    "insuranceCoverageValue": 1000,
+                    "insuranceCoverageValueCurrency": "USD",
+                    "parcelInfo": {
+                      "commodityList": [
+                        {
+                          "categoryPath": "electronics",
+                          "itemCode": "SKU1084",
+                          "name": "Laptop",
+                          "url": "https://example.com/computers/laptop/1084"
+                        }
+                      ]
+                    },
+                    "shipperInfo": {
+                      "shipperID": "9024324564",
+                      "address": {
+                        "addressLines": [
+                          "545 Market St"
+                        ],
+                        "cityTown": "San Francisco",
+                        "stateProvince": "CA",
+                        "postalCode": "94105-2847",
+                        "countryCode": "US"
+                      }
+                    },
+                    "consigneeInfo": {
+                      "address": {
+                        "addressLines": [
+                          "284 W Fulton"
+                        ],
+                        "cityTown": "Garden City",
+                        "stateProvince": "KS",
+                        "postalCode": "67846",
+                        "countryCode": "US"
+                      }
+                    }
+                  }
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "allOf": [
+            {
+              "title": "ParcelProtectionQuoteResponse",
+              "required": [
+                "parcelProtectionFees",
+                "parcelProtectionFeesCurrencyCode",
+                "parcelProtectionFeesBreakup"
+              ],
+              "type": "object",
+              "properties": {
+                "parcelProtectionFees": {
+                  "type": "number"
+                },
+                "parcelProtectionFeesCurrencyCode": {
+                  "type": "string"
+                },
+                "parcelProtectionFeesBreakup": {
+                  "title": "ParcelProtectionFeesBreakup",
+                  "required": [
+                    "basePremium",
+                    "technologyFee"
+                  ],
+                  "type": "object",
+                  "properties": {
+                    "basePremium": {
+                      "type": "number"
+                    },
+                    "technologyFee": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            },
+            {
+              "example": {
+                "parcelProtectionFees": 7.5,
+                "parcelProtectionFeesCurrencyCode": "USD",
+                "parcelProtectionFeesBreakup": {
+                  "basePremium": 7.25,
+                  "technologyFee": 0.25
+                }
+              }
+            }
+          ]
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getParcelProtectionQuote"
+      },
+      "task": true
+    },
+    {
+      "name": "getParcelProtectionCoverage",
+      "summary": "getParcelProtectionCoverage",
+      "description": "This API lets merchants request Pitney Bowes [Parcel Protection](https://shipping.pitneybowes.com/faqs/parcel-protection.html) coverage for shipments. Merchants can request coverage for shipments created with the Shipping APIs as well as for shipments created with other platforms.",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "manifest: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "manifest",
+                "example": {
+                  "shipmentInfo": {
+                    "trackingNumber": "940509898641491871138",
+                    "carrier": "USPS",
+                    "serviceId": "PM",
+                    "insuranceCoverageValue": 1000,
+                    "insuranceCoverageValueCurrency": "USD",
+                    "parcelInfo": {
+                      "commodityList": [
+                        {
+                          "categoryPath": "electronics",
+                          "itemCode": "SKU1084",
+                          "name": "Laptop",
+                          "url": "https://example.com/computers/laptop/1084"
+                        }
+                      ]
+                    },
+                    "shipperInfo": {
+                      "shipperID": "9024324564",
+                      "address": {
+                        "addressLines": [
+                          "545 Market St"
+                        ],
+                        "cityTown": "San Francisco",
+                        "stateProvince": "CA",
+                        "postalCode": "94105-2847",
+                        "countryCode": "US"
+                      },
+                      "companyName": "Supplies",
+                      "givenName": "John",
+                      "middleName": "James",
+                      "familyName": "Smith",
+                      "email": "john@example.com",
+                      "phoneNumbers": [
+                        {
+                          "number": "1234567890",
+                          "type": "business phone"
+                        }
+                      ]
+                    },
+                    "consigneeInfo": {
+                      "address": {
+                        "addressLines": [
+                          "284 W Fulton"
+                        ],
+                        "cityTown": "Garden City",
+                        "stateProvince": "KS",
+                        "postalCode": "67846",
+                        "countryCode": "US"
+                      },
+                      "companyName": "Shop",
+                      "givenName": "Mary",
+                      "middleName": "Anne",
+                      "familyName": "Jones",
+                      "email": "mary@example.com",
+                      "phoneNumbers": [
+                        {
+                          "number": "6205551234",
+                          "type": "business phone"
+                        },
+                        {
+                          "number": "6205554321",
+                          "type": "fax"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "allOf": [
+            {
+              "title": "ParcelProtectionCreateResponse",
+              "type": "object",
+              "properties": {
+                "transactionID": {
+                  "type": "string"
+                },
+                "parcelProtectionReferenceID": {
+                  "type": "string"
+                },
+                "parcelProtectionDate": {
+                  "type": "string"
+                },
+                "parcelProtectionFees": {
+                  "type": "number"
+                },
+                "parcelProtectionFeesCurrencyCode": {
+                  "type": "string"
+                },
+                "parcelProtectionFeesBreakup": {
+                  "title": "ParcelProtectionFeesBreakup1",
+                  "type": "object",
+                  "properties": {
+                    "basePremium": {
+                      "type": "number"
+                    },
+                    "technologyFee": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            },
+            {
+              "example": {
+                "transactionID": "44397664_ABCD1234_28d6fb80-6b92-4e69-b5bb-6656a00ce435",
+                "parcelProtectionReferenceID": "IPPOL0000000012345678",
+                "parcelProtectionDate": "2019-05-20 15:00:25.279+0000",
+                "parcelProtectionFees": 7.5,
+                "parcelProtectionFeesCurrencyCode": "USD",
+                "parcelProtectionFeesBreakup": {
+                  "basePremium": 7.25,
+                  "technologyFee": 0.25
+                }
+              }
+            }
+          ]
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getParcelProtectionCoverage"
+      },
+      "task": true
+    },
+    {
+      "name": "cancelParcelProtection",
+      "summary": "cancelParcelProtection",
+      "description": "This API lets merchants request Pitney Bowes [Parcel Protection](https://shipping.pitneybowes.com/faqs/parcel-protection.html) coverage for shipments. Merchants can request coverage for shipments created with the Shipping APIs as well as for shipments created with other platforms.",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "parcelProtectionReferenceId",
+          "type": "string",
+          "info": "Required. The identifier for the PB Parcel Protection policy that is being voided.: string",
+          "required": true,
+          "schema": {
+            "title": "parcelProtectionReferenceId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "manifest: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "manifest",
+                "example": {
+                  "shipperID": "9024324564",
+                  "parcelProtectionAccountID": "IPACT2345678"
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "allOf": [
+            {
+              "title": "VoidParcelProtectionResponse",
+              "type": "object",
+              "properties": {
+                "status": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "example": {
+                "status": "Void_Success"
+              }
+            }
+          ]
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/cancelParcelProtection"
+      },
+      "task": true
+    },
+    {
+      "name": "getParcelProtectionReports",
+      "summary": "getParcelProtectionReports",
+      "description": "This operation retrieves the policy status and other information on the Parcel Protection policies you have purchased for your shipments. Further Details https://shipping.pitneybowes.com/api/get-parcel-protection-reports.html",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "developerId",
+          "type": "string",
+          "info": "Required. Your Pitney Bowes developer ID.: string",
+          "required": true,
+          "schema": {
+            "title": "developerId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "policyCreatedFromDate",
+          "type": "string",
+          "info": "The beginning of the date range. Specify this value in UTC using the ISO 8601 standard. You must include both date and time, and you must end the time with Z to indicate ...(description truncated): string",
+          "required": true,
+          "schema": {
+            "title": "policyCreatedFromDate",
+            "type": "string"
+          }
+        },
+        {
+          "name": "policyCreatedToDate",
+          "type": "string",
+          "info": "The end of the date range. Specify this value in UTC using the ISO 8601 standard. You must include both date and time, and you must end the time with Z to indicate a zero...(description truncated): string",
+          "required": false,
+          "schema": {
+            "title": "policyCreatedToDate",
+            "type": "string"
+          }
+        },
+        {
+          "name": "policyReferenceId",
+          "type": "string",
+          "info": "The unique identifier for the PB Parcel Protection policy.].: string",
+          "required": false,
+          "schema": {
+            "title": "policyReferenceId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "parcelTrackingNumber",
+          "type": "string",
+          "info": "The parcel tracking number of the shipment that the policy applies to.: string",
+          "required": false,
+          "schema": {
+            "title": "parcelTrackingNumber",
+            "type": "string"
+          }
+        },
+        {
+          "name": "merchantId",
+          "type": "string",
+          "info": "The merchant's Shipper ID. This is the value of the postalReportingNumber element in the Merchant Object.: string",
+          "required": false,
+          "schema": {
+            "title": "merchantId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "policyStatus",
+          "type": "string",
+          "info": "Whether the policy is active or voided.: string",
+          "required": false,
+          "schema": {
+            "title": "policyStatus",
+            "type": "string"
+          }
+        },
+        {
+          "name": "size",
+          "type": "string",
+          "info": "The number of transactions to return per page in the result set.: string",
+          "required": false,
+          "schema": {
+            "title": "size",
+            "type": "string"
+          }
+        },
+        {
+          "name": "page",
+          "type": "string",
+          "info": "The index number of the page to return. Page index numbering starts at 0. Specifying page=0 returns the first page of the result set.: string",
+          "required": false,
+          "schema": {
+            "title": "page",
+            "type": "string"
+          }
+        },
+        {
+          "name": "sort",
+          "type": "string",
+          "info": "Defines a property to sort on and the sort order. Sort order can be ascending (asc) or descending (desc).: string",
+          "required": false,
+          "schema": {
+            "title": "sort",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getParcelProtectionReports"
+      },
+      "task": true
+    },
+    {
+      "name": "getTrackingDetails",
+      "summary": "getTrackingDetails",
+      "description": "getTrackingDetails",
+      "input": [
+        {
+          "name": "trackingNumber",
+          "type": "string",
+          "info": "The tracking number for the shipment.: string",
+          "required": true,
+          "schema": {
+            "title": "trackingNumber",
+            "type": "string"
+          }
+        },
+        {
+          "name": "packageIdentifierType",
+          "type": "string",
+          "info": "packageIdentifierType: string",
+          "required": true,
+          "schema": {
+            "title": "packageIdentifierType",
+            "type": "string"
+          }
+        },
+        {
+          "name": "carrier",
+          "type": "string",
+          "info": "carrier: ",
+          "required": true,
+          "schema": {
+            "title": "carrier",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getTrackingDetails"
+      },
+      "task": true
+    },
+    {
+      "name": "addTrackingEvents",
+      "summary": "addTrackingEvents",
+      "description": "getTrackingDetails",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "add track event: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "add track event",
+                "example": {
+                  "carrier": "NEWGISTICS",
+                  "references": [
+                    {
+                      "referenceType": "package",
+                      "referenceValue": "1Z00",
+                      "events": [
+                        {
+                          "eventCode": "DPB",
+                          "carrierEventCode": "DOAC",
+                          "eventDate": "2020-04-18",
+                          "eventTime": "12:48:10",
+                          "eventTimeOffset": "-06:00",
+                          "eventCity": "Decatur",
+                          "eventStateOrProvince": "IL",
+                          "postalCode": "62521",
+                          "country": "US"
+                        }
+                      ]
+                    },
+                    {
+                      "referenceType": "package",
+                      "referenceValue": "3Z30",
+                      "events": [
+                        {
+                          "eventCode": "DPB",
+                          "carrierEventCode": "DOAC",
+                          "eventDate": "2020-04-18",
+                          "eventTime": "12:50:00",
+                          "eventTimeOffset": "-06:00",
+                          "eventCity": "Decatur",
+                          "eventStateOrProvince": "IL",
+                          "postalCode": "62521",
+                          "country": "US"
+                        }
+                      ]
+                    }
+                  ]
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "allOf": [
+            {
+              "title": "VoidParcelProtectionResponse",
+              "type": "object",
+              "properties": {
+                "status": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "example": {
+                "status": "success"
+              }
+            }
+          ]
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/addTrackingEvents"
+      },
+      "task": true
+    },
+    {
+      "name": "getCrossBorderQuotes",
+      "summary": "getCrossBorderQuotes",
+      "description": "This operation provides an estimate of the duties, taxes, and transportation costs for the items in a buyer's online shopping basket. The API calculates how many separate parcels are required to ship the items and estimates costs. The API checks each item's eligibility to clear customs and returns the quote for eligible items. To look for futher info please look into [Cross-Border Quotes](https://shipping.pitneybowes.com/api/post-quotes.html#)",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "example": {
+                  "quoteCurrency": "USD",
+                  "basketCurrency": "USD",
+                  "fromAddress": {
+                    "name": "John Smith",
+                    "residential": false,
+                    "company": "Supplies",
+                    "addressLines": [
+                      "545 Market St"
+                    ],
+                    "cityTown": "San Francisco",
+                    "stateProvince": "CA",
+                    "postalCode": "94105",
+                    "countryCode": "US",
+                    "email": "john@example.com",
+                    "phone": "415-555-0000"
+                  },
+                  "toAddress": {
+                    "name": "Jan Jones",
+                    "residential": true,
+                    "addressLines": [
+                      "2168 King St N"
+                    ],
+                    "cityTown": "Waterloo",
+                    "stateProvince": "ON",
+                    "postalCode": "N2J 4G8",
+                    "countryCode": "CA",
+                    "email": "jan@example.com",
+                    "phone": "519-555-0000"
+                  },
+                  "basketItems": [
+                    {
+                      "brand": "",
+                      "categories": [
+                        {
+                          "categoryCode": "UNKNOWN",
+                          "descriptions": [
+                            {
+                              "locale": "en",
+                              "name": "Dress",
+                              "parentsNames": [
+                                "Clothing",
+                                "Women"
+                              ]
+                            }
+                          ],
+                          "parentCategoryCode": "6543",
+                          "url": "www.example.com"
+                        }
+                      ],
+                      "description": "Red Embroidered",
+                      "eccn": "EAR99",
+                      "hazmats": [
+                        "hazmat",
+                        "ormd"
+                      ],
+                      "hSTariffCode": "4203100001",
+                      "hSTariffCodeCountry": "AU",
+                      "identifiers": [
+                        {
+                          "number": "123456",
+                          "source": "isbn"
+                        }
+                      ],
+                      "imageUrls": [
+                        "www.example.com"
+                      ],
+                      "itemDimension": {
+                        "length": 11,
+                        "height": 8.5,
+                        "width": 5,
+                        "unitOfMeasurement": "IN"
+                      },
+                      "itemId": "G_123456",
+                      "manufacturer": "",
+                      "originCountryCode": "CN",
+                      "pricing": {
+                        "price": 20,
+                        "codPrice": [
+                          {
+                            "price": 20,
+                            "cod": "CA",
+                            "includesDuty": false,
+                            "includesTaxes": false
+                          }
+                        ],
+                        "dutiableValue": 20
+                      },
+                      "quantity": 2,
+                      "unitPrice": 19.99,
+                      "unitWeight": {
+                        "weight": 5,
+                        "unitOfMeasurement": "lb"
+                      },
+                      "url": "http://www.example.com/products/160921_030"
+                    }
+                  ],
+                  "rates": [
+                    {
+                      "carrier": "PBI",
+                      "serviceId": "PBXPS"
+                    }
+                  ],
+                  "shipmentOptions": [
+                    {
+                      "name": "SHIPPER_ID",
+                      "value": "9024324564"
+                    },
+                    {
+                      "name": "CLIENT_ID",
+                      "value": "789123"
+                    },
+                    {
+                      "name": "CARRIER_FACILITY_ID",
+                      "value": "US_ELOVATIONS_KY"
+                    }
+                  ]
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "allOf": [
+            {
+              "title": "CrossBorderQuotesResponse",
+              "type": "object",
+              "properties": {
+                "quote": {
+                  "type": "array",
+                  "items": {
+                    "title": "Quote",
+                    "type": "object",
+                    "properties": {
+                      "quoteCurrency": {
+                        "type": "string"
+                      },
+                      "quoteLines": {
+                        "type": "array",
+                        "items": {
+                          "title": "QuoteLine",
+                          "type": "object",
+                          "properties": {
+                            "lineId": {
+                              "type": "string"
+                            },
+                            "itemId": {
+                              "type": "string"
+                            },
+                            "quoteLineId": {
+                              "type": "string"
+                            },
+                            "quantity": {
+                              "type": "integer"
+                            },
+                            "unitRates": {
+                              "title": "UnitRates",
+                              "type": "object",
+                              "properties": {
+                                "unitPrice": {
+                                  "type": "number"
+                                },
+                                "totalTaxAmount": {
+                                  "type": "number"
+                                },
+                                "totalDutyAmount": {
+                                  "type": "integer"
+                                },
+                                "serviceId": {
+                                  "type": "string"
+                                },
+                                "baseCharge": {
+                                  "type": "number"
+                                },
+                                "deliveryCommitment": {
+                                  "title": "DeliveryCommitment1",
+                                  "type": "object",
+                                  "properties": {
+                                    "minEstimatedNumberOfDays": {
+                                      "type": "integer"
+                                    },
+                                    "maxEstimatedNumberOfDays": {
+                                      "type": "integer"
+                                    }
+                                  }
+                                },
+                                "totalCarrierCharge": {
+                                  "type": "number"
+                                }
+                              }
+                            },
+                            "lineRates": {
+                              "title": "LineRates",
+                              "type": "object",
+                              "properties": {
+                                "linePrice": {
+                                  "type": "number"
+                                },
+                                "totalTaxAmount": {
+                                  "type": "number"
+                                },
+                                "totalDutyAmount": {
+                                  "type": "integer"
+                                },
+                                "serviceId": {
+                                  "type": "string"
+                                },
+                                "baseCharge": {
+                                  "type": "number"
+                                },
+                                "deliveryCommitment": {
+                                  "title": "DeliveryCommitment1",
+                                  "type": "object",
+                                  "properties": {
+                                    "minEstimatedNumberOfDays": {
+                                      "type": "integer"
+                                    },
+                                    "maxEstimatedNumberOfDays": {
+                                      "type": "integer"
+                                    }
+                                  }
+                                },
+                                "totalCarrierCharge": {
+                                  "type": "number"
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "description": ""
+                      },
+                      "totalPrice": {
+                        "type": "number"
+                      },
+                      "totalRates": {
+                        "title": "TotalRates",
+                        "type": "object",
+                        "properties": {
+                          "serviceId": {
+                            "type": "string"
+                          },
+                          "baseCharge": {
+                            "type": "number"
+                          },
+                          "deliveryCommitment": {
+                            "title": "DeliveryCommitment1",
+                            "type": "object",
+                            "properties": {
+                              "minEstimatedNumberOfDays": {
+                                "type": "integer"
+                              },
+                              "maxEstimatedNumberOfDays": {
+                                "type": "integer"
+                              }
+                            }
+                          },
+                          "totalCarrierCharge": {
+                            "type": "number"
+                          },
+                          "totalDutyAmount": {
+                            "type": "integer"
+                          },
+                          "totalTaxAmount": {
+                            "type": "number"
+                          }
+                        }
+                      }
+                    }
+                  },
+                  "description": ""
+                }
+              }
+            },
+            {
+              "example": {
+                "quote": [
+                  {
+                    "quoteCurrency": "USD",
+                    "quoteLines": [
+                      {
+                        "lineId": "1",
+                        "itemId": "G_123456",
+                        "quoteLineId": "1",
+                        "quantity": 2,
+                        "unitRates": {
+                          "unitPrice": 19.99,
+                          "totalTaxAmount": 3.12,
+                          "totalDutyAmount": 4,
+                          "serviceId": "PBXPS",
+                          "baseCharge": 23.62,
+                          "deliveryCommitment": {
+                            "minEstimatedNumberOfDays": 3,
+                            "maxEstimatedNumberOfDays": 6
+                          },
+                          "totalCarrierCharge": 30.74
+                        },
+                        "lineRates": {
+                          "linePrice": 39.98,
+                          "totalTaxAmount": 6.24,
+                          "totalDutyAmount": 8,
+                          "serviceId": "PBXPS",
+                          "baseCharge": 47.24,
+                          "deliveryCommitment": {
+                            "minEstimatedNumberOfDays": 3,
+                            "maxEstimatedNumberOfDays": 6
+                          },
+                          "totalCarrierCharge": 61.48
+                        }
+                      }
+                    ],
+                    "totalPrice": 39.98,
+                    "totalRates": {
+                      "serviceId": "PBXPS",
+                      "baseCharge": 47.24,
+                      "deliveryCommitment": {
+                        "minEstimatedNumberOfDays": 3,
+                        "maxEstimatedNumberOfDays": 6
+                      },
+                      "totalCarrierCharge": 61.48,
+                      "totalDutyAmount": 8,
+                      "totalTaxAmount": 6.24
+                    }
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getCrossBorderQuotes"
+      },
+      "task": true
+    },
+    {
+      "name": "predictedHSCode",
+      "summary": "PredictedHSCode",
+      "description": "This operation predicts the HS Code for a parcel being shipped internationally and gives the level of confidence in the prediction.",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "manifest: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "manifest"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/predictedHSCode"
+      },
+      "task": true
+    },
+    {
+      "name": "getContainerizedParcelsLabels",
+      "summary": "getContainerizedParcelsLabels",
+      "description": "This operation prints a label for the shipment of containerized parcels destined for a Pitney Bowes warehouse facility from the client location.",
+      "input": [
+        {
+          "name": "xPBTransactionId",
+          "type": "string",
+          "info": "A unique identifier for the transaction, up to 25 characters.",
+          "required": true,
+          "schema": {
+            "title": "xPBTransactionId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "manifest: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "manifest"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getContainerizedParcelsLabels"
+      },
+      "task": true
+    }
+  ],
+  "views": []
+}