{"items":[{"type":"link","fsPath":"v2/index.md","metadata":{"type":"markdown"},"label":"Home","link":"/v2","routeSlug":"/v2"},{"type":"group","label":"Getting started","items":[{"type":"link","fsPath":"v2/authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/v2/authentication","routeSlug":"/v2/authentication"},{"type":"link","fsPath":"v2/integration.md","metadata":{"type":"markdown"},"label":"Integration","link":"/v2/integration","routeSlug":"/v2/integration"},{"type":"link","fsPath":"v2/parameterguide.md","metadata":{"type":"markdown"},"label":"Parameter Guide","link":"/v2/parameterguide","routeSlug":"/v2/parameterguide"},{"type":"link","fsPath":"v2/errors.md","metadata":{"type":"markdown"},"label":"Errors & Rate Limits","link":"/v2/errors","routeSlug":"/v2/errors"}]},{"type":"group","label":"API Reference","items":[{"type":"link","label":"ShipSaving New API","link":"/v2/openapi","routeSlug":"/v2/openapi"},{"type":"group","label":"Authentication","link":"/v2/openapi/authentication","routeSlug":"/v2/openapi/authentication","items":[{"label":"Get Access Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/authentication/getaccesstoken","routeSlug":"/v2/openapi/authentication/getaccesstoken","metadata":{"seo":{"title":"Get Access Token","description":"Issue a short-lived access token using the OAuth 2.1 Client Credentials grant."}},"httpPath":"/oauth2/token"}]},{"type":"group","label":"Shipment","link":"/v2/openapi/shipment","routeSlug":"/v2/openapi/shipment","items":[{"label":"Batch Quick Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/batchquickrate","routeSlug":"/v2/openapi/shipment/batchquickrate","metadata":{"seo":{"title":"Batch Quick Rate","description":"This endpoint allows you to quickly retrieve shipment rate quotes by providing the from_address_data, to_address_data, package_data and the ship_date.</br>Each API call can include up to 10 individual rate requests."}},"httpPath":"/api/shipment/batch/quick_rate"},{"label":"Get Rates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/getrates","routeSlug":"/v2/openapi/shipment/getrates","metadata":{"seo":{"title":"Get Rates","description":"Retrieves shipping rates from all active carriers and service levels under your account, optionally filtered by specified carriers and service levels, and returns results sorted by fastest, cheapest, and other criteria along with any applicable error information."}},"httpPath":"/api/shipment/get_rates"},{"label":"Buy Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/createandpay","routeSlug":"/v2/openapi/shipment/createandpay","metadata":{"seo":{"title":"Buy Label","description":"Creates and pays for a shipment label using the rate_id obtained from a prior get_rates call.This endpoint also allows purchasing shipment insurance in the same request (insurance cannot be purchased separately). </br>"}},"httpPath":"/api/shipment/create_and_pay"},{"label":"Directly Buy Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/directbuy","routeSlug":"/v2/openapi/shipment/directbuy","metadata":{"seo":{"title":"Directly Buy Label","description":"Creates and purchases a shipment label in a single step without calling get_rates separately. </br>"}},"httpPath":"/api/shipment/direct_buy"},{"label":"Void Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/voidlabel","routeSlug":"/v2/openapi/shipment/voidlabel","metadata":{"seo":{"title":"Void Label","description":"This endpoint allows voiding label by providing eithershipment_no or platform_uk_id. Only one parameter is required to uniquelyidentify a shipment."}},"httpPath":"/api/shipment/void_label"},{"label":"Query Insurance Rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/shipment/paths/~1api~1shipment~1insurance~1rate/get","routeSlug":"/v2/openapi/shipment/paths/~1api~1shipment~1insurance~1rate/get","metadata":{"seo":{"title":"Query Insurance Rate","description":"Query Insurance Rate"}},"httpPath":"/api/shipment/insurance/rate"}]},{"type":"group","label":"Tracking","link":"/v2/openapi/tracking","routeSlug":"/v2/openapi/tracking","items":[{"label":"Query Shipment Tracking Status by `platform_uk_id`\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/tracking/getshipmenttrackingbyplatformukid","routeSlug":"/v2/openapi/tracking/getshipmenttrackingbyplatformukid","metadata":{"seo":{"title":"Query Shipment Tracking Status by `platform_uk_id`\n","description":"Indicates the current location or state of a package within the supply chain (e.g., in_transit, out for delivery).Use the tracking status object to monitor shipment progress.In test mode, this API will return fixed mock data to facilitate testing and integration validation."}},"httpPath":"/api/shipment/tracking_by_platform_uk_id"},{"label":"Query tracking status by tracking no","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/tracking/getshipmenttrackingbytrackingno","routeSlug":"/v2/openapi/tracking/getshipmenttrackingbytrackingno","metadata":{"seo":{"title":"Query tracking status by tracking no","description":"Retrieves the shipment’s tracking status, event history, estimated delivery date, and associated origin/destination location details as reported by the carrier."}},"httpPath":"/api/shipment/tracking_by_tracking_no"},{"label":"Query tracking status by tracking no (with UTC offset)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/tracking/getshipmenttrackingwithutcoffset","routeSlug":"/v2/openapi/tracking/getshipmenttrackingwithutcoffset","metadata":{"seo":{"title":"Query tracking status by tracking no (with UTC offset)","description":"Retrieves the current shipment tracking event, first scan tracking event, and thecomplete tracking event history as reported by the carrier."}},"httpPath":"/api/shipment/direct/tracking_by_tracking_no"},{"label":"Submit Proof of Delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/tracking/submitpod","routeSlug":"/v2/openapi/tracking/submitpod","metadata":{"seo":{"title":"Submit Proof of Delivery","description":"Submits a Proof of Delivery request for a delivered shipment. Only USPS (carrier_code = USPS) is supported today; other carriers are rejected with a business error."}},"httpPath":"/api/shipment/submit_pod"}]},{"type":"group","label":"Pickup","link":"/v2/openapi/pickup","routeSlug":"/v2/openapi/pickup","items":[{"label":"Schedule pickup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/pickup/addpickupbyshipment","routeSlug":"/v2/openapi/pickup/addpickupbyshipment","metadata":{"seo":{"title":"Schedule pickup","description":"Create a USPS Carrier Pickup request using existing shipment information. This endpoint schedules a postal carrier to pick up eligible packages on the next USPS delivery day.For all possible error codes returned by this endpoint, see Appendix – Pickup Error Codes."}},"httpPath":"/api/shipment/pickup/add"},{"label":"Cancel pickup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/pickup/cancelpickup","routeSlug":"/v2/openapi/pickup/cancelpickup","metadata":{"seo":{"title":"Cancel pickup","description":"Cancel a previously scheduled carrier pick up. A carrier pickup can no longer be updated or cancelled once cancelled. It requires no additional parameters other than the pickup_no. The status will change to CANCELED on success.For all possible error codes returned by this endpoint, see Appendix – Pickup Error Codes."}},"httpPath":"/api/shipment/pickup/cancel"},{"label":"Retrieve pickup records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/pickup/getpickuplist","routeSlug":"/v2/openapi/pickup/getpickuplist","metadata":{"seo":{"title":"Retrieve pickup records","description":"Fetches a paginated list of pickup records created in the system.This endpoint supports optional filters such as USPS confirmation number,pickup status, and carrier code. Pagination parameters (page and page_size)allow controlling the size of the returned dataset, and the order_by flagdetermines the sorting order of the results."}},"httpPath":"/api/shipment/pickup/list"},{"label":"Get package location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/pickup/getpackagelocation","routeSlug":"/v2/openapi/pickup/getpackagelocation","metadata":{"seo":{"title":"Get package location","description":"Returns the list of valid package location enum values. These values indicate where the packages will be placed at the pickup address for the USPS carrier to retrieve during the scheduled pickup."}},"httpPath":"/api/shipment/pickup/package/location/list"}]},{"type":"group","label":"Address Validation","link":"/v2/openapi/address-validation","routeSlug":"/v2/openapi/address-validation","items":[{"label":"Address Validation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/address-validation/validateaddress","routeSlug":"/v2/openapi/address-validation/validateaddress","metadata":{"seo":{"title":"Address Validation","description":"The Address Validation API checks the validity of U.S. domestic addressesand returns standardized address components in accordance with USPS®addressing standards.This helps improve delivery accuracy, reduce undeliverable mail, andsupport consistent pricing for shipping and logistics."}},"httpPath":"/api/address/validate"}]},{"type":"group","label":"SCAN Form","link":"/v2/openapi/scan-form","routeSlug":"/v2/openapi/scan-form","items":[{"label":"Create USPS SCAN Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v2/openapi/scan-form/createscanform","routeSlug":"/v2/openapi/scan-form/createscanform","metadata":{"seo":{"title":"Create USPS SCAN Form","description":"Creates a USPS SCAN Form (PS Form 5630) for a set of already-purchased shipments and returns the URL of the generated manifest PDF. A SCAN Form is a single manifest barcode that consolidates multiple shipments so the carrier can accept the whole batch with one scan at drop-off."}},"httpPath":"/api/scan_form/create_scan_form"}]}]},{"type":"link","fsPath":"v2/changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/v2/changelog","routeSlug":"/v2/changelog"},{"type":"link","fsPath":"v2/appendix.md","metadata":{"type":"markdown"},"label":"Appendix","link":"/v2/appendix","routeSlug":"/v2/appendix"}]}