{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-openapi/rategroup.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi/rategroup.yaml","dynamicMarkdocComponents":[],"baseSlug":"/openapi/rategroup","seo":{"title":"RateGroup APIs","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"RateGroup APIs","description":"A RateGroup is used to automate carrier and service selection during shipment processing. Instead of explicitly passing a carrier and service in every request, you can pass a rateGroupId, and get the desired rate (for example, lowest cost or fastest delivery). <br/>\nRateGroups helps with:\n- Atomatic rate shopping across multiple carriers\n- Shipping decision depends on price, speed, or available services at runtime\n\n**How it works**<br/>\n- Create a RateGroup with a list of\n  - carrierCode (e.g., USPS, UPS, FedEx)\n  - serviceId (e.g., PM, FEDEX_GROUND, NDA) <br/>\n\n- Use the returned rateGroupId in\n  - Rate API:  to fetch the best available rate\n  - Create Shipment API:  to generate a shipment using the selected service\n\n- When a rateGroupId is provided in a request, carrier and service selection is handled internally based on the configured items.\n- Evaluation of carrier-service combinations is dynamic and may vary per request depending on shipment attributes such as origin, destination, and parcel details.\n- Only RateGroups with status active are considered for processing.\n- RateGroups are country-specific, and only applicable shipments are evaluated.\n\n> Read [How to Create RateGroup](/docs/rategroup-management/rategroup-guide).\n  \n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.shipping360.pitneybowes.com","port":4000,"ipAddress":"216.73.216.199"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/openapi/rategroup","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}