{"items":[{"type":"link","label":"Transaction Report APIs","link":"/openapi/transactionreport","routeSlug":"/openapi/transactionreport","content":{"contentType":"overview","meta":{"name":"Transaction Report APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"transactionreport.json","url":"/_bundle/openapi/transactionreport.json?download"},{"kind":"download","label":"transactionreport.yaml","url":"/_bundle/openapi/transactionreport.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Transaction Report APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Transaction Report APIs provide operations to retrieve transaction data for funds, shipments, and stamps within a specified date range. These APIs enable access to historical transaction records for reporting, reconciliation, and operational analysis."}],"sectionId":"/openapi/transactionreport"}],"sectionId":"/openapi/transactionreport"}]}]}},{"type":"group","label":"Transaction Report","link":"/openapi/transactionreport/transaction-report","routeSlug":"/openapi/transactionreport/transaction-report","items":[{"label":"Get Funds Transaction Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactionreport/transaction-report/getfundstransactionreport","routeSlug":"/openapi/transactionreport/transaction-report/getfundstransactionreport","metadata":{"seo":{"title":"Get Funds Transaction Report","description":"This Operation returns the report of funds transactions within the specified date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFundsTransactionReport","name":"Get Funds Transaction Report","isWebhook":false,"pointer":"/paths/~1api~1v1~1funds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Funds Transaction Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This Operation returns the report of funds transactions within the specified date range."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_421","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date for the transaction report, in UTC format (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-08-01T00:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"endDate","in":"query","schemaId":"schema_421","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date for the transaction report, in UTC format (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-08-15T23:59:59Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_422","description":"Maximum number of records to return per page."},{"name":"page","in":"query","schemaId":"schema_423","description":"Page number to fetch in paginated results."}],"pointer":"/paths/~1api~1v1~1funds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/funds","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","required":false,"schemaId":"schema_421"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_421"},{"name":"size","in":"query","required":false,"example":10,"schemaId":"schema_422"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_423"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/funds","href":"transaction-report/getfundstransactionreport","openApiOperationId":"getFundsTransactionReport","summary":"Get Funds Transaction Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrived the Fund Transaction Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundTransactionReportResponse"}},"schemaId":"components/schemas/FundTransactionReportResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1funds/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FundTransactionReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundTransactionReportResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-report/getfundstransactionreport"}],"panels":[]}]},"httpPath":"/api/v1/funds"},{"label":"Get Shipment Transaction Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactionreport/transaction-report/getshipmenttransactionreport","routeSlug":"/openapi/transactionreport/transaction-report/getshipmenttransactionreport","metadata":{"seo":{"title":"Get Shipment Transaction Report","description":"This Operation returns the report of shipments transactions within the specified date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipmentTransactionReport","name":"Get Shipment Transaction Report","isWebhook":false,"pointer":"/paths/~1api~1v1~1shipments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Shipment Transaction Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This Operation returns the report of shipments transactions within the specified date range."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_421","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date for the transaction report, in UTC format (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-08-01T00:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). default start date is today."},"children":[]}]}]}]},{"name":"endDate","in":"query","schemaId":"schema_421","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date for the transaction report, in UTC format (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-08-15T23:59:59Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Default end date is today."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_424","description":"Number of transaction reports per page. Used for pagination."},{"name":"page","in":"query","schemaId":"schema_425","description":"Page number to fetch in paginated results."},{"name":"carrier","in":"query","schemaId":"schema_426","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shipments transaction report by carrier code (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FEDEX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"insurance","in":"query","schemaId":"schema_427","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shipments by insurance status. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for insured shipments, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]},{"name":"returnLabel","in":"query","schemaId":"schema_428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shipments that include return labels. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return only shipments with return labels, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]},{"name":"isInternational","in":"query","schemaId":"schema_427","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter shipments by type. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for international shipments, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for domestic shipments."},"children":[]}]}]}]},{"name":"refundEligible","in":"query","schemaId":"schema_427","description":"Filter shipments eligible for refund."},{"name":"merchant","in":"query","schemaId":"schema_427","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter merchant shipments transaction report."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Returns shipment transaction reports for all merchants associated with the developer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view the transaction report for a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-Developer-Partner-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the value set to that merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"shipmentType","in":"query","schemaId":"schema_429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by shipment type. Accepted values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipiece"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": multi-piece shipments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Adjusted Posted Value (APV) shipments"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, all shipment types are returned."},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1v1~1shipments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_430","description":"This is the Developer Partner ID."}],"pointer":"/paths/~1api~1v1~1shipments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/shipments","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","required":false,"schemaId":"schema_421"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_421"},{"name":"size","in":"query","required":false,"example":10,"schemaId":"schema_424"},{"name":"page","in":"query","required":false,"example":"1","schemaId":"schema_425"},{"name":"carrier","in":"query","required":false,"example":"UPS","schemaId":"schema_426"},{"name":"insurance","in":"query","required":false,"example":true,"schemaId":"schema_427"},{"name":"returnLabel","in":"query","required":false,"example":false,"schemaId":"schema_428"},{"name":"isInternational","in":"query","required":false,"example":true,"schemaId":"schema_427"},{"name":"refundEligible","in":"query","required":false,"example":true,"schemaId":"schema_427"},{"name":"merchant","in":"query","required":false,"example":true,"schemaId":"schema_427"},{"name":"shipmentType","in":"query","required":false,"example":"apv","schemaId":"schema_429"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_430"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/shipments","href":"transaction-report/getshipmenttransactionreport","openApiOperationId":"getShipmentTransactionReport","summary":"Get Shipment Transaction Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrived the Shipments Transaction Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentTransactionReportResponse"}},"schemaId":"components/schemas/ShipmentTransactionReportResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1shipments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShipmentTransactionReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShipmentTransactionReportResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-report/getshipmenttransactionreport"}],"panels":[]}]},"httpPath":"/api/v1/shipments"},{"label":"Get Stamps Transaction Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactionreport/transaction-report/getstamptransactionreport","routeSlug":"/openapi/transactionreport/transaction-report/getstamptransactionreport","metadata":{"seo":{"title":"Get Stamps Transaction Report","description":"This Operation returns the report of stamps transactions within the specified date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStampTransactionReport","name":"Get Stamps Transaction Report","isWebhook":false,"pointer":"/paths/~1api~1v1~1stamps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Stamps Transaction Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This Operation returns the report of stamps transactions within the specified date range."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_421","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date for the transaction report, in UTC format (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-08-01T00:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). default start date is today."},"children":[]}]}]}]},{"name":"endDate","in":"query","schemaId":"schema_421","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date for the transaction report, in UTC format (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-08-15T23:59:59Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Default end date is today."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_424","description":"Number of transaction reports per page. Used for pagination."},{"name":"page","in":"query","schemaId":"schema_431","description":"Page number to fetch in paginated results."},{"name":"refundEligible","in":"query","schemaId":"schema_427","description":"Filter shipments eligible for refund."}],"pointer":"/paths/~1api~1v1~1stamps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stamps","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","required":false,"schemaId":"schema_421"},{"name":"endDate","in":"query","required":false,"schemaId":"schema_421"},{"name":"size","in":"query","required":false,"example":10,"schemaId":"schema_424"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_431"},{"name":"refundEligible","in":"query","required":false,"example":true,"schemaId":"schema_427"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/stamps","href":"transaction-report/getstamptransactionreport","openApiOperationId":"getStampTransactionReport","summary":"Get Stamps Transaction Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrived the Stamps Transaction Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StampsTransactionReportResponse"}},"schemaId":"components/schemas/StampsTransactionReportResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1stamps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StampsTransactionReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StampsTransactionReportResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-report/getstamptransactionreport"}],"panels":[]}]},"httpPath":"/api/v1/stamps"}],"content":{"contentType":"group","meta":{"name":"Transaction Report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction Report","showPageActions":true},{"nodeType":"markdoc","content":"APIs for retrieving transaction reports related to funds, shipments, and stamps."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/funds","summary":"Get Funds Transaction Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction-report/getfundstransactionreport","deprecated":false},{"title":"/api/v1/shipments","summary":"Get Shipment Transaction Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction-report/getshipmenttransactionreport","deprecated":false},{"title":"/api/v1/stamps","summary":"Get Stamps Transaction Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction-report/getstamptransactionreport","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/FundTransactionReportResponse":{"id":"components/schemas/FundTransactionReportResponse","kind":"json-schema","title":"FundTransactionReportResponse","data":{"type":"object","properties":{"data":{"type":"array","description":"List of funds transaction records.","items":{"type":"object","properties":{"transactionCreatedDate":{"type":"string","format":"date-time","description":"Timestamp when the transaction was created (UTC).","example":"2025-07-01T10:21:59.281Z"},"transactionId":{"type":"string","description":"Unique identifier of the transaction.","example":"T6TjUuWc7SKtluqMDCEPw"},"amount":{"type":"number","description":"Monetary value of the transaction.","example":10},"currency":{"type":"string","description":"Currency code (ISO 4217).","example":"USD"},"status":{"type":"string","description":"Status of the transaction.","example":"SUCCESS"},"previousBalance":{"type":"object","description":"Balance before this transaction.","properties":{"amount":{"type":"number","format":"float","description":"Previous balance amount.","example":876.45},"currency":{"type":"string","description":"Currency of the previous balance.","example":"USD"}}},"fundingType":{"type":"string","description":"Mode of funding (e.g., MANUAL, AUTO).","example":"MANUAL"},"subCarrierId":{"type":"string","description":"Identifier of the sub-carrier associated with the transaction.","example":"EQ7Ar2dmDoM"},"userDetails":{"type":"object","description":"Details of the user who initiated the transaction.","properties":{"userId":{"type":"string","description":"Unique identifier of the user.","example":"00u1wtu8b0dvXQKv70h8"},"email":{"type":"string","format":"email","description":"Email address of the user.","example":"apitest_jpmc@yopmail.com"},"subscriptionId":{"type":"string","description":"Subscription ID linked to the user.","example":"sac4c3a"},"locationId":{"type":"string","description":"Location identifier of the user.","example":"63gE8OBe3RA"},"locationBpn":{"type":"string","description":"BPN of the location.","example":"0018210657"},"locationName":{"type":"string","description":"Name of the location.","example":"L1"}}},"dispenseClient":{"type":"string","description":"Client through which the funds were dispensed. (e.g., API, PB, PITNEYSHIP-PRO)","example":"PB"}}}},"pageInfo":{"type":"object","description":"Pagination details for the transaction report.","properties":{"total":{"type":"integer","description":"Total number of records available.","example":2},"pages":{"type":"integer","description":"Total number of pages.","example":1},"page":{"type":"integer","description":"Current page number.","example":1},"pageSize":{"type":"integer","description":"Number of records per page.","example":10}}}}}},"components/schemas/ShipmentTransactionReportResponse":{"id":"components/schemas/ShipmentTransactionReportResponse","kind":"json-schema","title":"ShipmentTransactionReportResponse","data":{"type":"object","properties":{"data":{"type":"array","description":"List of shipment transactions.","items":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique identifier assigned by the shipping system to the transaction.","example":"2e95966e870e4a40bba8c76bac0f667e"},"fromAddress":{"type":"object","description":"The complete address of the Sender.","properties":{"name":{"type":"string","description":"The name of the Sender to which this address points.","example":"Sender Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1600 Amphitheatre Parkway"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"company":{"type":"string","description":"The name of the company, in case if the senders address is not residential.","example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be senders's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"6502530000"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Sender's address belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Mountain View"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"CA"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Postal Code or ZIP Code of the address. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 10"},"children":[]}]}]}],"example":"94043"},"inductionPostalCode":{"type":"string","description":"The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the \"fromAddress\", it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the \"fromAddress\" will be used.\n","example":"06905"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the sender's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true}}},"toAddress":{"type":"object","description":"The complete address of the Recipient.","properties":{"name":{"type":"string","description":"The name of the Recipient.","example":"Recipient Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Recipient. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"350 Fifth Avenue"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Recipient belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New York"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"NY"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The Postal Code or ZIP Code of the address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'.\""},"children":[]}]}]}],"example":"10118"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the recipient's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. \""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential.","example":"PB"},"phone":{"type":"string","description":"This is Recipient's phone number. Enter the digits with or without spaces or hyphens.","example":"332 555-1212"},"email":{"type":"string","description":"This must be recipient's valid email. Email is required if the customer is using GoFor Carrier.","example":"recipient@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"isPOBox":{"type":"boolean","description":"Checks if the specified address has the PO Box. In case if Yes, the boolean value will be 'true', else it will take 'false'.","example":true}}},"parcelTrackingNumber":{"type":"string","description":"Tracking number assigned to the parcel by the carrier.","example":"400000665101"},"service":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"NDA_AM"},"rates":{"type":"array","description":"Rate details applied to the shipment.","items":{"type":"object","properties":{"baseCharge":{"type":"number","description":"Base service charge applied by the carrier.","example":113.92},"carrier":{"type":"string","description":"Name of the carrier providing the rate.","example":"Purolator"},"serviceId":{"type":"string","description":"Identifier of the carrier's service.","example":"NDA_AM"},"serviceName":{"type":"string","description":"Full name of the carrier's service.","example":"Purolator Express® 9AM"},"surcharges":{"type":"array","description":"List of surcharges applied to the rate.","items":{"type":"object","properties":{"fee":{"type":"number","description":"Amount of the surcharge.","example":28.41},"name":{"type":"string","description":"Type of surcharge.","example":"Fuel"}}}},"totalCarrierCharge":{"type":"number","description":"Total amount payable to the carrier, including surcharges.","example":154.12},"totalTaxAmount":{"type":"number","description":"Total tax applied on the charges.","example":7.34},"isHazmat":{"type":"boolean","description":"Indicates if the shipment contains hazardous materials.","example":false}}}},"shipmentId":{"type":"string","description":"Unique identifier of the shipment."},"shipmentOptions":{"type":"object","description":"Additional shipment options."},"status":{"type":"string","description":"Current status of the shipment.","example":"Label Printed"},"metadata":{"type":"array","description":"Additional metadata that needs to be stored for this shipment can be added here. For now, 'Cost Account Name' is supported.","items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"cost account 123"}}}},"parcel":{"type":"object","description":"Details of the parcel being rated.","properties":{"length":{"type":"number","example":2},"height":{"type":"number","example":1},"width":{"type":"number","example":1},"dimUnit":{"type":"string","example":"IN"},"weightUnit":{"type":"string","example":"OZ"},"weight":{"type":"number","example":2},"packageValue":{"type":"number","example":2}}},"dispenseClient":{"type":"string","description":"Client/system used to create the shipment.","example":"api"},"refundStatus":{"type":"string","description":"Refund status of the shipment."},"isInternational":{"type":"boolean","description":"Indicates whether the shipment is international."},"insured":{"type":"boolean","description":"Indicates if the shipment is insured."},"carrierCode":{"type":"string","description":"Code of the carrier handling the shipment."},"transactionCreateDate":{"type":"string","format":"date-time","description":"Date and time when the shipment transaction was created."},"locationId":{"type":"string","description":"Identifier of the location where the shipment originated."}}}},"pageInfo":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of records available.","example":1},"pages":{"type":"integer","description":"The total number of pages calculated based on pageSize.","example":2},"page":{"type":"integer","description":"The current page number being returned.","example":1},"pageSize":{"type":"integer","description":"The number of records per page.","example":1}}}}}},"components/schemas/StampsTransactionReportResponse":{"id":"components/schemas/StampsTransactionReportResponse","kind":"json-schema","title":"StampsTransactionReportResponse","data":{"type":"array","items":{"type":"object","description":"Details of a stamp transaction record.","properties":{"stamps":{"type":"object","description":"Details about the generated stamp and shipment.","properties":{"stampId":{"type":"string","description":"Unique identifier of the stamp.","example":"USPS2201368505487673"},"fromAddress":{"type":"object","description":"Sender's address details.","properties":{"addressLines":{"type":"array","items":{"type":"string"},"description":"Street address lines of the sender.","example":["24182 Kathy Ave"]},"cityTown":{"type":"string","description":"City or town of the sender.","example":"Lake Forest"},"stateProvince":{"type":"string","description":"State or province of the sender.","example":"CA"},"postalCode":{"type":"string","description":"Postal or ZIP code.","example":"92630-1827"},"countryCode":{"type":"string","description":"Country code in ISO 2-letter format.","example":"US"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender’s name."},"children":[]}]}]}],"example":"Steve Smith"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender’s phone number."},"children":[]}]}]}],"example":"1112223334"},"residential":{"type":"boolean","description":"Indicates if the address is residential.","example":false},"lastVerifiedDate":{"type":"string","format":"date-time","description":"Date when the address was last verified.","example":"0001-01-01T00:00:00Z"}}},"parcelWeight":{"type":"object","description":"Weight details of the parcel.","properties":{"unitOfMeasurement":{"type":"string","description":"Weight unit of measurement.","example":"OZ"},"weight":{"type":"number","description":"Weight of the parcel.","example":2}}},"parcelDimension":{"type":"object","nullable":true,"description":"Dimensions of the parcel, if provided."},"rate":{"type":"object","description":"Rate and service details.","properties":{"carrier":{"type":"string","description":"Carrier handling the shipment.","example":"USPS"},"parcelType":{"type":"string","description":"Type of parcel (e.g., LTR, PKG).","example":"LTR"},"parcelName":{"type":"string","description":"Human-readable name for the parcel type.","example":"Letter"},"serviceId":{"type":"string","description":"The unique identifier given to the carrier specific service.","example":"FCM"},"serviceName":{"type":"string","description":"Name of the shipping service.","example":"First-Class Mail®"},"specialServices":{"type":"array","description":"List of special services applied.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"Unique identifier of the special service.","example":"ERR"},"brandedName":{"type":"string","description":"Branded name of the service.","example":"ERR"},"fee":{"type":"number","description":"Service fee.","example":2.82},"appliedFactor":{"type":"object","description":"Applied factor for fee calculation.","properties":{"value":{"type":"object","description":""}}}}}},"baseCharge":{"type":"number","description":"Base shipping charge.","example":1.03},"totalCarrierCharge":{"type":"number","description":"Total carrier charge including base and services.","example":11.15},"rateTypeId":{"type":"string","description":"Rate type applied to the shipment.","example":"METERED_RATE"}}},"toAddress":{"type":"object","description":"The complete address of the Recipient.","properties":{"name":{"type":"string","description":"The name of the Recipient.","example":"Recipient Name"},"addressLine1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Recipient. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"350 Fifth Avenue"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O. Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the city or town the Recipient belongs to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New York"},"stateProvince":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The name of the State or Province the Sender belongs to. It is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" State or Province Code for US or Canadian address(es)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please switch to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" radio button, enter the required country name or country code, and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button . "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#iso:code:3166:CA","description":"List of Province with their Province/State Codes."},"example":"NY"},"postalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The Postal Code or ZIP Code of the address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For CA addresses, use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"six-character"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alphanumeric string Postal Code in this format: 'A1A 1A1'."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" While for US addresses, use either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9-digit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ZIP Code in one of the following formats: '12345' or '12345-6789'.\""},"children":[]}]}]}],"example":"10118"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The country in which the recipient's address is located. The value will be the two-character ISO Code of the country from the ISO country list. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Below is the hyperlink, please select "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Country codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then click "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button. \""},"children":[]}]}]}],"externalDocs":{"url":"https://www.iso.org/obp/ui/#search","description":"List of Countries with their ISO Codes"},"example":"US"},"company":{"type":"string","description":"The name of the company, in case if the recipient address is not residential.","example":"PB"},"phone":{"type":"string","description":"This is Recipient's phone number. Enter the digits with or without spaces or hyphens.","example":"332 555-1212"},"email":{"type":"string","description":"This must be recipient's valid email. Email is required if the customer is using GoFor Carrier.","example":"recipient@gmail.com"},"residential":{"type":"boolean","description":"The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'.","example":true},"isPOBox":{"type":"boolean","description":"Checks if the specified address has the PO Box. In case if Yes, the boolean value will be 'true', else it will take 'false'.","example":true},"lastVerifiedDate":{"type":"string","format":"date-time","description":"Date when the address was last verified.","example":"0001-01-01T00:00:00Z"}}},"trackingNumber":{"type":"string","description":"Tracking number for the shipment.","example":"9414809898643519098588"},"spoiled":{"type":"boolean","description":"Indicates if the stamp was spoiled.","example":false},"stampOptions":{"type":"array","description":"Additional options for configuring stamp-related settings.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the stamp option.","example":"SHIPPER_ID"},"value":{"type":"string","description":"The corresponding value for the stamp option.","example":"9015256782"}}}}}},"subscriptionId":{"type":"string","description":"Identifier of the subscription associated with the transaction.","example":"sa87bf0"},"locationId":{"type":"string","description":"Location identifier where the transaction was created.","example":"mxpAx49Nd2a"},"userEmail":{"type":"string","description":"User email associated with the transaction.","example":"API-SP360-BweE7YNeKoa-DEV"},"memo":{"type":"string","description":"Memo for the transaction.","example":"mentoTestRef"},"type":{"type":"string","description":"Transaction type (e.g., ERRBarcode).","example":"ERRBarcode"},"envelopeSize":{"type":"string","description":"Size of the envelope used for the stamp.","example":"10"},"transactionId":{"type":"string","description":"Unique identifier of the transaction.","example":"O8K3AEkJDwRwdq39YkqGv"},"correlationId":{"type":"string","description":"Key assigned by the shipping system to the transaction.","example":"60700bcd990b41b2a278b3708f536183"},"transactionCreateDate":{"type":"string","format":"date-time","description":"Date and time when the transaction was created.","example":"2025-08-12T07:24:52.665Z"},"status":{"type":"string","description":"Current status of the transaction.","example":"COMPLETE"},"imageUrl":{"type":"string","description":"URL to the stamp image.","example":"https://prv-labels-cls.gcs.pitneycloud.com/usps/456312111/outbound/stamp/60700bcd990b41b2a278b3708f536183.gif"},"stampsList":{"type":"array","description":"List of stamps created in this transaction."},"printStatus":{"type":"object","description":"Details about print and ledger status.","properties":{"ledgerStatus":{"type":"string","description":"Status of ledger entry.","example":"SUCCESS"},"printStatus":{"type":"boolean","description":"Indicates if the stamp was successfully printed.","example":true},"deviceHub":{"type":"boolean","description":"Indicates if DeviceHub was used.","example":false},"eligibleForRecovery":{"type":"boolean","description":"Indicates if the transaction is eligible for recovery.","example":false}}},"subCarrierID":{"type":"string","description":"Identifier for the sub-carrier (if applicable).","example":"eRMnRx4mzPP"},"dispenseClient":{"type":"string","description":"Client type used for dispensing (e.g., API, UI).","example":"api"},"locationName":{"type":"string","description":"Name of the location where the transaction was created.","example":"Default Location"},"consType":{"type":"integer","description":"Consumer type code associated with the transaction.","example":0}}}}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"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"]}},"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g. validation-error.","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":"Rategrop cannot created."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 01000806."},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceid, or if the information is missing."},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"components/schemas/NotFoundErrors":{"id":"components/schemas/NotFoundErrors","kind":"json-schema","title":"NotFoundErrors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"not_found","description":"Error code(s) that appear due HTTP 404 Page or File not found."},"errorDescription":{"type":"string","example":"resource not found","description":"The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 0100025, 1110017, or 1090001."},"additionalInfo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the error. This error 'Not Found' might appear due to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RateGroup Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Shipments to close"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Original Transaction not found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"schema_421":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"type":"number","example":10,"default":20},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"type":"number","example":1,"default":20},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"type":"number","example":10,"default":10},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"type":"string","example":"1","default":"10"},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"string","example":"UPS"},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"type":"boolean","example":false},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"type":"string","example":"apv"},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"type":"string"},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"type":"number","example":1,"default":10},"id":"schema_431"}},"exampleStore":{},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"},"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/transactionreport.json?download"},{"url":"/_bundle/openapi/transactionreport.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Transaction Report APIs","description":"The Transaction Report APIs provide operations to retrieve transaction data for funds, shipments, and stamps within a specified date range. These APIs enable access to historical transaction records for reporting, reconciliation, and operational analysis."}},"baseSlug":"/openapi/transactionreport","routesMapping":{}}