Shopping Ads and free listings return settings

We would like to introduce the beta version of the Merchant API. It is the new version of the Content API for Shopping and the future.

For information about how Merchant API can improve your integration and how you can help shape the future, see Announcing the Merchant API Beta.

If you list products through Shopping Ads or free listings, you can use returnpolicyonline to create, view, edit, or delete online return policies with the following attributes:

• Target countries
• Restocking fees
• Return methods
• Return item condition
• Return reason category
• Return policy URLs

Products sold through Shopping Ads or free listings don't require a return address.

See Set up your return policies for Shopping ads and free listings for more details.

list

You can use returnpolicyonline.list to list all your existing online return policies. To view a specific return policy by ID, see get.

GET https://shoppingcontent.googleapis.com/content/v2.1/merchantId/returnpolicyonline

Here's a sample response:

{
 "returnPolicies": [
   {
     "returnPolicyId": "transactions:US:default",
     "label": "default",
     "countries": [
       "GB"
     ],
     "policy": {
       "type": "NUMBER_OF_DAYS_AFTER_DELIVERY",
       "days": "90"
     },
     "restockingFee": {
       "fixedFee": {
         "value": "5.99",
         "currency": "GBP"
       }
     },
     "returnMethods": [
       "IN_STORE",
       "BY_MAIL"
     ],
     "itemConditions": [
       "NEW",
       "USED"
     ],
     "returnReasonCategoryInfo": [
       {
         "returnReasonCategory": "ITEM_DEFECT",
         "returnLabelSource": "DOWNLOAD_AND_PRINT",
         "returnShippingFee": {
           "type": "FIXED",
           "fixedFee": {
             "value": "0.00",
             "currency": "GBP"
           }
         }
       },
       {
         "returnReasonCategory": "BUYER_REMORSE",
         "returnLabelSource": "DOWNLOAD_AND_PRINT",
         "returnShippingFee": {
           "type": "FIXED",
           "fixedFee": {
             "value": "0.00",
             "currency": "GBP"
           }
         }
       }
     ],
     "returnPolicyUri": "https://www.example.com/return-policy"
   },
   {
     "returnPolicyId": "transactions:US:default",
     "label": "default120days",
     "countries": [
       "US",
       "FR"
     ],
     "name": "returnpolicy120days",
     "policy": {
       "type": "NUMBER_OF_DAYS_AFTER_DELIVERY",
       "days": "90"
     },
     "restockingFee": {
       "fixedFee": {
         "value": "0.00",
         "currency": "USD"
       }
     },
     "returnMethods": [
       "BY_MAIL"
     ],
     "itemConditions": [
       "NEW",
       "USED"
     ],
     "returnReasonCategoryInfo": [
       {
         "returnReasonCategory": "ITEM_DEFECT",
         "returnLabelSource": "DOWNLOAD_AND_PRINT",
         "returnShippingFee": {
           "type": "FIXED",
           "fixedFee": {
             "value": "0.00",
             "currency": "USD"
           }
         }
       },
       {
         "returnReasonCategory": "BUYER_REMORSE",
         "returnLabelSource": "DOWNLOAD_AND_PRINT",
         "returnShippingFee": {
           "type": "FIXED",
           "fixedFee": {
             "value": "0.00",
             "currency": "USD"
           }
         }
       }
     ],
     "returnPolicyUri": "https://www.example.com/return-policy"
   }
 ]
}

get

You can use returnpolicyonline.get to get a specific return policy by returnPolicyId. This method returns a single return policy. To view all your return policies at once, see list.

GET https://shoppingcontent.googleapis.com/content/v2.1/merchantId/returnpolicyonline/returnPolicyId

Here's a sample response:

{
  "returnPolicyId": "transactions:US:default",
  "label": "default",
  "countries": [
    "US"
  ],
  "policy": {
    "type": "NUMBER_OF_DAYS_AFTER_DELIVERY",
    "days": "90"
  },
  "restockingFee": {
    "fixedFee": {
      "value": "0.00",
      "currency": "USD"
    }
  },
  "returnMethods": [
    "BY_MAIL"
  ],
  "itemConditions": [
    "NEW",
    "USED"
  ],
  "returnReasonCategoryInfo": [
    {
      "returnReasonCategory": "ITEM_DEFECT",
      "returnLabelSource": "DOWNLOAD_AND_PRINT",
      "returnShippingFee": {
        "type": "FIXED",
        "fixedFee": {
          "value": "0.00",
          "currency": "USD"
        }
      }
    },
    {
      "returnReasonCategory": "BUYER_REMORSE",
      "returnLabelSource": "DOWNLOAD_AND_PRINT",
      "returnShippingFee": {
        "type": "FIXED",
        "fixedFee": {
          "value": "0.00",
          "currency": "USD"
        }
      }
    }
  ],
  "returnPolicyUri": "https://www.example.com/return-policy"
}

create

You can use returnpolicyonline.create to add a new return policy. The response includes the updated policy.

POST https://shoppingcontent.googleapis.com/content/v2.1/merchantId/returnpolicyonline

Here's a sample request:

