changedOutput schema / properties / AltRates / items / properties / Error / description
Previous value: -"This will only be returne inside AltRates, never the main Rate return. When running RATESHOP, this is set to indicate that one of the candidate rates did not return a successful result and is skipped. Having this means that the winning rate may not be fully optimal as we have some methods fail to obtain a rate for comparison. It is up to calling logic to decide to proceed or force user to solve the failure."New value: +"Error message indicating a rate could not be obtained. Can appear on both AltRates and the main Rate. On AltRate: a candidate method failed (e.g. during RATESHOP evaluation) — the winning Rate may not be fully optimal. On main Rate: the specifically-requested method is unavailable on this route (service unavailable). Transportation will be 0. Callers must check Rate.Error before treating Rate as a valid quote."
changedOutput schema / properties / AltRates / items / properties / Provider / description
Previous value: -"This typically will indicate that this rate is supplied by a e-commerce marketplace like Amazon or Walmart that supplied their own shipping labels"New value: +"Present when the rate comes from a marketplace's carrier account. The value is the marketplace name in lowercase (e.g. \"amazon\", \"ebay\", \"walmart\", \"tiktok\") — NOT the literal string \"MARKETPLACE\". Absent or empty when the rate comes from the seller's own native carrier account. Note: if you set Provider in the request, you already know the source — this response field is mainly useful when Provider was omitted and you need to detect whether the profile's default used a marketplace rate."
changedOutput schema / properties / Rate / description
Previous value: -"Rate for the requested method when it succeeded. Absent means the requested method failed — inspect AltRates for carrier suggestions. For RATESHOP, this is the winning (lowest-cost) candidate."New value: +"Rate for the requested method. If present with Error set, the method is unavailable on this route (Transportation=0) — treat as a failure. If absent, the requested method failed — inspect AltRates for carrier suggestions. For RATESHOP, this is the winning (lowest-cost) candidate."
changedOutput schema / properties / Rate / properties / Error / description
Previous value: -"This will only be returne inside AltRates, never the main Rate return. When running RATESHOP, this is set to indicate that one of the candidate rates did not return a successful result and is skipped. Having this means that the winning rate may not be fully optimal as we have some methods fail to obtain a rate for comparison. It is up to calling logic to decide to proceed or force user to solve the failure."New value: +"Error message indicating a rate could not be obtained. Can appear on both AltRates and the main Rate. On AltRate: a candidate method failed (e.g. during RATESHOP evaluation) — the winning Rate may not be fully optimal. On main Rate: the specifically-requested method is unavailable on this route (service unavailable). Transportation will be 0. Callers must check Rate.Error before treating Rate as a valid quote."
changedOutput schema / properties / Rate / properties / Provider / description
Previous value: -"This typically will indicate that this rate is supplied by a e-commerce marketplace like Amazon or Walmart that supplied their own shipping labels"New value: +"Present when the rate comes from a marketplace's carrier account. The value is the marketplace name in lowercase (e.g. \"amazon\", \"ebay\", \"walmart\", \"tiktok\") — NOT the literal string \"MARKETPLACE\". Absent or empty when the rate comes from the seller's own native carrier account. Note: if you set Provider in the request, you already know the source — this response field is mainly useful when Provider was omitted and you need to detect whether the profile's default used a marketplace rate."
changedOutput schema / properties / Warnings / description
Previous value: -"optional warning message, you can safely ignore"New value: +"Warnings about the rate response. When the main Rate has Error set (service unavailable), Warnings contains the specific reason the carrier cannot service this route."