GET
/
v1
/
retailers
/
{retailer_id}
/
rmas
/
Get a list of returns
curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/rmas/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 1005,
  "next": "https://api.example.org/demo/{retailer_id}/?page=5",
  "previous": "https://api.example.org/demo/{retailer_id}/?page=3",
  "results": [
    {
      "id": 4,
      "order_id": 1000,
      "purchase_order_number": "CS192168",
      "rma_number": "ABC123",
      "status": "Pending",
      "currency": {
        "id": 1,
        "name": "United States Dollar",
        "symbol": "$",
        "unit": "USD"
      },
      "created_by": "Retailer",
      "rmad_at": "2022-09-10T15:24:56Z",
      "approved_at": "2022-09-10T15:24:56Z",
      "rejected_at": null,
      "ordered_at": "2022-09-10T15:24:56Z",
      "acknowledged_at": "2022-09-10T15:24:56Z",
      "rma_lines": [
        {
          "id": 567,
          "variant": {
            "id": 100024,
            "name": "T-Shirt, Blue, L",
            "brand": {
              "id": "<any>",
              "name": "<any>",
              "code": "<any>",
              "joined_at": "<any>",
              "logo_url": "<any>",
              "cover_url": "<any>",
              "profile_tile_url": "<any>",
              "website": "<any>",
              "is_onboarded": "<any>",
              "is_on_rcn": "<any>",
              "requires_subscription": "<any>",
              "subscription_expires_at": "<any>",
              "grace_period_ends_at": "<any>",
              "subscription_is_expired": "<any>",
              "subscription_is_on_grace_period": "<any>",
              "subscription_is_delinquent": "<any>",
              "inventory_policy": "<any>",
              "status": "<any>"
            },
            "brand_identifier": "1000-BL-L",
            "identifier": "5000001",
            "upc": 9119119111,
            "cartons": [
              "<any>"
            ],
            "color": "Red",
            "style": "Print",
            "size": "Large",
            "media": [
              "<any>"
            ],
            "attributes": [
              "<any>"
            ],
            "ruleset_variants": [
              "<any>"
            ],
            "ruleset_variant_summary": "21",
            "active_permit": {
              "id": "<any>",
              "retailer": "<any>",
              "retailer_price": "<any>",
              "retailer_cost": "<any>",
              "pricing": "<any>",
              "attributes": "<any>",
              "start_at": "<any>",
              "end_at": "<any>",
              "is_in_effect": "<any>",
              "revoked_at": "<any>",
              "is_acknowledged": "<any>",
              "acknowledged_at": "<any>"
            },
            "permits": [
              "<any>"
            ],
            "is_compatible": true,
            "proposal_variant": {
              "id": "<any>",
              "pricing": "<any>",
              "attributes": "<any>",
              "memos": "<any>",
              "issues": "<any>",
              "variant_id": "<any>",
              "approved_at": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>",
              "rejected_at": "<any>",
              "reject_reason": "<any>",
              "reject": "<any>",
              "approve": "<any>",
              "delete": "<any>"
            },
            "retailer_identifiers": {
              "id": "<any>",
              "retailer": "<any>",
              "identifier": "<any>",
              "name": "<any>"
            },
            "retailer_categories": {
              "id": "<any>",
              "retailer": "<any>",
              "category": "<any>"
            },
            "inventory": {
              "discontinued": "<any>",
              "discontinued_updated_at": "<any>",
              "inventory": "<any>",
              "inventory_updated_at": "<any>",
              "inventory_last_submitted_at": "<any>",
              "brand_inventory_updated_at": "<any>",
              "sellable": "<any>",
              "sellable_updated_at": "<any>",
              "replenishable": "<any>",
              "estimated_availability_date": "<any>",
              "locations": "<any>"
            }
          },
          "quantity": 20,
          "quantity_shipped": 10,
          "net_price": "12.00"
        }
      ],
      "reason": "Incorrect",
      "reason_id": 344,
      "memos": [
        {
          "id": "<any>",
          "text": "<any>",
          "visibility": "<any>",
          "acknowledged_at": "<any>",
          "notify_people": "<any>",
          "created_by": "<any>",
          "created_by_context": "<any>",
          "created_at": "<any>",
          "updated_at": "<any>"
        }
      ],
      "attachments": [
        {
          "id": 268,
          "content_type": 1,
          "object_id": 666,
          "file": "Sample file",
          "uploaded_by": 646,
          "visible_by": "connections",
          "original_filename": "Sample1",
          "filename": "Sample1",
          "tags": [
            {
              "id": 432,
              "tag": "demotag"
            }
          ],
          "url": "https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"
        }
      ],
      "retailer": {
        "id": "<any>",
        "name": "<any>",
        "code": "<any>",
        "logo_url": "<any>",
        "cover_url": "<any>",
        "profile_tile_url": "<any>",
        "joined_at": "<any>",
        "is_rcn_retailer": "<any>",
        "is_onboarded": "<any>",
        "platform": "<any>",
        "requires_subscription": "<any>",
        "brand_permit_creation_allowed": "<any>",
        "website": "<any>",
        "status": "<any>"
      },
      "brand": {
        "id": "<any>",
        "name": "<any>",
        "code": "<any>",
        "joined_at": "<any>",
        "logo_url": "<any>",
        "cover_url": "<any>",
        "profile_tile_url": "<any>",
        "website": "<any>",
        "is_onboarded": "<any>",
        "is_on_rcn": "<any>",
        "requires_subscription": "<any>",
        "subscription_expires_at": "<any>",
        "grace_period_ends_at": "<any>",
        "subscription_is_expired": "<any>",
        "subscription_is_on_grace_period": "<any>",
        "subscription_is_delinquent": "<any>",
        "inventory_policy": "<any>",
        "status": "<any>"
      },
      "total_amount": "34.00",
      "credits": [
        {
          "id": 20,
          "brand": {
            "id": "<any>",
            "name": "<any>",
            "code": "<any>",
            "joined_at": "<any>",
            "logo_url": "<any>",
            "cover_url": "<any>",
            "profile_tile_url": "<any>",
            "website": "<any>",
            "is_onboarded": "<any>",
            "is_on_rcn": "<any>",
            "requires_subscription": "<any>",
            "subscription_expires_at": "<any>",
            "grace_period_ends_at": "<any>",
            "subscription_is_expired": "<any>",
            "subscription_is_on_grace_period": "<any>",
            "subscription_is_delinquent": "<any>",
            "inventory_policy": "<any>",
            "status": "<any>"
          },
          "retailer": {
            "id": "<any>",
            "name": "<any>",
            "code": "<any>",
            "logo_url": "<any>",
            "cover_url": "<any>",
            "profile_tile_url": "<any>",
            "joined_at": "<any>",
            "is_rcn_retailer": "<any>",
            "is_onboarded": "<any>",
            "platform": "<any>",
            "requires_subscription": "<any>",
            "brand_permit_creation_allowed": "<any>",
            "website": "<any>",
            "status": "<any>"
          },
          "currency": {
            "id": 1,
            "name": "United States Dollar",
            "symbol": "$",
            "unit": "USD"
          },
          "rma": {},
          "invoice": {
            "id": 1,
            "retailer": {
              "id": "<any>",
              "name": "<any>",
              "code": "<any>",
              "logo_url": "<any>",
              "cover_url": "<any>",
              "profile_tile_url": "<any>",
              "joined_at": "<any>",
              "is_rcn_retailer": "<any>",
              "is_onboarded": "<any>",
              "platform": "<any>",
              "requires_subscription": "<any>",
              "brand_permit_creation_allowed": "<any>",
              "website": "<any>",
              "status": "<any>"
            },
            "brand": {
              "id": "<any>",
              "name": "<any>",
              "code": "<any>",
              "joined_at": "<any>",
              "logo_url": "<any>",
              "cover_url": "<any>",
              "profile_tile_url": "<any>",
              "website": "<any>",
              "is_onboarded": "<any>",
              "is_on_rcn": "<any>",
              "requires_subscription": "<any>",
              "subscription_expires_at": "<any>",
              "grace_period_ends_at": "<any>",
              "subscription_is_expired": "<any>",
              "subscription_is_on_grace_period": "<any>",
              "subscription_is_delinquent": "<any>",
              "inventory_policy": "<any>",
              "status": "<any>"
            },
            "connection_id": 2,
            "currency": {
              "id": 1,
              "name": "United States Dollar",
              "symbol": "$",
              "unit": "USD"
            },
            "invoice_number": "RC123456",
            "terms_type": "Previously agreed upon",
            "terms_description": "Previously agreed upon terms will apply",
            "terms_net_days_due": 35,
            "terms_date_due": null,
            "terms_discount_percent": null,
            "order_id": "O-654",
            "customer_order_number": "CO-435",
            "purchase_order_number": "PO-546",
            "status": "closed",
            "remit_to": {
              "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
            },
            "ship_from": {
              "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
            },
            "sold_to": {
              "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
            },
            "ship_to": {
              "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
            },
            "shipping_carrier_name": "ALZ carrier",
            "shipping_carrier_code": "230F",
            "shipping_account_number": "SH879",
            "shipping_method_name": "Next day delivery",
            "shipping_method_code": "ND",
            "shipping_tracking_number": "1Z9999999999999988",
            "shipping_weight": "7.00",
            "notes": "Signature required",
            "invoiced_at": "2022-05-10T15:24:56Z",
            "ordered_at": "2022-05-10T15:24:56Z",
            "shipped_at": "2022-05-10T15:24:56Z",
            "acknowledged_at": "2022-06-10T15:24:56Z",
            "paid_at": "2022-06-10T15:24:56Z",
            "closed_at": null,
            "canceled_at": null,
            "allowances": [
              {
                "id": 1,
                "adjustment_code": {
                  "id": 1,
                  "adjustment_type": "Allowance",
                  "code": "returns_allowance",
                  "description": "returns_allowance"
                },
                "description": "Sample-discount-allowance",
                "price": "12.10"
              }
            ],
            "charges": [
              {
                "id": 654,
                "adjustment_code": {
                  "id": 1,
                  "adjustment_type": "Allowance",
                  "code": "returns_allowance",
                  "description": "returns_allowance"
                },
                "description": "Sample invoice and its description",
                "price": "23.45"
              }
            ],
            "invoice_lines": [
              {
                "id": 765,
                "variant": {
                  "id": 100024,
                  "name": "T-Shirt, Blue, L",
                  "brand": {
                    "id": "<any>",
                    "name": "<any>",
                    "code": "<any>",
                    "joined_at": "<any>",
                    "logo_url": "<any>",
                    "cover_url": "<any>",
                    "profile_tile_url": "<any>",
                    "website": "<any>",
                    "is_onboarded": "<any>",
                    "is_on_rcn": "<any>",
                    "requires_subscription": "<any>",
                    "subscription_expires_at": "<any>",
                    "grace_period_ends_at": "<any>",
                    "subscription_is_expired": "<any>",
                    "subscription_is_on_grace_period": "<any>",
                    "subscription_is_delinquent": "<any>",
                    "inventory_policy": "<any>",
                    "status": "<any>"
                  },
                  "brand_identifier": "1000-BL-L",
                  "identifier": "5000001",
                  "upc": 9119119111,
                  "cartons": [
                    "<any>"
                  ],
                  "color": "Red",
                  "style": "Print",
                  "size": "Large",
                  "media": [
                    "<any>"
                  ],
                  "attributes": [
                    "<any>"
                  ],
                  "ruleset_variants": [
                    "<any>"
                  ],
                  "ruleset_variant_summary": "21",
                  "active_permit": {
                    "id": "<any>",
                    "retailer": "<any>",
                    "retailer_price": "<any>",
                    "retailer_cost": "<any>",
                    "pricing": "<any>",
                    "attributes": "<any>",
                    "start_at": "<any>",
                    "end_at": "<any>",
                    "is_in_effect": "<any>",
                    "revoked_at": "<any>",
                    "is_acknowledged": "<any>",
                    "acknowledged_at": "<any>"
                  },
                  "permits": [
                    "<any>"
                  ],
                  "is_compatible": true,
                  "proposal_variant": {
                    "id": "<any>",
                    "pricing": "<any>",
                    "attributes": "<any>",
                    "memos": "<any>",
                    "issues": "<any>",
                    "variant_id": "<any>",
                    "approved_at": "<any>",
                    "created_at": "<any>",
                    "updated_at": "<any>",
                    "rejected_at": "<any>",
                    "reject_reason": "<any>",
                    "reject": "<any>",
                    "approve": "<any>",
                    "delete": "<any>"
                  },
                  "retailer_identifiers": {
                    "id": "<any>",
                    "retailer": "<any>",
                    "identifier": "<any>",
                    "name": "<any>"
                  },
                  "retailer_categories": {
                    "id": "<any>",
                    "retailer": "<any>",
                    "category": "<any>"
                  },
                  "inventory": {
                    "discontinued": "<any>",
                    "discontinued_updated_at": "<any>",
                    "inventory": "<any>",
                    "inventory_updated_at": "<any>",
                    "inventory_last_submitted_at": "<any>",
                    "brand_inventory_updated_at": "<any>",
                    "sellable": "<any>",
                    "sellable_updated_at": "<any>",
                    "replenishable": "<any>",
                    "estimated_availability_date": "<any>",
                    "locations": "<any>"
                  }
                },
                "invoice_line_number": 2,
                "item_brand_identifier": "Vend134",
                "item_upc": "911911911112",
                "quantity": 45,
                "name": "SamPro1",
                "description": "Sample description of product",
                "canceled_at": null,
                "price": "12.00",
                "retail_price": "14.00"
              }
            ],
            "net_amount": "12.89",
            "due_amount": "2.89",
            "expected_due_amount": "2.89",
            "subtotal": "10.89",
            "tax": "2.00",
            "invoice_acceptance": {
              "id": 565,
              "accepted_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
              },
              "rejected_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
              },
              "reject_reason": "Incorrect",
              "accepted_at": "2022-08-10T15:24:56Z",
              "rejected_at": null
            }
          },
          "order": "<string>",
          "credit_number": "849238",
          "credit_lines": [
            {
              "id": 566,
              "variant": {
                "id": 100024,
                "name": "T-Shirt, Blue, L",
                "brand": {
                  "id": "<any>",
                  "name": "<any>",
                  "code": "<any>",
                  "joined_at": "<any>",
                  "logo_url": "<any>",
                  "cover_url": "<any>",
                  "profile_tile_url": "<any>",
                  "website": "<any>",
                  "is_onboarded": "<any>",
                  "is_on_rcn": "<any>",
                  "requires_subscription": "<any>",
                  "subscription_expires_at": "<any>",
                  "grace_period_ends_at": "<any>",
                  "subscription_is_expired": "<any>",
                  "subscription_is_on_grace_period": "<any>",
                  "subscription_is_delinquent": "<any>",
                  "inventory_policy": "<any>",
                  "status": "<any>"
                },
                "brand_identifier": "1000-BL-L",
                "identifier": "5000001",
                "upc": 9119119111,
                "cartons": [
                  "<any>"
                ],
                "color": "Red",
                "style": "Print",
                "size": "Large",
                "media": [
                  "<any>"
                ],
                "attributes": [
                  "<any>"
                ],
                "ruleset_variants": [
                  "<any>"
                ],
                "ruleset_variant_summary": "21",
                "active_permit": {
                  "id": "<any>",
                  "retailer": "<any>",
                  "retailer_price": "<any>",
                  "retailer_cost": "<any>",
                  "pricing": "<any>",
                  "attributes": "<any>",
                  "start_at": "<any>",
                  "end_at": "<any>",
                  "is_in_effect": "<any>",
                  "revoked_at": "<any>",
                  "is_acknowledged": "<any>",
                  "acknowledged_at": "<any>"
                },
                "permits": [
                  "<any>"
                ],
                "is_compatible": true,
                "proposal_variant": {
                  "id": "<any>",
                  "pricing": "<any>",
                  "attributes": "<any>",
                  "memos": "<any>",
                  "issues": "<any>",
                  "variant_id": "<any>",
                  "approved_at": "<any>",
                  "created_at": "<any>",
                  "updated_at": "<any>",
                  "rejected_at": "<any>",
                  "reject_reason": "<any>",
                  "reject": "<any>",
                  "approve": "<any>",
                  "delete": "<any>"
                },
                "retailer_identifiers": {
                  "id": "<any>",
                  "retailer": "<any>",
                  "identifier": "<any>",
                  "name": "<any>"
                },
                "retailer_categories": {
                  "id": "<any>",
                  "retailer": "<any>",
                  "category": "<any>"
                },
                "inventory": {
                  "discontinued": "<any>",
                  "discontinued_updated_at": "<any>",
                  "inventory": "<any>",
                  "inventory_updated_at": "<any>",
                  "inventory_last_submitted_at": "<any>",
                  "brand_inventory_updated_at": "<any>",
                  "sellable": "<any>",
                  "sellable_updated_at": "<any>",
                  "replenishable": "<any>",
                  "estimated_availability_date": "<any>",
                  "locations": "<any>"
                }
              },
              "quantity": 10,
              "net_price": "12.99"
            }
          ],
          "adjustments": [
            {
              "id": 566,
              "description": "Sample description for adjustment",
              "net_price": "1.00"
            }
          ],
          "acknowledged_at": "2022-09-10T15:24:56Z",
          "credited_at": "2022-09-10T15:24:56Z",
          "created_at": "2022-08-10T15:24:56Z",
          "subtotal": "20.00",
          "credit_amount": "24.00"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
retailer_id
number
required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Query Parameters

​
search
string

Search by RMA status or identifier

​
status
string

RMA status

​
purchase_order_number
string

Purchase order number

​
rma_number
string

RMA number

​
reason_id
number[]

Reason IDs associated with RMAs. Multiple values may be separated by commas.

​
reason
string

RMA reason

​
since
number

From a past date till current time (Unix epoch format)

​
brand_id
number[]

Vendor ID. Multiple values may be separated by commas.

​
connection_id
number[]

Connection IDs. Multiple values may be separated by commas.

​
order_by
string

Sorting criteria

​
page
integer

Page number within the paginated response

​
limit
integer

Number of records per page

Response

200 - application/json

OK

The response is of type object.