Skip to main content

Get Resolution Defaults

GET 

/api/repairs/:repair/lines/:line/resolution-defaults

Returns the suggested resolution for a unit, based on its warranty coverage and whether the product is discontinued: the suggested outcome, credit type and amount, the replacement product, whether an ownership disposition is required, and the coverage reasons.

Required scope: repairs:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Response fields:

  • suggested_outcome (string|null) — an outcome value, e.g. unrepairable_credited for a discontinued product.
  • suggested_credit_type (string|null) — refund, store_credit or discount_offer.
  • suggested_credit_amount (number|null) — the unit's value from the original order, already converted into credit_currency.
  • credit_currency (string|null) — the currency suggested_credit_amount is denominated in: the store's currency for store_credit (its wallet is always kept there), the original order's own currency for refund, null for discount_offer (percentage-based, no amount). Submit credit_amount back in this same currency.
  • product_discontinued (boolean).
  • replacement_product_id (integer) and component_product_id (integer|null).
  • performed_service (string|null) — derived from the suggested outcome.
  • requires_ownership_disposition (boolean) — true when a customer-owned unit is on hand, so replacing it needs an ownership_disposition.
  • unit_received (boolean) — the unit is on hand or at a vendor.
  • reasons (string[]) — coverage reasons.
  • credit_options (object) — per-credit-type amount + currency, keyed store_credit, refund, discount_offer (each {amount: number|null, currency: string|null}). Lets the caller show/submit the right figure for whichever credit type is chosen, not just the suggested one; discount_offer is always {amount: null, currency: null} since it is percentage-based.

Authentication: Bearer token with the repairs:read scope.

Request​

Responses​

OK

Response Headers
    Content-Type