{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/openapi/receiving/operation/searchPackages/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/openapi/receiving/operation/searchPackages/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"Receiving APIs\",\"description\":\"\",\"version\":\"1.0.0\"},\"servers\":[{\"url\":\"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack\",\"description\":\"Sandbox Server\"},{\"url\":\"https://api.sendpro360.pitneybowes.com/pitneytrack\",\"description\":\"Production Server (uses live data)\"}],\"tags\":[{\"name\":\"Decode\"},{\"name\":\"Packages\"},{\"name\":\"Carrier\"},{\"name\":\"Inbound sites\"}],\"paths\":{\"/api/v1/packages/tracking/decode\":{\"get\":{\"tags\":[\"Decode\"],\"summary\":\"Decode Tracking Number\",\"description\":\"This operation decodes a tracking number from a barcode, extracting package details like carrier information, receiver Id, and package type. It supports 2D barcodes.\",\"operationId\":\"decodeTrackingNumber\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"trackingNumber\",\"in\":\"query\",\"required\":true,\"schema\":{\"type\":\"number\",\"description\":\"The tracking numebr to be decoded.\"},\"example\":\"PB4OZAWWNPBG\"},{\"name\":\"expectedPackage\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"description\":\"Indicates if the decoded asset is part of an expected package. Set to 'true' for expected packages.\"},\"example\":\"true\"},{\"name\":\"editflow\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"description\":\"\"},\"example\":false}],\"responses\":{\"200\":{\"description\":\"Successful response containing decoded tracking details and package information.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetResponseDTO\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/trackingNumbers\":{\"post\":{\"tags\":[\"Packages\"],\"summary\":\"Generate Tracking Number\",\"description\":\"This API generates a unique tracking number required to add a package.These numbers serve as identifiers for packages throughout their lifecycle. <br> Use this API when a package does not already have a tracking number.\",\"operationId\":\"createTrackingNumber\",\"security\":[{\"bearerAuth\":[]}],\"responses\":{\"200\":{\"description\":\"A unique tracking number has been generated successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"trackingNumber\":{\"type\":\"string\",\"description\":\"This is the generated tracking number.\",\"example\":\"PBGWPV69YBKNY\"}}}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/packages/images\":{\"post\":{\"tags\":[\"Packages\"],\"summary\":\"Create Image\",\"description\":\"This operation creates an image and provides details about the created image. The image data must be provided in Base64 format in the request body.\",\"operationId\":\"createImage\",\"parameters\":[{\"name\":\"Content-Type\",\"in\":\"header\",\"schema\":{\"type\":\"string\"},\"example\":\"application/json\",\"required\":false}],\"security\":[{\"bearerAuth\":[]}],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"base64\":{\"type\":\"string\",\"description\":\"This is the image data must be provided in Base64 format.\",\"example\":\"data:image/gif;base64,R0lGODlhPQBEAPeoAJosM//AwO/AwHVYZ/z595kzAP/s7P+goOXMv8+fhw/v739/f+8PD98fH/8mJl+fn/9ZWb8/PzWlwv///6wWGbImAPgTEMImIN9gUFCEm/gDALULDN8PAD6atYdCTX9gUNKlj8wZAKUsAOzZz+UMAOsJAP/Z2ccMDA8PD/95eX5NWvsJCOVNQPtfX/8zM8+QePLl38MGBr8JCP+zs9myn/8GBqwpAP/GxgwJCPny78lzYLgjAJ8vAP9fX/+MjMUcAN8zM/9wcM8ZGcATEL+QePdZWf/29uc/P9cmJu9MTDImIN+/r7+/vz8/P8VNQGNugV8AAF9fX8swMNgTAFlDOICAgPNSUnNWSMQ5MBAQEJE3QPIGAM9AQMqGcG9vb6MhJsEdGM8vLx8fH98AANIWAMuQeL8fABkTEPPQ0OM5OSYdGFl5jo+Pj/+pqcsTE78wMFNGQLYmID4dGPvd3UBAQJmTkP+8vH9QUK+vr8ZWSHpzcJMmILdwcLOGcHRQUHxwcK9PT9DQ0O/v70w5MLypoG8wKOuwsP/g4P/Q0IcwKEswKMl8aJ9fX2xjdOtGRs/Pz+Dg4GImIP8gIH0sKEAwKKmTiKZ8aB/f39Wsl+LFt8dgUE9PT5x5aHBwcP+AgP+WltdgYMyZfyywz78AAAAAAAD///8AAP9mZv///wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAKgALAAAAAA9AEQAAAj/AFEJHEiwoMGDCBMqXMiwocAbBww4nEhxoYkUpzJGrMixogkfGUNqlNixJEIDB0SqHGmyJSojM1bKZOmyop0gM3Oe2liTISKMOoPy7GnwY9CjIYcSRYm0aVKSLmE6nfq05QycVLPuhDrxBlCtYJUqNAq2bNWEBj6ZXRuyxZyDRtqwnXvkhACDV+euTeJm1Ki7A73qNWtFiF+/gA95Gly2CJLDhwEHMOUAAuOpLYDEgBxZ4GRTlC1fDnpkM+fOqD6DDj1aZpITp0dtGCDhr+fVuCu3zlg49ijaokTZTo27uG7Gjn2P+hI8+PDPERoUB318bWbfAJ5sUNFcuGRTYUqV/3ogfXp1rWlMc6awJjiAAd2fm4ogXjz56aypOoIde4OE5u/F9x199dlXnnGiHZWEYbGpsAEA3QXYnHwEFliKAgswgJ8LPeiUXGwedCAKABACCN+EA1pYIIYaFlcDhytd51sGAJbo3onOpajiihlO92KHGaUXGwWjUBChjSPiWJuOO/LYIm4v1tXfE6J4gCSJEZ7YgRYUNrkji9P55sF/ogxw5ZkSqIDaZBV6aSGYq/lGZplndkckZ98xoICbTcIJGQAZcNmdmUc210hs35nCyJ58fgmIKX5RQGOZowxaZwYA+JaoKQwswGijBV4C6SiTUmpphMspJx9unX4KaimjDv9aaXOEBteBqmuuxgEHoLX6Kqx+yXqqBANsgCtit4FWQAEkrNbpq7HSOmtwag5w57GrmlJBASEU18ADjUYb3ADTinIttsgSB1oJFfA63bduimuqKB1keqwUhoCSK374wbujvOSu4QG6UvxBRydcpKsav++Ca6G8A6Pr1x2kVMyHwsVxUALDq/krnrhPSOzXG1lUTIoffqGR7Goi2MAxbv6O2kEG56I7CSlRsEFKFVyovDJoIRTg7sugNRDGqCJzJgcKE0ywc0ELm6KBCCJo8DIPFeCWNGcyqNFE06ToAfV0HBRgxsvLThHn1oddQMrXj5DyAQgjEHSAJMWZwS3HPxT/QMbabI/iBCliMLEJKX2EEkomBAUCxRi42VDADxyTYDVogV+wSChqmKxEKCDAYFDFj4OmwbY7bDGdBhtrnTQYOigeChUmc1K3QTnAUfEgGFgAWt88hKA6aCRIXhxnQ1yg3BCayK44EWdkUQcBByEQChFXfCB776aQsG0BIlQgQgE8qO26X1h8cEUep8ngRBnOy74E9QgRgEAC8SvOfQkh7FDBDmS43PmGoIiKUUEGkMEC/PJHgxw0xH74yx/3XnaYRJgMB8obxQW6kL9QYEJ0FIFgByfIL7/IQAlvQwEpnAC7DtLNJCKUoO/w45c44GwCXiAFB/OXAATQryUxdN4LfFiwgjCNYg+kYMIEFkCKDs6PKAIJouyGWMS1FSKJOMRB/BoIxYJIUXFUxNwoIkEKPAgCBZSQHQ1A2EWDfDEUVLyADj5AChSIQW6gu10bE/JG2VnCZGfo4R4d0sdQoBAHhPjhIB94v/wRoRKQWGRHgrhGSQJxCS+0pCZbEhAAOw==\"}}}}}},\"responses\":{\"200\":{\"description\":\"Image has been created successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"imageId\":{\"type\":\"string\",\"description\":\"Unique identifier for the created image.\",\"example\":\"img12345\"},\"tempURL\":{\"type\":\"string\",\"description\":\"Temporary URL to access the created image.\",\"example\":\"temp/images/dvRyaqpDBJ0m\"},\"contentType\":{\"type\":\"string\",\"description\":\"The content type of the created image.\",\"example\":\"image/gif\"}}}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/packages\":{\"get\":{\"tags\":[\"Packages\"],\"summary\":\"Search Package\",\"description\":\"This operation retrieves a list of packages based on the specified search criteria, such as tracking numbers, status, or associated metadata. \",\"operationId\":\"searchPackage\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"Content-Type\",\"in\":\"header\",\"schema\":{\"type\":\"string\"},\"example\":\"application/json\",\"required\":false},{\"name\":\"startDate\",\"in\":\"query\",\"description\":\"Filter package created or updated on or after this date.\",\"schema\":{\"type\":\"string\"},\"example\":\"2024-11-27T18:30:00.000Z\",\"required\":false},{\"name\":\"endDate\",\"in\":\"query\",\"description\":\"Filter assets created or updated on or before this date.\",\"schema\":{\"type\":\"string\"},\"example\":\"2024-11-28T18:30:00.000Z\",\"required\":false},{\"name\":\"page\",\"in\":\"query\",\"description\":\"The page number of the results to retrieve. Pagination starts from 1.\",\"schema\":{\"type\":\"integer\"},\"example\":\"1\",\"required\":false},{\"name\":\"size\",\"in\":\"query\",\"description\":\"The number of assets to retrieve per page.\",\"schema\":{\"type\":\"integer\"},\"example\":\"25\",\"required\":false},{\"name\":\"search\",\"in\":\"query\",\"description\":\"Search criteria for asset fields such as tracking number. Use `fieldName:fieldValue` format.\",\"schema\":{\"type\":\"string\"},\"example\":\"trackingNumber:PBKWJAMJYW9ND\",\"required\":true},{\"name\":\"searchPosition\",\"in\":\"query\",\"description\":\"Specify the position of the search match in the field. Values can include `starts` or `ends`.\",\"schema\":{\"type\":\"string\"},\"example\":\"ends\",\"required\":false},{\"name\":\"status\",\"in\":\"query\",\"description\":\"Filter assets by status.\",\"schema\":{\"type\":\"string\"},\"example\":\"UNDELIVERED\",\"required\":false},{\"name\":\"location\",\"in\":\"query\",\"description\":\"Filter packages by location ID. Use the unique identifier of the location.\",\"schema\":{\"type\":\"string\"},\"example\":\"bzxgKm861vv\",\"required\":false},{\"name\":\"sort\",\"in\":\"query\",\"description\":\"Specify the sorting order of the results. Format: `fieldName,DIRECTION`. DIRECTION can be `ASC` or `DESC`.\",\"schema\":{\"type\":\"string\"},\"example\":\"insertTimestamp,DESC\",\"required\":false},{\"name\":\"secondTierSearchSelected\",\"in\":\"query\",\"description\":\"Include secondary search criteria for the assets. Defaults to false.\",\"schema\":{\"type\":\"boolean\"},\"example\":\"false\",\"required\":false},{\"name\":\"includeEmptyPackageLocation\",\"in\":\"query\",\"description\":\"Add assets without a specified package location in the results. Defaults to true.\",\"schema\":{\"type\":\"boolean\"},\"example\":\"true\",\"required\":false}],\"responses\":{\"200\":{\"description\":\"Requested assets has been retrived successfully.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchAssetResponseBody\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}},\"post\":{\"tags\":[\"Packages\"],\"summary\":\"Add Package\",\"description\":\"This API operation creates a new package in the system and records its associated activity.<br>\\nEach package requires a unique tracking number to be added successfully. If an attempt is made to add multiple packages using the same tracking number, the API will return an error.\\n<br>\\nWhen to use Add Package API?\\n   - For packages with a barcode\\n      - Customers scan the barcode label on the package and decode the tracking number using the *Decode Tracking Number* API.\\n      - Use the *Get Package by Tracking Number* API to check if the package already exists in the system:\\n          - If the package is not found, use *Add Package* API to add the package in the system.\\n   - For packages without a barcode or tracking number, generate a unique tracking number using the *Generate Tracking Number* API and then add the package using *Add Package* API.\\n\",\"operationId\":\"createPackage\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddPackageRequestBody\"}}},\"required\":true},\"security\":[{\"bearerAuth\":[]}],\"responses\":{\"201\":{\"description\":\"Package has been created successfully.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddPackageResponseBody\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/packages/search\":{\"post\":{\"tags\":[\"Packages\"],\"summary\":\"Search Packages with Custom Header Mapping\",\"description\":\"This operation returns package records based on the requested custom header mapping. The request body contains package field names as keys and custom header labels as values. These header labels can be used to display the returned package data with user-defined column names.\",\"operationId\":\"searchPackages\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"startDate\",\"in\":\"query\",\"description\":\"Filter package updated on or after this date.\",\"schema\":{\"type\":\"string\"},\"example\":\"2024-11-27T18:30:00.000Z\",\"required\":false},{\"name\":\"endDate\",\"in\":\"query\",\"description\":\"Filter package updated on or before this date.\",\"schema\":{\"type\":\"string\"},\"example\":\"2024-11-28T18:30:00.000Z\",\"required\":false},{\"name\":\"page\",\"in\":\"query\",\"description\":\"The page number of the results to retrieve. Pagination starts from 1.\",\"schema\":{\"type\":\"integer\"},\"example\":\"1\",\"required\":false},{\"name\":\"size\",\"in\":\"query\",\"description\":\"The number of assets to retrieve per page.\",\"schema\":{\"type\":\"integer\"},\"example\":\"25\",\"required\":false},{\"name\":\"status\",\"in\":\"query\",\"description\":\"Filter assets by status.\",\"schema\":{\"type\":\"string\"},\"example\":\"UNDELIVERED\",\"required\":false},{\"name\":\"sort\",\"in\":\"query\",\"description\":\"Specify the sorting order of the results.\",\"schema\":{\"type\":\"string\"},\"example\":\"insertTimestamp\",\"required\":false},{\"name\":\"inboundSiteId\",\"in\":\"query\",\"description\":\"This is the identifier of the Inbound Site to be searched.\",\"schema\":{\"type\":\"string\"},\"example\":\"bzxgKm861vv\",\"required\":false}],\"requestBody\":{\"description\":\"Defines custom header mappings for package search results.\\n\\nEach key represents a package response field, and each value represents the custom header label to be used for that field.\\nThe request body is a key-value mapping used to define custom headers for the package search response. \\n\\n- **Key (Field Name):**  \\n  Represents the actual package field from the system.  \\n  This can include nested fields using dot notation (for example, `subId`, `packageId`, `currentLocation.name`, `givenTo.name`, `currentRoute.routeName`).\\n\\n- **Value (Header Label):**  \\n  Represents the custom header name for the corresponding field in the response output.\\n\\nThis mapping allows users to control how package data fields are labeled when returned in response.\\n\\n**Example:**\\n- `\\\"packageId\\\": \\\"Package Identifier\\\"` → Returns the packageId field as \\\"Package Identifier\\\"\\n- `\\\"currentLocation.name\\\": \\\"Site Name\\\"` → Returns current location name as \\\"Site Name\\\"\\n- `deliveryClerk: \\\"Delivered By\\\"` → Returns delivery clerk name as \\\"Delivered By\\\"\\n\\n**Note:**\\n- An empty object can be passed.\\n- If no mappings are provided, the API returns all package fields using their default field names.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"example\":{\"subId\":\"subID\",\"userName\":\"Operator\",\"insertTimestamp\":\"ReceivedDate\",\"packageId\":\"Package ID\",\"currentLocation.name\":\"Site Name\",\"currentStatus\":\"Status\",\"locationZip\":\"Location ZIP\",\"lockerBank\":\"Locker Bank\",\"deliveryClerk\":\"Delivered By\",\"receiveClerk\":\"Received By\",\"givenTo.name\":\"Given To\",\"currentRoute.routeName\":\"Route\",\"deliveryTime\":\"Delivery Time\"}}}}},\"responses\":{\"200\":{\"description\":\"Package details have been retrived successfully.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchPackagesResponse\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/packages/{packageId}\":{\"get\":{\"tags\":[\"Packages\"],\"summary\":\"Get Package\",\"description\":\"This operation retrive detailed information or activities of a specific package using its unique packageId. <br> The packageId is generated when a package is added to the system\",\"operationId\":\"getPackagepackageID\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"packageId\",\"in\":\"path\",\"description\":\"The unique identifier of the package to retrieve.\",\"schema\":{\"type\":\"string\"},\"required\":true,\"example\":\"d86w9YdE3e1JPm01NxaeP\"},{\"name\":\"type\",\"in\":\"query\",\"description\":\"The type of the package details to retrive.\",\"required\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"IMAGES\",\"ACTIVITIES\",\"DETAILED\"]}}],\"responses\":{\"200\":{\"description\":\"Requested package has been retrived successfully.\",\"content\":{\"application/json\":{\"schema\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/DetailedPackage\"}]}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}},\"put\":{\"tags\":[\"Packages\"],\"summary\":\"Update Package\",\"description\":\"This operation updates the details of an existing package using its unique packageId. Updates include the latest activity performen on the package or current status of the package such as `RECEIVED` or `DELIVERED` as well as recording additional information like damage reports, location changes, or other relevant package events.\",\"operationId\":\"updatePackage\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"packageId\",\"in\":\"path\",\"schema\":{\"type\":\"string\"},\"required\":true}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddUpdateRequestDTO\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Package has been updated successfully.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddUpdateResponseDTO\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/packages/{packageId}/archive\":{\"patch\":{\"tags\":[\"Packages\"],\"summary\":\"Archive Package\",\"description\":\"This operation marks the specified package as archived by updating its archived status to `true`. Archiving a package indicates that its lifecycle is complete, and it is no longer actively tracked. While archived packages are removed from active workflows, their records remain accessible for future reference\",\"operationId\":\"archivePackage\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"packageId\",\"in\":\"path\",\"schema\":{\"type\":\"string\"},\"required\":true,\"example\":\"NeLnz9LZ1j4KK5WlEOlyW\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PackageArchiveRequest\"}}}},\"responses\":{\"200\":{\"description\":\"Requested package has been marked archived successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"packageId\":{\"type\":\"string\",\"description\":\"The unique identifier for the package.\",\"example\":\"ma39N30J6YgdxndDpXyOj\"}}}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/packages/tracking/{trackingNumber}\":{\"get\":{\"tags\":[\"Packages\"],\"summary\":\"Get Package By Tracking\",\"description\":\"This operation retrives a package using its unique tracking number.\",\"operationId\":\"getPackageByTracking\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"trackingNumber\",\"in\":\"path\",\"schema\":{\"type\":\"string\"},\"required\":true,\"example\":\"PB7QBQPNBJRDLQ\"}],\"responses\":{\"200\":{\"description\":\"Requested assets has been retrived successfully.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DetailedPackage\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/carriers\":{\"post\":{\"tags\":[\"Carrier\"],\"summary\":\"Retrive Carrier List\",\"description\":\"This operation retrieves a list of carriers associated with the specific location/s.\",\"operationId\":\"getCarrierList\",\"security\":[{\"bearerAuth\":[]}],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"An array containing locations. Each element is a string representing one or more locations. If multiple locations are provided, they should be comma-separated.\",\"example\":\"B9Ol8nDqpq1\"}}}}},\"parameters\":[{\"name\":\"size\",\"in\":\"query\",\"description\":\"The number of results to return in a single page of the carrier list.\",\"schema\":{\"type\":\"integer\"},\"example\":\"50\",\"required\":false},{\"name\":\"page\",\"in\":\"query\",\"description\":\"The page number to retrieve.\",\"schema\":{\"type\":\"integer\"},\"example\":\"1\",\"required\":false},{\"name\":\"barcodeAware\",\"in\":\"query\",\"description\":\"Indicates whether to retrieve carriers that are barcode-aware. When set to `true`, the response includes only those carriers capable of processing barcodes.\",\"schema\":{\"type\":\"boolean\"},\"example\":\"true\",\"required\":false}],\"responses\":{\"201\":{\"description\":\"Carrier list has been retrived successfully.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CarrierLookupResponseDTO\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/inboundsites\":{\"post\":{\"tags\":[\"Inbound sites\"],\"summary\":\"Add Inbound Site\",\"description\":\"This operation used for generating Inbound Site Id.\",\"operationId\":\"addInboundSite\",\"security\":[{\"bearerAuth\":[]}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/AddInboundSiteDTOForSite\"},{\"$ref\":\"#/components/schemas/AddInboundSiteDTOForOtherType\"}]}}}},\"responses\":{\"200\":{\"description\":\"Requested Inbound Site Id has been generated successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"inboundSiteId\":{\"type\":\"string\",\"example\":\"zADZNQ1VWvvA\"}}}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}},\"get\":{\"tags\":[\"Inbound sites\"],\"summary\":\"Get Inbound Site\",\"description\":\"This operation is used to retrived the Inbound Sites.\",\"operationId\":\"getInboundSite\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"skip\",\"in\":\"query\",\"schema\":{\"type\":\"integer\",\"description\":\"Number of records to skip from the beginning.\"},\"example\":\"0\"},{\"name\":\"limit\",\"in\":\"query\",\"schema\":{\"type\":\"integer\",\"description\":\"Maximum number of records to return in one response.\"},\"example\":\"20\"},{\"name\":\"sort\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"description\":\"Sorts the results by a specific field in ascending (ASC) or descending (DESC) order.\"},\"example\":\"name,ASC\"},{\"name\":\"query\",\"in\":\"query\",\"schema\":{\"type\":\"string\"},\"description\":\"Searches for inbound sites using a keyword.\",\"example\":\"site\"},{\"name\":\"searchBy\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"description\":\"Finds inbound sites based on a relationship with another site.\"},\"examples\":{\"example1\":{\"summary\":\"For getting inbound sites which belongs to particaular site\",\"value\":\"parent:X7okeWJyx5zz\"},\"example2\":{\"summary\":\"For searching inside the inbound sites hierarchy\",\"value\":\"ancestorlist:X7okeWJyx5zz\"}}},{\"name\":\"fetchPrimarySite\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"},\"example\":true,\"description\":\"Only get default site in response, if set true. \"},{\"name\":\"timestamp\",\"in\":\"query\",\"schema\":{\"type\":\"string\"},\"example\":\"2024-11-19T07:54:46.807\",\"description\":\"Get inbound site which are created before or after the provided timestamp.\"},{\"name\":\"status\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"enum\":[\"active\",\"inactive\"]},\"example\":\"active\",\"description\":\"Only get default site in response, if set true.\"}],\"responses\":{\"200\":{\"description\":\"Requested Inbound Sites list has been retrived successfully.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetAllInboundSitesResponse\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/inboundsites/{inboundSiteId}\":{\"put\":{\"tags\":[\"Inbound sites\"],\"summary\":\"Update Inbound Site\",\"description\":\"This operation used to update Inbound Site.\",\"operationId\":\"updateInboundSite\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"inboundSiteId\",\"in\":\"path\",\"schema\":{\"type\":\"string\"},\"required\":true,\"example\":\"gJVQ5bQW2OVd\"}],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateInboundSiteDTO\"}}}},\"responses\":{\"200\":{\"description\":\"Requested Inbound Site has been updated successfully.\",\"content\":{\"application/json\":{}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}},\"delete\":{\"tags\":[\"Inbound sites\"],\"summary\":\"Delete Inbound Site\",\"description\":\"This operation is used to delete Inbound Site.\",\"operationId\":\"deleteInboundSite\",\"security\":[{\"bearerAuth\":[]}],\"parameters\":[{\"name\":\"inboundSiteId\",\"in\":\"path\",\"schema\":{\"type\":\"string\",\"description\":\"This is the identifier of the Inbound Site to be deleted.\"},\"required\":true,\"example\":\"gJVQ5bQW2OVd\"}],\"responses\":{\"200\":{\"description\":\"Requested Inbound Site has been deleted successfully.\",\"content\":{\"application/json\":{}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}},\"/api/v1/location/inboundsites\":{\"post\":{\"tags\":[\"Inbound sites\"],\"summary\":\"Get against locationId\",\"description\":\"This operation is used to retrived Inbound Site against the location.\",\"operationId\":\"getLocationInboundSite\",\"security\":[{\"bearerAuth\":[]}],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"example\":[\"location1\",\"location2\"]}}}},\"responses\":{\"200\":{\"description\":\"Successful response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetAllInboundSiteAgainstLocationResponse\"}}}},\"400\":{\"description\":\"Invalid or Bad Request\",\"$ref\":\"#/components/responses/BadRequestError\"},\"401\":{\"description\":\"Unauthorized Error\",\"$ref\":\"#/components/responses/UnauthorizedError\"},\"500\":{\"description\":\"Internal Server Error\",\"$ref\":\"#/components/responses/InternalServerError\"}}}}},\"components\":{\"securitySchemes\":{\"bearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\"}},\"schemas\":{\"error\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"This is HTTP 401 Unauthorized response status code, that indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.\"}},\"required\":[\"message\"]},\"Errors\":{\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of errors.\",\"items\":{\"type\":\"object\",\"properties\":{\"errorCode\":{\"type\":\"string\",\"description\":\"This error can be validation_error or internal_error or not_found or already_exists\",\"example\":\"validation_error\"},\"errorDescription\":{\"type\":\"string\",\"description\":\"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).\",\"example\":\"Asset not found.\"},\"additionalCode\":{\"type\":\"string\",\"description\":\"A unique identifier for the error\",\"example\":\"020005\"},\"additionalInfo\":{\"type\":\"string\",\"description\":\" additional information of the error.\",\"example\":\"additional information\"},\"additionalParameters\":{\"type\":\"string\",\"description\":\"The field(s) that might be incorrect in the request.\",\"example\":\"additional parameters\"},\"correlationID\":{\"type\":\"string\",\"description\":\"\",\"example\":\"correlationId\"}}}}}},\"Image\":{\"type\":\"object\",\"properties\":{\"imageId\":{\"type\":\"string\",\"description\":\"Unique identifier for the uploaded image.\",\"example\":\"img12345\"},\"tempURL\":{\"type\":\"string\",\"description\":\"Temporary URL to access the uploaded image.\",\"example\":\"temp/images/a5qk9gR1X85v\"},\"imageType\":{\"type\":\"string\",\"description\":\"Type or format of the uploaded image.\",\"example\":\"PHOTO\"}}},\"PackageArchiveRequest\":{\"type\":\"object\",\"properties\":{\"archived\":{\"type\":\"boolean\",\"description\":\"set to true to archive the package.\",\"example\":true}}},\"AddUpdateRequestDTO\":{\"type\":\"object\",\"required\":[\"package\"],\"properties\":{\"package\":{\"type\":\"object\",\"properties\":{\"trackingNumber\":{\"type\":\"string\",\"description\":\"The tracking number associated with the asset to be updated.\",\"example\":\"TB123456789ABCE\"},\"assetType\":{\"type\":\"string\",\"description\":\"The type of the asset.\",\"example\":\"PACKAGE\",\"enum\":[\"PACKAGE\",\"POUCH\"]},\"damaged\":{\"type\":\"boolean\",\"description\":\"Indicates whether the package is marked as damaged.\",\"example\":false},\"timezone\":{\"type\":\"integer\",\"description\":\"The timezone offset of the asset's current location in minutes.\",\"example\":-330},\"sender\":{\"type\":\"object\",\"description\":\"Details of the sender for the package.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"The contact ID for the sender selected for the package. The `contactId` corresponds to the field `Id` in the address book for a contact with `contactType: SENDER` or `contactType: ALL`.\",\"example\":\"5f508e6baa797f3c3d092307\"}}},\"receiver\":{\"type\":\"object\",\"description\":\"Details of the receiver for the package.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"The contact ID for the recipient selected for the package. The `contactId` corresponds to the field `Id` in the address book for a contact with `contactType: RECEIVER` or `contactType: ALL`.\",\"example\":\"5f508e6baa797f3c3d092307\"}}},\"givenTo\":{\"type\":\"object\",\"description\":\"Details of the person or entity the last activity is assigned to.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"The Contact ID of the person or entity the last activity is assigned to.\",\"example\":\"5f508e6baa797f3c3d092307\"}}},\"comment\":{\"type\":\"string\",\"description\":\"Optional comments or notes related to the package.\",\"example\":\"User comments\"},\"confirmationType\":{\"type\":\"string\",\"description\":\"Confirmation type\",\"example\":\"PHONE\"},\"additionalConfirmationType\":{\"type\":\"string\",\"description\":\"Additional confirmation type\",\"example\":\"SIGNATURE\"},\"customFields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CustomField\"},\"description\":\"List of custom fields associated with the package.<br>Custom fields are additional package fields that can be added to display on PitneyTrack workflow pages.<br>These fields can be defined from the 'My Settings' page in platform settings.\"}}},\"lastActivity\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"The updated status of the last activity performed on the package.\",\"example\":\"RECEIVED\"},\"location\":{\"type\":\"object\",\"description\":\"Details of the location where the last activity occurred.\",\"properties\":{\"inboundSiteId\":{\"type\":\"string\",\"description\":\"The unique identifier of the inbound site where the package was last processed.\",\"example\":\"zy0a23Bo4Gn0\"}}}}},\"images\":{\"description\":\"List of images related to the packages.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"imageLevel\":{\"type\":\"string\",\"description\":\"Level of the image to be added with the package.\",\"example\":\"ASSET\"},\"imageType\":{\"type\":\"string\",\"description\":\"Type of the image to be added with the package.\",\"example\":\"PHOTO\"},\"tempURL\":{\"type\":\"string\",\"description\":\"Temporary URL for accessing the image to be added with the packae.\",\"example\":\"temp/images/vvrbWY3rRBz\"},\"contentType\":{\"type\":\"string\",\"description\":\"Content type of the image to be added with the package.\",\"example\":\"image/png\"}}}}}},\"AddUpdateResponseDTO\":{\"type\":\"object\",\"properties\":{\"packageId\":{\"type\":\"string\",\"description\":\"Unique identifier generated for the package\",\"example\":\"NeLnz9LZ1j4KK5WlEOlyW\"},\"trackingNumber\":{\"type\":\"string\",\"description\":\"Tracking number associated with the package\",\"example\":\"PB4OZAWWNPBGB\"},\"images\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Image\"}}}},\"CarrierLookupResponseDTO\":{\"type\":\"object\",\"properties\":{\"carriers\":{\"type\":\"array\",\"description\":\"List of carriers.\",\"items\":{\"type\":\"object\",\"properties\":{\"carrierId\":{\"type\":\"string\",\"description\":\"The unique identifier for the carrier.\",\"example\":\"XXXX\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the carrier.\",\"example\":\"Amazon\"},\"barcodeAware\":{\"type\":\"boolean\",\"description\":\"If the carrier is barcode-aware.\",\"example\":true},\"isCustom\":{\"type\":\"boolean\",\"description\":\"If the carrier is a custom carrier.\",\"example\":false}}}},\"recentCarriers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CarrierTrans\"},\"description\":\"List of recent carriers\"},\"totalCount\":{\"type\":\"integer\",\"description\":\"Total count of carriers.\"}},\"description\":\"Response object for carrier lookup.\"},\"CarrierTrans\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Carrier name\"},\"carrierId\":{\"type\":\"string\",\"description\":\"Carrier ID\"}}},\"LocationTrans\":{\"type\":\"object\",\"properties\":{\"inboundSiteId\":{\"type\":\"string\",\"description\":\"Unique identifier of the inbound site where the package is currently located.\",\"example\":\"zy0a23Bo4Gn0\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the current location of the package.\",\"example\":\"Site 1CD1001RMF\"},\"parent\":{\"type\":\"string\",\"description\":\"The parent location, indicating the immediate hierarchical parent.\",\"example\":\"Site\"},\"type\":{\"type\":\"string\",\"description\":\"Type of the current location (e.g., site, building, floor, mailstop).\",\"example\":\"site\"},\"locationHierarchy\":{\"type\":\"string\",\"description\":\"Hierarchy path of the current location of the package in standard format, e.g., Site > Building > Floor > Mailstop.\",\"example\":\"Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS\"},\"ancestorlist\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"A list of ancestors in the location hierarchy, providing a traceable path to the current location.For example, [Site, Building, Floor].\",\"example\":[\"k5OrZWe0ly6dg1v\",\"gKP4RNbMzrPO\",\"XbyR9zpPDneY\"]},\"topTier\":{\"type\":\"object\",\"description\":\"Details of the top-tier location in the hierarchy.\",\"properties\":{\"inboundSiteId\":{\"type\":\"string\",\"description\":\"The unique Inbound Site ID of the top-tier location.\",\"example\":\"EMPTY_SITE\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the top-tier location.\",\"example\":\"EMPTY_SITE\"}}}}},\"ContactTrans\":{\"type\":\"object\",\"properties\":{\"personalId\":{\"type\":\"string\",\"description\":\"The unique personal identifier of the contact.\",\"example\":\"jy32\"},\"contactId\":{\"type\":\"string\",\"description\":\"The unique contact ID.\",\"example\":\"5f508e6baa797f3c3d092307\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the contact.\",\"example\":\"contact_name\"},\"company\":{\"type\":\"string\",\"description\":\"The company name associated with the contact.\",\"example\":\"company_name\"},\"phone\":{\"type\":\"string\",\"description\":\"The phone number of the contact.\",\"example\":\"1234567890\"},\"email\":{\"type\":\"string\",\"description\":\"Email address of the contact.\",\"example\":\"user@email.com\"},\"additionalEmailIds\":{\"type\":\"array\",\"description\":\"Additional email addresses associated with the contact.\",\"items\":{\"type\":\"string\",\"example\":\"user@email.com\"}},\"location\":{\"$ref\":\"#/components/schemas/LocationTrans\"},\"mailStopLocation\":{\"$ref\":\"#/components/schemas/LocationTrans\"}}},\"CustomField\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the custom field as defined by the user in the 'My Settings' page of platform settings.\",\"example\":\"End User\"},\"status\":{\"type\":\"string\",\"description\":\"Status of the custom field. Supported values are:\\n- ACTIVE: The custom field is currently in use.\\n- INACTIVE: The custom field is not in use.\\n\",\"example\":\"ACTIVE\"},\"customFieldId\":{\"type\":\"string\",\"description\":\"Unique identifier for the custom field.\",\"example\":\"o1axRY2NKxq\"},\"value\":{\"type\":\"string\",\"description\":\"Value associated with the custom field, as set by the user.\",\"example\":\"end user\"}}},\"DetailedPackage\":{\"type\":\"object\",\"properties\":{\"package\":{\"$ref\":\"#/components/schemas/PackageResponse\",\"description\":\"Details of the package.\"},\"activities\":{\"type\":\"array\",\"description\":\"List of activities with details of each activity.\",\"items\":{\"type\":\"object\",\"properties\":{\"activityId\":{\"type\":\"string\",\"description\":\"The unique identifier for the activity.\",\"example\":\"NWZ7lnJgOMLl\"},\"status\":{\"type\":\"string\",\"description\":\"The current status of the activity.\",\"example\":\"CREATED\"},\"location\":{\"type\":\"object\",\"description\":\"\",\"properties\":{\"inboundSiteId\":{\"type\":\"string\",\"description\":\"Unique identifier of the inbound site where the package is currently located.\",\"example\":\"zy0a23Bo4Gn0\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the current location of the package.\",\"example\":\"Site 1CD1001RMF\"},\"type\":{\"type\":\"string\",\"description\":\"Type of the current location (e.g., site, building, floor, mailstop).\",\"example\":\"site\"},\"locationHierarchy\":{\"type\":\"string\",\"description\":\"Hierarchy path of the current location of the package, e.g., Site > Building > Floor > Mailstop.\",\"example\":\"Site 1CD1001RMF\"}}},\"route\":{\"type\":\"object\",\"description\":\"Details of the route associated with the activity.\",\"example\":{}},\"username\":{\"type\":\"string\",\"description\":\"The username associated with the activity.\",\"example\":\"API-SP360-8BZWymklRPj5-DEV\"},\"currentState\":{\"type\":\"object\",\"description\":\"Current state details of the asset associated with the activity.\",\"example\":{}}}}},\"images\":{\"type\":\"array\",\"description\":\"List of images related to the package.\",\"items\":{\"type\":\"object\",\"properties\":{\"imageId\":{\"type\":\"string\",\"description\":\"The unique identifier for the image.\",\"example\":\"7NNO1R3e1455\"},\"url\":{\"type\":\"string\",\"description\":\"The signed URL to access the image. The URL is valid for a limited time.\",\"example\":\"https://225934331380-receiving-service-artifacts-qa.s3.amazonaws.com/images/sac11be/Vlyx3zyQNr8omx6VzoR8Q/7NNO1R3e1455?X-Amz-Algorithm=AWS4-HMAC-SHA256&..........\"},\"contentType\":{\"type\":\"string\",\"description\":\"The MIME type of the image.\",\"example\":\"image/gif\"}}}}}},\"ExpectedPackageResponse\":{\"type\":\"object\",\"properties\":{\"trackingNumber\":{\"type\":\"string\",\"description\":\"Tracking number of the package\"},\"recipientName\":{\"type\":\"string\",\"description\":\"Name of the recipient\"},\"senderName\":{\"type\":\"string\",\"description\":\"Name of the sender\"},\"carrierId\":{\"type\":\"string\",\"description\":\"ID of the carrier\"},\"carrierService\":{\"type\":\"string\",\"description\":\"Carrier service used for the package\"}},\"description\":\"Details of an expected package response\"},\"GetResponseDTO\":{\"type\":\"object\",\"properties\":{\"package\":{\"$ref\":\"#/components/schemas/PackageResponse\",\"description\":\"Details of the package\"},\"decodedCarriers\":{\"type\":\"array\",\"description\":\"A list of decoded carriers associated with the request.\",\"items\":{\"type\":\"object\",\"properties\":{\"trackingNum\":{\"type\":\"string\",\"description\":\"The tracking number decoded for the carrier.\",\"example\":\"PBLZQ93PMANYPO\"}}}}}},\"PackageBase\":{\"type\":\"object\",\"properties\":{\"trackingNumber\":{\"type\":\"string\",\"description\":\"Tracking number of the package.\",\"example\":\"PBYV4PVRBYLAAW\"},\"carrier\":{\"type\":\"object\",\"properties\":{\"carrierId\":{\"type\":\"string\",\"description\":\"The unique identifier of the carrier being used.\",\"example\":\"FedEx\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the carrier used.\",\"example\":\"FedEx\"}}},\"damaged\":{\"type\":\"boolean\",\"description\":\"Whether the package is damaged\",\"example\":false},\"comment\":{\"type\":\"string\",\"description\":\"Comment on the package\",\"example\":\"user_comment\"},\"currentLocation\":{\"$ref\":\"#/components/schemas/LocationTrans\",\"description\":\"Current location of the asset\"},\"currentStatus\":{\"type\":\"string\",\"description\":\"Current status of the package.\",\"example\":\"RECEIVED\"},\"confirmationType\":{\"type\":\"string\",\"description\":\"The type of confirmation captured during the delivery of the package. Indicates proof of delivery, such as PHONE.\",\"example\":\"PHONE\"},\"additionalConfirmationType\":{\"type\":\"string\",\"description\":\"An additional type of confirmation captured during the delivery.          Like `confirmationType`, it can include values like SIGNATURE.\",\"example\":\"SIGNATURE\"},\"timezone\":{\"type\":\"integer\",\"description\":\"Timezone offset of the package location in minutes.\",\"example\":-330},\"customFields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CustomField\"},\"description\":\"List of custom fields associated with the package.<br>Custom fields are additional package fields that can be added to display on PitneyTrack workflow pages.<br>These fields can be defined from the 'My Settings' page in platform settings.\"}}},\"PackageResponse\":{\"allOf\":[{\"$ref\":\"#/components/schemas/PackageBase\"}],\"properties\":{\"packageId\":{\"type\":\"string\",\"description\":\" Unique identifier of the Package\",\"example\":\"LMQmVaVXXxyQyZv1l2EkO\"},\"sender\":{\"$ref\":\"#/components/schemas/ContactTrans\"},\"receiver\":{\"$ref\":\"#/components/schemas/ContactTrans\"},\"givenTo\":{\"$ref\":\"#/components/schemas/ContactTrans\"}}},\"AddPackageRequestBody\":{\"type\":\"object\",\"required\":[\"package\"],\"properties\":{\"package\":{\"description\":\"Details of the package to be added.\",\"type\":\"object\",\"properties\":{\"trackingNumber\":{\"type\":\"string\",\"description\":\"This is a unique tracking number to be associated with the package. This tracking number can be generated using the `Generate Unique Tracking Number` API.\",\"example\":\"PB7WMALJAWRMJW\"},\"assetType\":{\"type\":\"string\",\"description\":\"Type of the package to be added.\",\"example\":\"PACKAGE\",\"enum\":[\"PACKAGE\",\"POUCH\"]},\"damaged\":{\"type\":\"boolean\",\"description\":\"If the package is damaged or not.\",\"example\":false},\"timezone\":{\"type\":\"integer\",\"description\":\"Timezone offset of the package location in minutes.\",\"example\":-330},\"carrier\":{\"type\":\"object\",\"properties\":{\"carrierId\":{\"type\":\"string\",\"description\":\"The unique identifier of the carrier being used.\",\"example\":\"FedEx\"}}},\"currentStatus\":{\"type\":\"string\",\"description\":\"Current status of the package.\",\"example\":\"RECEIVED\"},\"customFields\":{\"type\":\"array\",\"description\":\"List of custom fields associated with the package. \\nCustom fields are additional package fields that can be added to display on PitneyTrack workflow pages.\\nThese fields can be defined from the 'My Settings' page in platform settings.\\\"\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the custom field as defined by the user in the 'My Settings' page of platform settings.\",\"example\":\"End User\"},\"status\":{\"type\":\"string\",\"description\":\"Status of the custom field. Supported values are:\\n  - ACTIVE: The custom field is currently in use.\\n  - INACTIVE: The custom field is not in use.\\n\",\"example\":\"ACTIVE\",\"enum\":[\"ACTIVE\",\"INACTIVE\"]},\"customFieldId\":{\"type\":\"string\",\"description\":\"Unique identifier for the custom field.\\n\",\"example\":\"o1axRY2NKxq\"},\"value\":{\"type\":\"string\",\"description\":\"Value associated with the custom field, as set by the user.\\nexample: \\\"user name\\\"\\n\"}}}},\"sender\":{\"type\":\"object\",\"description\":\"Details of the sender for the package.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"The contact ID for the sender selected for the package. The `contactId` corresponds to the field `Id` in the address book for a contact with `contactType: SENDER` or `contactType: ALL`.\",\"example\":\"5f508e6baa797f3c3d092307\"}}},\"receiver\":{\"type\":\"object\",\"description\":\"Details of the receiver for the package.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"The contact ID for the recipient selected for the package. The `contactId` corresponds to the field `Id` in the address book for a contact with `contactType: RECEIVER` or `contactType: ALL`.\",\"example\":\"5f508e6baa797f3c3d092307\"}}},\"givenTo\":{\"type\":\"object\",\"description\":\"Details of the person or entity the last activity is assigned to.\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"The Contact ID of the person or entity the last activity is assigned to.\",\"example\":\"5f508e6baa797f3c3d092307\"}}},\"comment\":{\"type\":\"string\",\"description\":\"Optional comments or additional information about the package.\",\"example\":\"User comments\"},\"confirmationType\":{\"type\":\"string\",\"description\":\"The type of confirmation captured during the delivery of the package. \\nIndicates proof of delivery, such as PHONE.\\n\",\"example\":\"PHONE\"},\"additionalConfirmationType\":{\"type\":\"string\",\"description\":\"An additional type of confirmation captured during the delivery. \\nLike `confirmationType`, it can include values like SIGNATURE.\\n\",\"example\":\"SIGNATURE\"}}},\"lastActivity\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"The updated status of the last activity performed on the package.\",\"example\":\"RECEIVED\"},\"location\":{\"type\":\"object\",\"properties\":{\"inboundSiteId\":{\"type\":\"string\",\"description\":\"Unique identifier of the inbound site where the package is currently located.\",\"example\":\"zy0a23Bo4Gn0\"}}}}},\"images\":{\"description\":\"List of images related to the packages.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"imageLevel\":{\"type\":\"string\",\"description\":\"Level of the image to be added with the package.\",\"example\":\"ASSET\"},\"imageType\":{\"type\":\"string\",\"description\":\"Type of the image to be added with the package.\",\"example\":\"PHOTO\"},\"tempURL\":{\"type\":\"string\",\"description\":\"Temporary URL for accessing the image to be added with the packae.\",\"example\":\"temp/images/vvrbWY3rRBz\"},\"contentType\":{\"type\":\"string\",\"description\":\"Content type of the image to be added with the package.\",\"example\":\"image/png\"}}}}}},\"AddPackageResponseBody\":{\"type\":\"object\",\"properties\":{\"packageId\":{\"type\":\"string\",\"description\":\"Unique identifier generated for the package\",\"example\":\"NeLnz9LZ1j4KK5WlEOlyW\"},\"trackingNumber\":{\"type\":\"string\",\"description\":\"Tracking number associated with the package\",\"example\":\"PB4OZAWWNPBGB\"},\"images\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"description\":\"List of images associated with the package\",\"properties\":{\"contentType\":{\"type\":\"string\",\"description\":\"The MIME type of the image.\",\"example\":\"image/gif\"},\"imageId\":{\"type\":\"string\",\"description\":\"The unique identifier for the image associated with the package.\",\"example\":\"7NNO1R3e1455\"},\"url\":{\"type\":\"string\",\"description\":\"The URL where the image stored.\",\"example\":\"https://225934331380-receiving-service-artifacts-qa.s3.amazonaws.com/images/sac11be/Vlyx3zyQNr8omx6VzoR8Q/7NNO1R3e1455\"}}}}}},\"SearchAssetResponseBody\":{\"type\":\"object\",\"properties\":{\"packages\":{\"type\":\"array\",\"description\":\"List of packages associated with the request.\",\"items\":{\"type\":\"object\",\"properties\":{\"packageId\":{\"type\":\"string\",\"description\":\"Unique identifier for the package.\",\"example\":\"X0vYqQp3obMPEM2DAlPwz\"},\"insertTimestamp\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The timestamp when the package was added.\",\"example\":\"2025-02-13T07:12:28.302Z\"},\"updateTimestamp\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The timestamp when the package was last updated.\",\"example\":\"2025-02-13T07:12:28.302Z\"},\"trackingNumber\":{\"type\":\"string\",\"description\":\"Tracking number assigned to the package.\",\"example\":\"XYZ123456\"},\"carrier\":{\"type\":\"object\",\"properties\":{\"carrierId\":{\"type\":\"string\",\"description\":\"The unique identifier of the carrier being used.\",\"example\":\"FedEx\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the carrier used.\",\"example\":\"FedEx\"}}},\"assetType\":{\"type\":\"string\",\"description\":\"Type of the asset (e.g., PACKAGE or POUCH)\",\"example\":\"PACKAGE\"},\"damaged\":{\"type\":\"boolean\",\"description\":\"If the package is marked damaged.\",\"example\":false},\"sender\":{\"$ref\":\"#/components/schemas/ContactTrans\",\"description\":\"The contact details of the individual or organization that sent the package.\"},\"receiver\":{\"$ref\":\"#/components/schemas/ContactTrans\",\"description\":\"The contact details of the individual or organization designated to receive the package.\"},\"givenTo\":{\"$ref\":\"#/components/schemas/ContactTrans\",\"description\":\"The contact details of the person or entity to whom the package was handed over during the last activity or status update.\"},\"comment\":{\"type\":\"string\",\"description\":\"User comments on the package.\",\"example\":\"User comments\"},\"currentLocation\":{\"type\":\"object\",\"description\":\"Current location details of the package.\",\"properties\":{\"inboundSiteId\":{\"type\":\"string\",\"description\":\"Unique identifier of the inbound site where the package is currently located.\",\"example\":\"zy0a23Bo4Gn0\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the current location of the package.\",\"example\":\"Noida, Office of CG\"},\"type\":{\"type\":\"string\",\"description\":\"Type of the current location (e.g., site, building, floor, mailstop).\",\"example\":\"site\"},\"locationHierarchy\":{\"type\":\"string\",\"description\":\"Hierarchy path of the current location of the package  e.g., Site > Building > Floor > Mailstop\",\"example\":\"Noida, Office of CG\"}}},\"currentStatus\":{\"type\":\"string\",\"description\":\"Current status of the package.\",\"example\":\"RECEIVED\"},\"confirmationType\":{\"type\":\"string\",\"description\":\"The type of confirmation captured during the delivery of the package. \\nIndicates proof of delivery, such as PHONE.\\n\",\"example\":\"PHONE\"},\"additionalConfirmationType\":{\"type\":\"string\",\"description\":\"An additional type of confirmation captured during the delivery. \\nLike `confirmationType`, it can include values like SIGNATURE.\\n\"},\"timezone\":{\"type\":\"integer\",\"description\":\"The timezone offset of the package in minutes.\",\"example\":-330},\"customFields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CustomField\"},\"description\":\"List of custom fields associated with the package.<br>Custom fields are additional package fields that can be added to display on PitneyTrack workflow pages.<br>These fields can be defined from the 'My Settings' page in platform settings.\"}}}},\"totalCount\":{\"type\":\"integer\",\"description\":\"Total count of packages returned in the response.\",\"example\":1}}},\"AddInboundSiteDTOForSite\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the inbound site to be added.\",\"example\":\"Site A\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the inbound site\",\"example\":\"site\"},\"locationId\":{\"type\":\"string\",\"description\":\"The location ID associated with the inbound site.\",\"example\":\"M0K9QbNMgob\"},\"defaultSite\":{\"type\":\"boolean\",\"description\":\"Indicates if this is the default site.\",\"example\":true}},\"required\":[\"name\",\"type\",\"status\",\"locationId\"],\"additionalProperties\":false},\"AddInboundSiteDTOForOtherType\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the inbound site type to be added.\",\"example\":\"Building-A\"},\"type\":{\"type\":\"string\",\"enum\":[\"building\",\"mailstop\",\"floor\",\"office\"],\"description\":\"The type of the inbound site\",\"example\":\"building\"},\"parent\":{\"type\":\"string\",\"description\":\"This is the inboundSiteId of parent to which this type should belongs to, for example in case of type building, Site is the parent. User first need to generate Parent Inbound Site ID.\",\"example\":\"5g6gg9DYO3WN\"},\"defaultSite\":{\"type\":\"boolean\",\"description\":\"Indicates if this is the default site.\",\"example\":true}},\"required\":[\"name\",\"type\",\"status\",\"parent\"],\"additionalProperties\":false},\"GetAllInboundSitesResponse\":{\"type\":\"object\",\"properties\":{\"inboundsites\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/InboundSiteResponse\"},\"description\":\"List of inbound sites\"},\"pageInfo\":{\"$ref\":\"#/components/schemas/PageInfo\"}}},\"InboundSiteResponse\":{\"type\":\"object\",\"properties\":{\"inboundSiteId\":{\"type\":\"string\",\"description\":\"A unique identifier assigned to the inbound site.\",\"example\":\"xy277mD9Plbl\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the inbound site.\",\"example\":\"Gandhi Nagar\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the inbound site that is Site, Building, Floor, Mailstop.\",\"example\":\"site\"},\"locationId\":{\"type\":\"string\",\"description\":\"The unique identifier of the location associated with the inbound site.\",\"example\":\"M0K9QbNMgob\"},\"locationHierarchy\":{\"type\":\"string\",\"description\":\"The hierarchical structure of the inbound site's location (e.g., Site > Building > Floor > Mailstop).\",\"example\":\"Gandhi Nagar\"},\"status\":{\"type\":\"string\",\"description\":\"The current status of the inbound site, such as ACTIVE or INACTIVE.\",\"example\":\"ACTIVE\"},\"defaultSite\":{\"type\":\"boolean\",\"description\":\"Indicates whether this inbound site is the default site in the system.\",\"example\":false}},\"additionalProperties\":false},\"PageInfo\":{\"type\":\"object\",\"properties\":{\"totalCount\":{\"type\":\"integer\",\"description\":\"The total number of items available across all pages.\",\"example\":9},\"startCount\":{\"type\":\"integer\",\"description\":\"The starting position of the first item on the current page.\",\"example\":1},\"limit\":{\"type\":\"integer\",\"description\":\"The maximum number of items that can be displayed on a single page.\",\"example\":10}}},\"UpdateInboundSiteDTO\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the inbound site to be updated.\",\"example\":\"Site A\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the inbound site, such as Site, Building etc.\",\"example\":\"site\"},\"locationId\":{\"type\":\"string\",\"description\":\"The unique identifier of the location associated with the inbound site.\",\"example\":\"loc123\"},\"inboundSiteId\":{\"type\":\"string\",\"description\":\"The unique identifier of the inbound site to be updated.\",\"example\":\"INB123\"},\"status\":{\"type\":\"string\",\"description\":\"The current status of the inbound site, such as Active or Inactive.\",\"example\":\"Active\"},\"defaultSite\":{\"type\":\"boolean\",\"description\":\"Indicates whether this is the default inbound site.\",\"example\":true},\"parent\":{\"type\":\"string\",\"description\":\"This is the inboundSiteId of parent to which this type should belongs to, for example in case of type building, Site is the parent. In case of updating Building, Floor, floor or Mailstop, user must pass its parent inbound site serviceID.\",\"example\":\"GNgzzLNQ9zBb\"}},\"required\":[\"name\",\"type\",\"status\",\"defaultSite\",\"locationId\"],\"additionalProperties\":false},\"GetAllInboundSiteAgainstLocationResponse\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/InboundSiteResponse\"},\"description\":\"List of inbound sites.\"},\"SearchPackagesRequest\":{\"type\":\"object\",\"description\":\"Defines custom header mappings for package search results.\\n\\nEach key represents a package response field, and each value represents the custom header label to be used for that field.\\nThe request body is a key-value mapping used to define custom headers for the package search response. \\n\\n- **Key (Field Name):**  \\n  Represents the actual package field from the system.  \\n  This can include nested fields using dot notation (for example, `currentLocation.name`, `givenTo.name`, `currentRoute.routeName`).\\n\\n- **Value (Header Label):**  \\n  Represents the custom header name for the corresponding field in the response output.\\n\\nThis mapping allows users to control how package data fields are labeled when returned in response.\\n\\n**Example:**\\n- `\\\"packageId\\\": \\\"Package Identifier\\\"` → Returns the packageId field as \\\"Package Identifier\\\"\\n- `\\\"currentLocation.name\\\": \\\"Site Name\\\"` → Returns current location name as \\\"Site Name\\\"\\n- `deliveryClerk: \\\"Delivered By\\\"` → Returns delivery clerk name as \\\"Delivered By\\\"\\n\\n**Note:**\\n**Note:**\\n- An empty object can be passed.\\n- If no mappings are provided, the API returns all package fields using their default field names.\\n\",\"additionalProperties\":{\"type\":\"string\"},\"example\":{\"subId\":\"subID\",\"userName\":\"Operator\",\"insertTimestamp\":\"ReceivedDate\",\"packageId\":\"Package ID\",\"currentLocation.name\":\"Site Name\",\"currentStatus\":\"Status\",\"locationZip\":\"Location ZIP\",\"lockerBank\":\"Locker Bank\",\"deliveryClerk\":\"Delivered By\",\"receiveClerk\":\"Received By\",\"givenTo.name\":\"Given To\",\"currentRoute.routeName\":\"Route\",\"deliveryTime\":\"Delivery Time\"}},\"SearchPackagesResponse\":{\"type\":\"object\",\"description\":\"Returns package records with fields labeled based on the provided custom header mappings.\\n\\nEach package object contains dynamic key-value pairs where:\\n- **Key:** Custom header label defined in the request\\n- **Value:** Corresponding package field value\\n\\nIf no mappings are provided in the request, the response returns package fields using their default field names.\\n\",\"properties\":{\"packages\":{\"type\":\"array\",\"description\":\"Returns package records with fields labeled based on the provided custom header mappings.\\n\\nEach package object contains dynamic key-value pairs where:\\n  \\n- **Key:** Custom header label defined in the request\\n- **Value:** Corresponding package field value\\n\\nIf no mappings are provided in the request, the response returns package fields using their default field names.\\n\",\"items\":{\"type\":\"object\",\"description\":\"Represents a package record with dynamic fields.\\n\\nThe keys in this object correspond to the custom header labels defined in the request body.\\n\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"Value of the corresponding package field.\"}}},\"totalCount\":{\"type\":\"integer\",\"description\":\"Total number of package records returned.\",\"example\":20}},\"example\":{\"packages\":[{\"Bank\":\"Sector 142 LockerBank\",\"DT\":\"\",\"Delivered By\":\"\",\"Given To\":\"\",\"JvoZmPNeYGWlKR0w7gKlR\":\"lkgP5Xb0r32AMKK6w2z6E\",\"Operator\":\"pse US Sanity\",\"ReceivedDate\":\"2026-04-09T13:58:17.394Z\",\"Route\":\"Delhi Route\",\"SiteName\":\"API_Site_Update\",\"Status\":\"RECEIVED\",\"locZip\":\"06810\",\"subID\":\"sac11be\"}],\"totalCount\":1}}},\"responses\":{\"UnauthorizedError\":{\"description\":\"The request could not be authorized.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/error\"}}}},\"InternalServerError\":{\"description\":\"The request could not be completed due to an internal error.\",\"content\":{}},\"BadRequestError\":{\"description\":\"Invalid request.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Errors\"}}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"hideInfoSection\":true,\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Node.js\"},{\"lang\":\"Python\"},{\"lang\":\"Go\"},{\"lang\":\"Java\"},{\"lang\":\"C#\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/openapi/receiving/overview/","redocItemId":"tag/Packages/operation/searchPackages","redocHasInfoPage":false,"settings":{"hideInfoSection":true,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]}},"requestLogin":false,"lastModified":"2026-05-13T05:51:29.000Z"},"seo":{"title":"Search Packages with Custom Header Mapping"}}},"pageContext":{"id":"346defe8-d033-5206-8c82-1051b8db4d01operation/searchPackages__redocly content/openapi/receiving/operation/searchPackages/","seo":{"title":"Search Packages with Custom Header Mapping","description":"This operation returns package records based on the requested custom header mapping. The request body contains package field names as keys and custom header labels as values. These header labels can be used to display the returned package data with user-defined column names.","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"openapi/receiving.page.yaml#operation/searchPackages","pageBaseUrl":"/openapi/receiving","type":"redoc-operation","toc":{"enable":true,"maxDepth":3,"headings":null},"data":{},"catalogInfo":null,"link":"/openapi/receiving/operation/searchPackages/","sidebarName":"training","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"receiving","id":"receiving","title":"receiving","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}