Get return · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/GetReturn

Returns one return, with the units received per line, inspection results and the refund details.

received_quantity includes damaged units. Units that can be sold again are received_quantity - damaged_quantity.

Request body

idstringrequired

Return ID, for example BGBL0K3M9XQ2RT01.

Pattern^[A-Za-z0-9]{12}RT[A-Za-z0-9]{2}$

Responses

200The return.

returnReturn

The return with its statuses, line items and inspection results.

400The ID doesn't match the return ID pattern.

{
  "code": "invalid_argument",
  "msg": "id value does not match regex pattern `^[[:alnum:]]{12}RT[[:alnum:]]{2}$`",
  "meta": { "argument": "id" }
}

404No return with this ID exists.

{ "code": "not_found", "msg": "customer return not found" }

POST/bigblue.storeapi.v1.PublicAPI/GetReturn

Request

{ "id": "BGBL0K3M9XQ2RT01" }

200: received, one unit damaged

{
  "return": {
    "id": "BGBL0K3M9XQ2RT01",
    "order": "BGBL0K3M9XQ2",
    "warehouse": "FR-CDG-001",
    "status": "RETURN_STATUS_RETURNED",
    "resolution_status": "RETURN_RESOLUTION_STATUS_ACTION_REQUIRED",
    "source": "RETURN_SOURCE_CUSTOMER",
    "currency": "EUR",
    "return_time": "2026-03-23T09:40:00Z",
    "line_items": [
      {
        "product": "BGBL-ESPSRT-SMAL",
        "expected_quantity": 2,
        "received_quantity": 2,
        "damaged_quantity": 1,
        "quality_controls": [
          {},
          {
            "damaged_reasons": [
              "RETURN_DAMAGED_REASON_DAMAGED_PRODUCT"
            ],
            "images": [
              {
                "url": "https://qc.bigblue.co/i/8f3a91.jpg"
              }
            ]
          }
        ]
      }
    ]
  }
}

There is one inspection entry per unit. The first unit passed, so its entry is empty and it goes back into stock. The second is damaged.