PUT
/
v1
/
brands
/
{brand_id}
/
rmas
/
{id}
/
returns
/
{return_id}
/
receive
/
Receive an RMA return
curl --request PUT \
  --url https://marketplace-api.fabric.inc/v1/brands/{brand_id}/rmas/{id}/returns/{return_id}/receive/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Customer is returning item due to wrong size.",
  "quantity": 1,
  "ship_weight": 2.5,
  "ship_width": 10,
  "ship_length": 15,
  "ship_height": 5,
  "signature": "not_required",
  "return_tracking_number": 9.4001e+21,
  "label_reference": "LBLREFXYZ123",
  "shipping_provider_identifier": "USPS-PKG-001",
  "status": "pending",
  "inspection_notes": "Item received in good condition, no visible defects.",
  "label_format": "PDF",
  "shipping_charged": "8.75",
  "tariff_code": "9801.00.10",
  "value": "75.99"
}'
{
  "id": 197,
  "carrier": "UPS",
  "shipping_account": "1A2B3C4D",
  "shipping_method": "Ground",
  "ship_to": "123 Return Ave, Anytown, USA",
  "description": "Customer returned damaged item.",
  "quantity": 1,
  "ship_weight": 2.5,
  "ship_width": 10,
  "ship_length": 15,
  "ship_height": 5,
  "signature": "not_required",
  "return_tracking_number": 9.4001e+21,
  "label_reference": "LBLREF1234567890",
  "shipping_provider_identifier": "SPID987654321",
  "status": "pending",
  "rma_return_lines": {
    "id": 567,
    "variant": {
      "id": 100024,
      "name": "T-Shirt, Blue, L",
      "brand": {
        "id": 500,
        "name": "Marla Cielo",
        "code": "demo-brand",
        "joined_at": "2022-09-10T15:24:56Z",
        "logo_url": "https://images.revcascade.com/retailers/defaults/logo-lg.png",
        "cover_url": "https://images.revcascade.com/retailers/defaults/cover.png",
        "profile_tile_url": "https://images.revcascade.com/retailers/defaults/profile-tile.png",
        "website": null,
        "is_onboarded": false,
        "is_on_rcn": false,
        "requires_subscription": "enabled",
        "subscription_expires_at": "2024-09-19T13:32:10Z",
        "grace_period_ends_at": "2024-10-26T13:32:10Z",
        "subscription_is_expired": false,
        "subscription_is_on_grace_period": false,
        "subscription_is_delinquent": false,
        "inventory_policy": "managed",
        "status": "active"
      },
      "brand_identifier": "1000-BL-L",
      "identifier": "5000001",
      "upc": 9119119111,
      "cartons": [
        {
          "id": 48,
          "number": 1,
          "length": "1",
          "length_unit": "1",
          "width": "1",
          "width_unit": "meter",
          "height": "1",
          "height_unit": "meter",
          "weight": "15",
          "weight_unit": "KG",
          "package_girth_inches": "1",
          "package_size_inches": "1"
        }
      ],
      "color": "Red",
      "style": "Print",
      "size": "Large",
      "media": [
        {
          "id": 249,
          "width": 100,
          "height": 100,
          "media": "default",
          "priority": 1,
          "url": "192.168.99.100/media/default/original",
          "updated_at": "2022-09-10T15:24:56Z",
          "created_at": "2022-08-10T15:24:56Z"
        }
      ],
      "attributes": [
        {
          "id": 44,
          "code": "size",
          "name": "Size",
          "editable_by": "brand",
          "grouping": "general",
          "description": "demo product description",
          "type": "money",
          "units": "USD",
          "values": {
            "id": 123,
            "value": "<string>",
            "unit": {
              "id": 677,
              "name": "Sample unit",
              "standard_unit": "<string>",
              "type": "cost",
              "system": "metric",
              "symbol": "USD"
            },
            "retailer": {
              "id": 500,
              "name": "Demo Retailer",
              "code": "demo-retailer",
              "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
              "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
              "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
              "joined_at": "2021-08-03T17:24:12Z",
              "is_rcn_retailer": false,
              "is_onboarded": false,
              "platform": "fabric",
              "requires_subscription": "disabled",
              "brand_permit_creation_allowed": false,
              "website": "https://demoabc.com",
              "status": "active"
            },
            "updated_at": "2023-11-07T05:31:56Z",
            "created_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "ruleset_variants": [
        {
          "id": 1232,
          "status": "processing",
          "ruleset": {},
          "results": "<string>",
          "created_at": "2022-08-10T15:24:56Z",
          "updated_at": "2022-09-10T15:24:56Z"
        }
      ],
      "ruleset_variant_summary": "21",
      "active_permit": {
        "id": 10104,
        "retailer": {
          "id": 500,
          "name": "Demo Retailer",
          "code": "demo-retailer",
          "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
          "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
          "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
          "joined_at": "2021-08-03T17:24:12Z",
          "is_rcn_retailer": false,
          "is_onboarded": false,
          "platform": "fabric",
          "requires_subscription": "disabled",
          "brand_permit_creation_allowed": false,
          "website": "https://demoabc.com",
          "status": "active"
        },
        "retailer_price": "12.99",
        "retailer_cost": "8.99",
        "pricing": {},
        "attributes": {},
        "start_at": "2021-09-10T15:24:56Z",
        "end_at": "2024-09-10T15:24:56Z",
        "is_in_effect": true,
        "revoked_at": "2022-09-10T15:24:56Z",
        "is_acknowledged": true,
        "acknowledged_at": "2022-09-10T15:24:56Z"
      },
      "permits": [
        {
          "id": 10104,
          "retailer": {
            "id": 500,
            "name": "Demo Retailer",
            "code": "demo-retailer",
            "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
            "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
            "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
            "joined_at": "2021-08-03T17:24:12Z",
            "is_rcn_retailer": false,
            "is_onboarded": false,
            "platform": "fabric",
            "requires_subscription": "disabled",
            "brand_permit_creation_allowed": false,
            "website": "https://demoabc.com",
            "status": "active"
          },
          "retailer_price": "12.99",
          "retailer_cost": "8.99",
          "pricing": {},
          "attributes": {},
          "start_at": "2021-09-10T15:24:56Z",
          "end_at": "2024-09-10T15:24:56Z",
          "is_in_effect": true,
          "revoked_at": "2022-09-10T15:24:56Z",
          "is_acknowledged": true,
          "acknowledged_at": "2022-09-10T15:24:56Z"
        }
      ],
      "is_compatible": true,
      "proposal_variant": {
        "id": 3456,
        "pricing": "12.00",
        "attributes": [
          {
            "id": 123,
            "value": "<string>",
            "unit": {
              "id": 677,
              "name": "Sample unit",
              "standard_unit": "<string>",
              "type": "cost",
              "system": "metric",
              "symbol": "USD"
            },
            "retailer": {
              "id": 500,
              "name": "Demo Retailer",
              "code": "demo-retailer",
              "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
              "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
              "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
              "joined_at": "2021-08-03T17:24:12Z",
              "is_rcn_retailer": false,
              "is_onboarded": false,
              "platform": "fabric",
              "requires_subscription": "disabled",
              "brand_permit_creation_allowed": false,
              "website": "https://demoabc.com",
              "status": "active"
            },
            "updated_at": "2023-11-07T05:31:56Z",
            "created_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memos": [
          {
            "id": 1234,
            "text": "Immediate requirement",
            "visibility": "any",
            "acknowledged_at": "2022-01-10T15:24:56Z",
            "notify_people": true,
            "created_by": {
              "id": 542,
              "first_name": "Sample",
              "last_name": "Demo",
              "title": "Demo",
              "status": "Active",
              "type": "standard",
              "photo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
              "profile_photo": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
              "is_me": true
            },
            "created_by_context": "retailer",
            "created_at": "2021-09-10T15:24:56Z",
            "updated_at": "2022-09-10T15:24:56Z"
          }
        ],
        "issues": [
          {
            "id": 123,
            "memos": [
              {
                "id": 1234,
                "text": "Immediate requirement",
                "visibility": "any",
                "acknowledged_at": "2022-01-10T15:24:56Z",
                "notify_people": true,
                "created_by": {
                  "id": 542,
                  "first_name": "Sample",
                  "last_name": "Demo",
                  "title": "Demo",
                  "status": "Active",
                  "type": "standard",
                  "photo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
                  "profile_photo": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
                  "is_me": true
                },
                "created_by_context": "retailer",
                "created_at": "2021-09-10T15:24:56Z",
                "updated_at": "2022-09-10T15:24:56Z"
              }
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "resolved_at": "2023-11-07T05:31:56Z",
            "is_resolved": "<string>",
            "issue_id": 123,
            "message": "<string>",
            "title": "<string>"
          }
        ],
        "variant_id": 249,
        "approved_at": "2022-10-10T15:24:56Z",
        "created_at": "2022-07-10T15:24:56Z",
        "updated_at": "2022-09-10T15:24:56Z",
        "rejected_at": null,
        "reject_reason": "Incomplete",
        "reject": true,
        "approve": false,
        "delete": false
      },
      "retailer_identifiers": {
        "id": 5642,
        "retailer": {
          "id": 500,
          "name": "Demo Retailer",
          "code": "demo-retailer",
          "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
          "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
          "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
          "joined_at": "2021-08-03T17:24:12Z",
          "is_rcn_retailer": false,
          "is_onboarded": false,
          "platform": "fabric",
          "requires_subscription": "disabled",
          "brand_permit_creation_allowed": false,
          "website": "https://demoabc.com",
          "status": "active"
        },
        "identifier": "SKU976",
        "name": "Retailer Sample"
      },
      "retailer_categories": {
        "id": 453,
        "retailer": {
          "id": 500,
          "name": "Demo Retailer",
          "code": "demo-retailer",
          "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
          "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
          "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
          "joined_at": "2021-08-03T17:24:12Z",
          "is_rcn_retailer": false,
          "is_onboarded": false,
          "platform": "fabric",
          "requires_subscription": "disabled",
          "brand_permit_creation_allowed": false,
          "website": "https://demoabc.com",
          "status": "active"
        },
        "category": "CategoryANC"
      },
      "inventory": {
        "discontinued": true,
        "discontinued_updated_at": null,
        "inventory": 0,
        "inventory_updated_at": "2022-09-10T15:24:56Z",
        "inventory_last_submitted_at": "2022-09-10T15:24:56Z",
        "brand_inventory_updated_at": "2022-09-10T15:24:56Z",
        "sellable": "No",
        "sellable_updated_at": "2022-11-10T15:24:56Z",
        "replenishable": true,
        "estimated_availability_date": "2022-09-10T15:24:56Z",
        "locations": [
          {
            "id": 1,
            "address": {
              "id": 10,
              "type": "residential",
              "name1": "Demo Brand, Inc",
              "name2": null,
              "street1": "1332 Hermosa Ave",
              "street2": null,
              "city": "Hermosa Beach",
              "province": "CA",
              "postal_code": "90254",
              "country": "US",
              "phone1": "3105551212",
              "phone2": "3105551213",
              "fax": null,
              "email": null,
              "federal_tax_id": null
            },
            "inventory": 0,
            "nickname": "LA Warehouse"
          }
        ]
      }
    },
    "quantity": 20,
    "quantity_shipped": 10,
    "net_price": "12.00"
  },
  "inspection_notes": "Minor scuff marks on the left side.",
  "tracking": "https://www.ups.com/track?tracknum=9400100000000000000000",
  "label_format": "PDF",
  "shipping_charged": "12.50",
  "tariff_code": "9801.00.1010",
  "value": "150.00",
  "error_logs": "No errors logged.",
  "created_at": "2023-01-15T09:30:00.000Z",
  "received_at": "2023-01-20T10:00:00.000Z",
  "approved_at": "2023-01-21T11:00:00.000Z",
  "rejected_at": "2023-01-21T11:15:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
return_id
number
required

The unique return ID. This ID is automatically generated when a return is approved.

​
id
number
required

The unique RMA ID. This ID is automatically generated when a merchant registers a pending return for a supplier using the POST /v1/retailers/{retailer_id}/rmas/ endpoint.

​
brand_id
number
required

The unique brand ID. In the Dropship UI this is called the Supplier ID. To find your Supplier ID, click your supplier name in the top nav.

Body

application/json

Response

200 - application/json

Ok

Represents a single return within an RMA, detailing shipping information, status, and associated data.