Skip to content

Get return rules

Request

Returns the merchant's return rules: the configured send-back address, the default follow-up action per return condition (A/B/C), and any SKU-specific overrides.

A merchant can configure a different action for active returns (the customer sent the item back) and passive returns (the item never reached the customer). Both are reported under by_return_type, while A, B and C carry the action that applies whatever the return type, and are null when the two types differ.

Use this endpoint to look up the send-back address before creating a send-back order.

Security
BearerAuth
curl -i -X GET \
  https://developers.hive.app/_mock/merchant-api-v2/mapi_v2_oas31/return_rules \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

The merchant's return rules

Bodyapplication/json
send_back_addressobject or nullrequired

Address that items are sent back to when the follow-up action is send_back. null when no send-back address is configured.

default_rulesobject(ReturnRuleActions)required

Default follow-up action per return condition.

sku_rulesArray of objects(ReturnRuleActions)required

SKU-specific follow-up actions that override the defaults.

Response
{
  "send_back_address": {
    "first_name": "string",
    "last_name": "string",
    "company": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postal_code": "string",
    "province_or_state_code": "string",
    "country_code": "string"
  },
  "default_rules": {
    "A": "dispose",
    "B": "dispose",
    "C": "dispose",
    "by_return_type": { … }
  },
  "sku_rules": [
    { … }
  ]
}