Create Return

Create Return Shipment

Request

curl -X POST "https://brdrch.com/api/v1/return/shipments" \
-u "cd3b3de84cc1ee040bf06512d233719c" \
-d '{}'

{
  "shipment_reference": "895895",
  "additional_shipment_reference": "895895",
  "process_label": true,
  "return_type": "can_can_return",
  "service_code": "BRSTD",
  "client_id": "SG10101911",
  "contents": {
    "items": [
      {
        "sku": "MXH-HGR-FG-03",
        "quantity": 2,
        "price": 45.2,
        "description": "pen box",
        "country_of_origin": "US",
        "harmonized_tariff_code": "03.08.22",
        "package_reference": "785623"
      }
    ]
  },
  "ship_from": {
    "name": "TIM",
    "phone": "999999999999",
    "email": "[email protected]",
    "address_line1": "23 Heritage Rd",
    "address_line2": "apt 123",
    "city_locality": "Russell",
    "state_province": "ON",
    "postal_code": "K4R 1B1",
    "country_code": "CA"
  },
  "packages": [
    {
      "package_reference": "785623",
      "weight": 2,
      "dimensions": {
        "length": 20,
        "height": 20,
        "width": 33
      }
    }
  ],
  "metadata": [
    {
      "name": "notes",
      "type": "string",
      "value": "delivery notes"
    }
  ]
}

Response

{
  "shipment_reference": "895895",
  "additional_shipment_reference": "895895",
  "process_label": true,
  "return_type": "can_can_return",
  "service_code": "BRSTD",
  "client_id": "SG10101911",
  "contents": {
    "items": [
      {
        "sku": "MXH-HGR-FG-03",
        "quantity": 2,
        "price": 45.2,
        "description": "pen box",
        "country_of_origin": "US",
        "harmonized_tariff_code": "03.08.22",
        "package_reference": "785623"
      }
    ]
  },
  "ship_from": {
    "name": "TIM",
    "phone": "9999999999",
    "email": "[email protected]",
    "address_line1": "123-23 HERITAGE RD",
    "address_line2": "apt 123",
    "city_locality": "RUSSELL",
    "state_province": "ON",
    "postal_code": "K4R 1B1",
    "country_code": "CA"
  },
  "packages": [
    {
      "package_reference": "785623",
      "weight": 2,
      "dimensions": {
        "length": 20,
        "height": 20,
        "width": 33
      },
      "sort_code": "DOM",
      "package_id": 283,
      "carrier_tracking_number": "123456789012BR283",
      "billable_weight": 528
    }
  ],
  "metadata": [],
  "shipment_id": 216,
  "label_download": [
    {
      "br_tracking_id": "BSGH0000785623427314",
      "pdf": "https://emaildata.dev.brdrch.com/argos/canadapost/123456789012BR283.pdf",
      "pdf_base64": "JVBERi0xLjQKJfbk/...JUVPRgo=",
      "carrier_tracking_number": "123456789012BR283",
      "carrier_tracking_link": "https://www.canadapost-postescanada.ca/track-reperage/en#/search?searchFor=123456789012BR283"
    }
  ]
}