{
  "returnPolicyId": "12345678",
  "label": "default90days",
  "name": "returnpolicy90days",
  "policy": {
    "type": "NUMBER_OF_DAYS_AFTER_DELIVERY",
    "days": "90"
  },
  "countries": [
    "US"
  ],
  "itemConditions": [
    "NEW",
    "USED"
  ],
  "restockingFee": {
    "fixedFee": {
      "currency": "USD",
      "value": "0.00"
    }
  },
  "returnMethods": [
    "BY_MAIL"
  ],
  "returnReasonCategoryInfo": [
    {
      "returnReasonCategory": "ITEM_DEFECT",
      "returnLabelSource": "DOWNLOAD_AND_PRINT",
      "returnShippingFee": {
        "type": "FIXED",
        "fixedFee": {
          "value": "0.00",
          "currency": "USD"
        }
      }
    }
  ],
  "returnPolicyUri": "https://www.example.com/return-policy"
}

Here's a sample response:

{
  "returnPolicyId": "12345678",
  "label": "default90days",
  "countries": [
    "US"
  ],
  "name": "returnpolicy90days",
  "policy": {
    "type": "NUMBER_OF_DAYS_AFTER_DELIVERY",
    "days": "90"
  },
  "restockingFee": {
    "fixedFee": {
      "value": "0.00",
      "currency": "USD"
    }
  },
  "returnMethods": [
    "BY_MAIL"
  ],
  "itemConditions": [
    "NEW",
    "USED"
  ],
  "returnReasonCategoryInfo": [
    {
      "returnReasonCategory": "ITEM_DEFECT",
      "returnLabelSource": "DOWNLOAD_AND_PRINT",
      "returnShippingFee": {
        "type": "FIXED",
        "fixedFee": {
          "value": "0.00",
          "currency": "USD"
        }
      }
    }
  ],
  "returnPolicyUri": "https://www.example.com/return-policy"
}

patch

You can use returnpolicyonline.patch to update an existing online return policy by returnPolicyId.

PATCH https://shoppingcontent.googleapis.com/content/v2.1/merchantId/returnpolicyonline/returnPolicyId

Here's a sample request:

Note: This method call requires a complete returnpolicy object.

{
  "returnPolicyId": "12345678",
  "label": "default90days",
  "countries": [
    "US",
    "FR"
  ],
  "name": "returnpolicy90days",
  "policy": {
    "type": "NUMBER_OF_DAYS_AFTER_DELIVERY",
    "days": "90"
  },
  "restockingFee": {
    "fixedFee": {
      "value": "0.00",
      "currency": "USD"
    }
  },
  "returnMethods": [
    "BY_MAIL"
  ],
  "itemConditions": [
    "NEW",
    "USED"
  ],
  "returnReasonCategoryInfo": [
    {
      "returnReasonCategory": "ITEM_DEFECT",
      "returnLabelSource": "DOWNLOAD_AND_PRINT",
      "returnShippingFee": {
        "type": "FIXED",
        "fixedFee": {
          "value": "0.00",
          "currency": "USD"
        }
      }
    },
    {
      "returnReasonCategory": "BUYER_REMORSE",
      "returnLabelSource": "DOWNLOAD_AND_PRINT",
      "returnShippingFee": {
        "type": "FIXED",
        "fixedFee": {
          "value": "0.00",
          "currency": "USD"
        }
      }
    }
  ],
  "returnPolicyUri": "https://www.example.com/return-policy"
}

Here's a sample response:

{
  "returnPolicyId": "12345678",
  "label": "default90days",
  "countries": [
    "US",
    "FR"
  ],
  "name": "returnpolicy90days",
  "policy": {
    "type": "NUMBER_OF_DAYS_AFTER_DELIVERY",
    "days": "90"
  },
  "restockingFee": {
    "fixedFee": {
      "value": "0.00",
      "currency": "USD"
    }
  },
  "returnMethods": [
    "BY_MAIL"
  ],
  "itemConditions": [
    "NEW",
    "USED"
  ],
  "returnReasonCategoryInfo": [
    {
      "returnReasonCategory": "ITEM_DEFECT",
      "returnLabelSource": "DOWNLOAD_AND_PRINT",
      "returnShippingFee": {
        "type": "FIXED",
        "fixedFee": {
          "value": "0.00",
          "currency": "USD"
        }
      }
    },
    {
      "returnReasonCategory": "BUYER_REMORSE",
      "returnLabelSource": "DOWNLOAD_AND_PRINT",
      "returnShippingFee": {
        "type": "FIXED",
        "fixedFee": {
          "value": "0.00",
          "currency": "USD"
        }
      }
    }
  ],
  "returnPolicyUri": "https://www.example.com/return-policy"
}

delete

You can use returnpolicyonline.delete to delete an existing online return policy by returnPolicyId. This method returns a 200 code if the request is successful, and a 404 code if the request encounters an error.

DELETE https://shoppingcontent.googleapis.com/content/v2.1/merchantId/returnpolicyonline/returnPolicyId

Here's a sample request:

{
  "error": {
    "code": "404",
    "message": "Return policy not found.",
    "status": "NOT_FOUND",
    "details": [
      {
        "type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "notFound",
        "domain": "global"
      }
    ]
  }
}