PUT
/
v1
/
brands
/
{brand_id}
/
rmas
/
{id}
/
reject
/
Reject a return
curl --request PUT \
  --url https://marketplace-api.fabric.inc/v1/brands/{brand_id}/rmas/{id}/reject/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "order_id": 12345,
  "rma_number": "RMA1234567890",
  "brand_identifier": "fabric-brand",
  "status": "pending",
  "created_by": "retailer",
  "rmad_at": "2023-01-15T10:00:00.000Z",
  "approved_at": "2023-01-16T11:30:00.000Z",
  "rejected_at": "2023-01-17T14:45:00.000Z",
  "acknowledged_at": "2023-01-15T10:15:00.000Z",
  "reason_id": 5
}'
{
  "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": 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": "<any>",
            "number": "<any>",
            "length": "<any>",
            "length_unit": "<any>",
            "width": "<any>",
            "width_unit": "<any>",
            "height": "<any>",
            "height_unit": "<any>",
            "weight": "<any>",
            "weight_unit": "<any>",
            "package_girth_inches": "<any>",
            "package_size_inches": "<any>"
          }
        ],
        "color": "Red",
        "style": "Print",
        "size": "Large",
        "media": [
          {
            "id": "<any>",
            "width": "<any>",
            "height": "<any>",
            "media": "<any>",
            "priority": "<any>",
            "url": "<any>",
            "updated_at": "<any>",
            "created_at": "<any>"
          }
        ],
        "attributes": [
          {
            "id": "<any>",
            "code": "<any>",
            "name": "<any>",
            "editable_by": "<any>",
            "grouping": "<any>",
            "description": "<any>",
            "type": "<any>",
            "units": "<any>",
            "values": "<any>"
          }
        ],
        "ruleset_variants": [
          {
            "id": "<any>",
            "status": "<any>",
            "ruleset": "<any>",
            "results": "<any>",
            "created_at": "<any>",
            "updated_at": "<any>"
          }
        ],
        "ruleset_variant_summary": "21",
        "active_permit": {
          "id": 10104,
          "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>"
          },
          "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": "<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>"
          }
        ],
        "is_compatible": true,
        "proposal_variant": {
          "id": 3456,
          "pricing": "12.00",
          "attributes": [
            "<any>"
          ],
          "memos": [
            "<any>"
          ],
          "issues": [
            "<any>"
          ],
          "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": "<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>"
          },
          "identifier": "SKU976",
          "name": "Retailer Sample"
        },
        "retailer_categories": {
          "id": 453,
          "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>"
          },
          "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": [
            "<any>"
          ]
        }
      },
      "quantity": 20,
      "quantity_shipped": 10,
      "net_price": "12.00"
    }
  ],
  "reason": "Incorrect",
  "reason_id": 344,
  "memos": [
    {
      "id": 1234,
      "text": "Immediate requirement",
      "visibility": "any",
      "acknowledged_at": "2022-01-10T15:24:56Z",
      "notify_people": true,
      "created_by": {
        "id": "<any>",
        "first_name": "<any>",
        "last_name": "<any>",
        "title": "<any>",
        "status": "<any>",
        "type": "<any>",
        "photo_url": "<any>",
        "profile_photo": "<any>",
        "is_me": "<any>"
      },
      "created_by_context": "retailer",
      "created_at": "2021-09-10T15:24:56Z",
      "updated_at": "2022-09-10T15:24:56Z"
    }
  ],
  "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": 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"
  },
  "total_amount": "34.00",
  "credits": [
    {
      "id": 20,
      "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"
      },
      "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": 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"
        },
        "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": 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": "<any>",
                  "number": "<any>",
                  "length": "<any>",
                  "length_unit": "<any>",
                  "width": "<any>",
                  "width_unit": "<any>",
                  "height": "<any>",
                  "height_unit": "<any>",
                  "weight": "<any>",
                  "weight_unit": "<any>",
                  "package_girth_inches": "<any>",
                  "package_size_inches": "<any>"
                }
              ],
              "color": "Red",
              "style": "Print",
              "size": "Large",
              "media": [
                {
                  "id": "<any>",
                  "width": "<any>",
                  "height": "<any>",
                  "media": "<any>",
                  "priority": "<any>",
                  "url": "<any>",
                  "updated_at": "<any>",
                  "created_at": "<any>"
                }
              ],
              "attributes": [
                {
                  "id": "<any>",
                  "code": "<any>",
                  "name": "<any>",
                  "editable_by": "<any>",
                  "grouping": "<any>",
                  "description": "<any>",
                  "type": "<any>",
                  "units": "<any>",
                  "values": "<any>"
                }
              ],
              "ruleset_variants": [
                {
                  "id": "<any>",
                  "status": "<any>",
                  "ruleset": "<any>",
                  "results": "<any>",
                  "created_at": "<any>",
                  "updated_at": "<any>"
                }
              ],
              "ruleset_variant_summary": "21",
              "active_permit": {
                "id": 10104,
                "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>"
                },
                "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": "<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>"
                }
              ],
              "is_compatible": true,
              "proposal_variant": {
                "id": 3456,
                "pricing": "12.00",
                "attributes": [
                  "<any>"
                ],
                "memos": [
                  "<any>"
                ],
                "issues": [
                  "<any>"
                ],
                "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": "<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>"
                },
                "identifier": "SKU976",
                "name": "Retailer Sample"
              },
              "retailer_categories": {
                "id": 453,
                "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>"
                },
                "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": [
                  "<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": "<any>",
            "first_name": "<any>",
            "last_name": "<any>",
            "title": "<any>",
            "status": "<any>",
            "type": "<any>",
            "photo_url": "<any>",
            "profile_photo": "<any>",
            "is_me": "<any>"
          },
          "rejected_by": {
            "id": "<any>",
            "first_name": "<any>",
            "last_name": "<any>",
            "title": "<any>",
            "status": "<any>",
            "type": "<any>",
            "photo_url": "<any>",
            "profile_photo": "<any>",
            "is_me": "<any>"
          },
          "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": 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": "<any>",
                "number": "<any>",
                "length": "<any>",
                "length_unit": "<any>",
                "width": "<any>",
                "width_unit": "<any>",
                "height": "<any>",
                "height_unit": "<any>",
                "weight": "<any>",
                "weight_unit": "<any>",
                "package_girth_inches": "<any>",
                "package_size_inches": "<any>"
              }
            ],
            "color": "Red",
            "style": "Print",
            "size": "Large",
            "media": [
              {
                "id": "<any>",
                "width": "<any>",
                "height": "<any>",
                "media": "<any>",
                "priority": "<any>",
                "url": "<any>",
                "updated_at": "<any>",
                "created_at": "<any>"
              }
            ],
            "attributes": [
              {
                "id": "<any>",
                "code": "<any>",
                "name": "<any>",
                "editable_by": "<any>",
                "grouping": "<any>",
                "description": "<any>",
                "type": "<any>",
                "units": "<any>",
                "values": "<any>"
              }
            ],
            "ruleset_variants": [
              {
                "id": "<any>",
                "status": "<any>",
                "ruleset": "<any>",
                "results": "<any>",
                "created_at": "<any>",
                "updated_at": "<any>"
              }
            ],
            "ruleset_variant_summary": "21",
            "active_permit": {
              "id": 10104,
              "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>"
              },
              "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": "<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>"
              }
            ],
            "is_compatible": true,
            "proposal_variant": {
              "id": 3456,
              "pricing": "12.00",
              "attributes": [
                "<any>"
              ],
              "memos": [
                "<any>"
              ],
              "issues": [
                "<any>"
              ],
              "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": "<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>"
              },
              "identifier": "SKU976",
              "name": "Retailer Sample"
            },
            "retailer_categories": {
              "id": 453,
              "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>"
              },
              "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": [
                "<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

​
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

Represents a Return Merchandise Authorization (RMA) for a product return.

​
order_id
integer
required

The unique identifier of the order associated with the RMA.

Example:

12345

​
reason_id
integer
required

The unique identifier for the reason of the RMA.

Example:

5

​
rma_number
string | null

The unique RMA number.

Maximum length: 32
Example:

"RMA1234567890"

​
brand_identifier
string | null

An identifier for the brand associated with the RMA.

Maximum length: 32
Example:

"fabric-brand"

​
status
enum<string> | null

The current status of the RMA.

Available options:
pending,
approved,
rejected
Example:

"pending"

​
created_by
enum<string> | null

Indicates whether the RMA was created by the retailer or the brand.

Available options:
retailer,
brand
Example:

"retailer"

​
rmad_at
string<date-time> | null

The timestamp when the RMA was initiated.

Example:

"2023-01-15T10:00:00.000Z"

​
approved_at
string<date-time> | null

The timestamp when the RMA was approved.

Example:

"2023-01-16T11:30:00.000Z"

​
rejected_at
string<date-time> | null

The timestamp when the RMA was rejected.

Example:

"2023-01-17T14:45:00.000Z"

​
acknowledged_at
string<date-time> | null

The timestamp when the RMA was acknowledged.

Example:

"2023-01-15T10:15:00.000Z"

Response

200 - application/json

Ok

​
order_id
integer
required

Order ID

Example:

1000

​
reason_id
integer
required

ID associated with return reason

Example:

344

​
id
integer

RMA ID. This ID is required in subsequent endpoints related to RMA.

Example:

4

​
purchase_order_number
string

Purchase order number

Minimum length: 1
Example:

"CS192168"

​
rma_number
string | null

RMA number

Maximum length: 32
Example:

"ABC123"

​
status
enum<string> | null

RMA status. Default is Pending.

Available options:
pending,
approved,
rejected
Example:

"Pending"

​
currency
object
​
created_by
enum<string> | null

User that initiated RMA

Available options:
retailer,
brand
Example:

"Retailer"

​
rmad_at
string<date-time> | null

Time of RMA creation (UTC format)

Example:

"2022-09-10T15:24:56Z"

​
approved_at
string<date-time> | null

Time of RMA approval (UTC format)

Example:

"2022-09-10T15:24:56Z"

​
rejected_at
string<date-time> | null

Time of RMA rejection(UTC format)

Example:

null

​
ordered_at
string<date-time>

Time of order finalization (UTC format)

Example:

"2022-09-10T15:24:56Z"

​
acknowledged_at
string<date-time> | null

Time of RMA acknowledgment (UTC format)

Example:

"2022-09-10T15:24:56Z"

​
rma_lines
object[]
​
reason
string

Reason for return

Minimum length: 1
Example:

"Incorrect"

​
memos
object[]
​
attachments
object[]
​
retailer
object
​
brand
object
​
total_amount
string

Total amount

Example:

"34.00"

​
credits
object[]