Overview

Announce a return by calling this endpoint. After some seconds you will receive a label in the provided email.

Method access
POST https://api.getbyrd.com/v2/returns/announce
Request Headers
Authorization: Bearer token-from >Authentication
Content-Type: application/json
User-Agent: your user-agent >How to call the APIs

Fields

Field	Type	Description	Required
shipmentID	string	The shipment id to return.	always
sendDocumentsToEmail	email	Email that will receive the return label.	always
itemsAnnounced	items announced object	Items to be returned	always

Items announced object

Field	Type	Description	Required
shipmentItemID	string	The shipment item id to return. The shipment item id can be obtained under "items" object from the response to the original shipment creation call or by getting the original shipment details.	always
amount	integer	Email to send the return label.	always
reason	string	Reason of the return for the item.	always

Request body example

{
  "sendDocumentsToEmail": "[email protected]",
  "shipmentID": "the_shipment_id_to_return",
  "itemsAnnounced": [
    {
      "amount": 1,
      "reason": "arrived-too-late",
      "shipmentItemID": "the_shipment_item_id_to_return"
    }
  ],
}

Successful response example

{
  "data": {
    "courier": "colissimo_fr",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "userID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "announced",
    "reason": "customer",
    "portalTier": "basic",
    "createdAt": "2023-12-11T10:02:52.402Z",
    "documents": [
      {
        "type": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdAt": "2023-12-11T10:02:52.402Z",
        "updatedAt": "2023-12-11T10:02:52.402Z",
        "dataType": "string"
      }
    ],
    "updatedAt": "2023-12-11T10:02:52.402Z",
    "documentsEmailLanguage": "st",
    "itemsAnnounced": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "reason": "string",
        "createdAt": "2023-12-11T10:02:52.402Z",
        "updatedAt": "2023-12-11T10:02:52.402Z",
        "amount": 1,
        "shipmentItemID": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "shipmentID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "returnType": "customer",
    "sendDocumentsToEmail": "[email protected]"
  }
}