POST Returns Create

This API can be used to create a return only for channels of type “Offline Store” and cart channels like Shopify etc. For all other channels, Browntape creates the returns automatically via channel integration. The Returns created are always in “return_initiated” status. They can be marked “return_received” by using the Receive returns UI.

Endpoint

API Method: POST

URL: https://app.browntape.com/0.11/itemTitlesOrdersReturns/create.json

Note: This is a version 0.11 endpoint

Params

?username=XXXXXXXXXX
&auth_string=YYYYYYYYY

Payload

[
  {
     "channel_id": 27736, //mandatory
     "order_reference": "ABCD-123", //mandatory
     "sku": "JBRS0344", //mandatory
     "channel_return_qty": 1, //mandatory
     "channel_return_ref": "RET-004",
     "channel_return_reason": "Size issues",
     "executed_shipping_method": "Bluedart Suface",
     "tracking_number": "AWB121899839483",
     "channel_return_date": "2021-08-31 20:00:00"
  }
]

Response

{
   "status_code": 200,
   "success": true,
   "message": "Returns created",
   "data": [
      {
         "id": "6429563",
         "item_titles_order_id": "13562034033",
         "return_number": "0f141f84b8cf3a465780",
         "channel_return_qty": "1",
         "channel_return_ref": "RET084372",
         "channel_return_date": "2023-04-11 20:00:00",
         "return_status": "return_initiated",
         "good_return_quantity": "0",
         "bad_return_quantity": "0",
         "tracking_number": null,
         "executed_shipping_method": null,
         "return_reason": null,
         "channel_return_reason": "Others",
         "return_received_date": null,
         "note": null,
         "return_attributes": null,
         "stock_adjusted": "0",
         "created": "2023-07-12 12:38:10",
         "modified": "2023-07-12 12:38:10",
         "exchange_order_requested": null,
         "exchange_order_id": null,
         "channel_id": "32912",
         "company_id": "8252",
         "order_id": "13769903974",
         "order_reference": "5228605145324",
         "sku": "NARZON53"  
    } 
  ],
   "server": "10.0.20.71"
}

Browntape

We’re excited to announce that the latest information is now available on our new site, the Ginesys One Wiki!. Visit the site for up-to-date resources and insights. We look forward to continuing to support you there!