Acknowledge return

Acknowledge receipt of an approved return.

PUT /v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/

Acknowledge return

cURL

curl --request PUT \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": 1000,
  "reason_id": 344,
  "rma_number": "ABC123",
  "status": "Pending",
  "currency": {
    "name": "United States Dollar",
    "symbol": "$"
  },
  "created_by": "Retailer",
  "rmad_at": "2022-09-10T15:24:56Z",
  "approved_at": "2022-09-10T15:24:56Z",
  "rejected_at": null,
  "acknowledged_at": "2022-09-10T15:24:56Z"
}
'

import requests

url = "https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/"

payload = {
    "order_id": 1000,
    "reason_id": 344,
    "rma_number": "ABC123",
    "status": "Pending",
    "currency": {
        "name": "United States Dollar",
        "symbol": "$"
    },
    "created_by": "Retailer",
    "rmad_at": "2022-09-10T15:24:56Z",
    "approved_at": "2022-09-10T15:24:56Z",
    "rejected_at": None,
    "acknowledged_at": "2022-09-10T15:24:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    order_id: 1000,
    reason_id: 344,
    rma_number: 'ABC123',
    status: 'Pending',
    currency: {name: 'United States Dollar', symbol: '$'},
    created_by: 'Retailer',
    rmad_at: '2022-09-10T15:24:56Z',
    approved_at: '2022-09-10T15:24:56Z',
    rejected_at: null,
    acknowledged_at: '2022-09-10T15:24:56Z'
  })
};

fetch('https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'order_id' => 1000,
    'reason_id' => 344,
    'rma_number' => 'ABC123',
    'status' => 'Pending',
    'currency' => [
        'name' => 'United States Dollar',
        'symbol' => '$'
    ],
    'created_by' => 'Retailer',
    'rmad_at' => '2022-09-10T15:24:56Z',
    'approved_at' => '2022-09-10T15:24:56Z',
    'rejected_at' => null,
    'acknowledged_at' => '2022-09-10T15:24:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/"

	payload := strings.NewReader("{\n  \"order_id\": 1000,\n  \"reason_id\": 344,\n  \"rma_number\": \"ABC123\",\n  \"status\": \"Pending\",\n  \"currency\": {\n    \"name\": \"United States Dollar\",\n    \"symbol\": \"$\"\n  },\n  \"created_by\": \"Retailer\",\n  \"rmad_at\": \"2022-09-10T15:24:56Z\",\n  \"approved_at\": \"2022-09-10T15:24:56Z\",\n  \"rejected_at\": null,\n  \"acknowledged_at\": \"2022-09-10T15:24:56Z\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": 1000,\n  \"reason_id\": 344,\n  \"rma_number\": \"ABC123\",\n  \"status\": \"Pending\",\n  \"currency\": {\n    \"name\": \"United States Dollar\",\n    \"symbol\": \"$\"\n  },\n  \"created_by\": \"Retailer\",\n  \"rmad_at\": \"2022-09-10T15:24:56Z\",\n  \"approved_at\": \"2022-09-10T15:24:56Z\",\n  \"rejected_at\": null,\n  \"acknowledged_at\": \"2022-09-10T15:24:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_id\": 1000,\n  \"reason_id\": 344,\n  \"rma_number\": \"ABC123\",\n  \"status\": \"Pending\",\n  \"currency\": {\n    \"name\": \"United States Dollar\",\n    \"symbol\": \"$\"\n  },\n  \"created_by\": \"Retailer\",\n  \"rmad_at\": \"2022-09-10T15:24:56Z\",\n  \"approved_at\": \"2022-09-10T15:24:56Z\",\n  \"rejected_at\": null,\n  \"acknowledged_at\": \"2022-09-10T15:24:56Z\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "order_id": 1000,
  "reason_id": 344,
  "id": 4,
  "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": {
          "code": "demo-brand",
          "id": 500,
          "name": "Marla Cielo",
          "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": [
          {
            "code": "size",
            "name": "Size",
            "type": "money",
            "id": 44,
            "editable_by": "brand",
            "grouping": "general",
            "description": "demo product description",
            "units": "USD",
            "values": {
              "id": 123,
              "value": "<string>",
              "unit": {
                "id": 677,
                "name": "Sample unit",
                "standard_unit": "<string>",
                "type": "cost",
                "system": "metric",
                "symbol": "USD"
              },
              "retailer": {
                "name": "Demo Retailer",
                "code": "demo-retailer",
                "id": 500,
                "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": "<unknown>",
            "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": {
            "name": "Demo Retailer",
            "code": "demo-retailer",
            "id": 500,
            "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": {
              "name": "Demo Retailer",
              "code": "demo-retailer",
              "id": 500,
              "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": {
                "name": "Demo Retailer",
                "code": "demo-retailer",
                "id": 500,
                "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": {
            "name": "Demo Retailer",
            "code": "demo-retailer",
            "id": 500,
            "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": {
          "category": "CategoryANC",
          "id": 453,
          "retailer": {
            "name": "Demo Retailer",
            "code": "demo-retailer",
            "id": 500,
            "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"
          }
        },
        "inventory": {
          "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_updated_at": "2022-11-10T15:24:56Z",
          "estimated_availability_date": "2022-09-10T15:24:56Z",
          "discontinued": true,
          "discontinued_updated_at": null,
          "inventory": 0,
          "sellable": "No",
          "replenishable": true,
          "locations": [
            {
              "id": 1,
              "address": {
                "name1": "Demo Brand, Inc",
                "street1": "1332 Hermosa Ave",
                "city": "Hermosa Beach",
                "province": "CA",
                "postal_code": "90254",
                "country": "US",
                "id": 10,
                "type": "residential",
                "name2": null,
                "street2": null,
                "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"
    }
  ],
  "reason": "Incorrect",
  "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"
    }
  ],
  "attachments": [
    {
      "id": 268,
      "content_type": 1,
      "object_id": 666,
      "file": "Sample file",
      "uploaded_by": 646,
      "visible_by": "connections",
      "original_filename": "Sample1",
      "filename": "Sample1",
      "tags": [
        {
          "tag": "demotag",
          "id": 432
        }
      ],
      "url": "https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"
    }
  ],
  "retailer": {
    "name": "Demo Retailer",
    "code": "demo-retailer",
    "id": 500,
    "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"
  },
  "brand": {
    "code": "demo-brand",
    "id": 500,
    "name": "Marla Cielo",
    "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": {
        "code": "demo-brand",
        "id": 500,
        "name": "Marla Cielo",
        "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": {
        "name": "Demo Retailer",
        "code": "demo-retailer",
        "id": 500,
        "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"
      },
      "currency": {
        "id": 1,
        "name": "United States Dollar",
        "symbol": "$",
        "unit": "USD"
      },
      "rma": "<unknown>",
      "invoice": {
        "invoice_number": "RC123456",
        "id": 1,
        "retailer": {
          "name": "Demo Retailer",
          "code": "demo-retailer",
          "id": 500,
          "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"
        },
        "brand": {
          "code": "demo-brand",
          "id": 500,
          "name": "Marla Cielo",
          "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"
        },
        "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": {
          "name1": "Demo Brand, Inc",
          "street1": "1332 Hermosa Ave",
          "city": "Hermosa Beach",
          "province": "CA",
          "postal_code": "90254",
          "country": "US",
          "id": 10,
          "type": "residential",
          "name2": null,
          "street2": null,
          "phone1": "3105551212",
          "phone2": "3105551213",
          "fax": null,
          "email": null,
          "federal_tax_id": null
        },
        "ship_from": {
          "name1": "Demo Brand, Inc",
          "street1": "1332 Hermosa Ave",
          "city": "Hermosa Beach",
          "province": "CA",
          "postal_code": "90254",
          "country": "US",
          "id": 10,
          "type": "residential",
          "name2": null,
          "street2": null,
          "phone1": "3105551212",
          "phone2": "3105551213",
          "fax": null,
          "email": null,
          "federal_tax_id": null
        },
        "sold_to": {
          "name1": "Demo Brand, Inc",
          "street1": "1332 Hermosa Ave",
          "city": "Hermosa Beach",
          "province": "CA",
          "postal_code": "90254",
          "country": "US",
          "id": 10,
          "type": "residential",
          "name2": null,
          "street2": null,
          "phone1": "3105551212",
          "phone2": "3105551213",
          "fax": null,
          "email": null,
          "federal_tax_id": null
        },
        "ship_to": {
          "name1": "Demo Brand, Inc",
          "street1": "1332 Hermosa Ave",
          "city": "Hermosa Beach",
          "province": "CA",
          "postal_code": "90254",
          "country": "US",
          "id": 10,
          "type": "residential",
          "name2": null,
          "street2": null,
          "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": [
          {
            "description": "Sample-discount-allowance",
            "price": "12.10",
            "id": 1,
            "adjustment_code": {
              "adjustment_type": "Allowance",
              "code": "returns_allowance",
              "description": "returns_allowance",
              "id": 1
            }
          }
        ],
        "charges": [
          {
            "description": "Sample invoice and its description",
            "price": "23.45",
            "id": 654,
            "adjustment_code": {
              "adjustment_type": "Allowance",
              "code": "returns_allowance",
              "description": "returns_allowance",
              "id": 1
            }
          }
        ],
        "invoice_lines": [
          {
            "quantity": 45,
            "price": "12.00",
            "id": 765,
            "variant": {
              "id": 100024,
              "name": "T-Shirt, Blue, L",
              "brand": {
                "code": "demo-brand",
                "id": 500,
                "name": "Marla Cielo",
                "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": [
                {
                  "code": "size",
                  "name": "Size",
                  "type": "money",
                  "id": 44,
                  "editable_by": "brand",
                  "grouping": "general",
                  "description": "demo product description",
                  "units": "USD",
                  "values": {
                    "id": 123,
                    "value": "<string>",
                    "unit": {
                      "id": 677,
                      "name": "Sample unit",
                      "standard_unit": "<string>",
                      "type": "cost",
                      "system": "metric",
                      "symbol": "USD"
                    },
                    "retailer": {
                      "name": "Demo Retailer",
                      "code": "demo-retailer",
                      "id": 500,
                      "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": "<unknown>",
                  "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": {
                  "name": "Demo Retailer",
                  "code": "demo-retailer",
                  "id": 500,
                  "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": {
                    "name": "Demo Retailer",
                    "code": "demo-retailer",
                    "id": 500,
                    "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": {
                      "name": "Demo Retailer",
                      "code": "demo-retailer",
                      "id": 500,
                      "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": {
                  "name": "Demo Retailer",
                  "code": "demo-retailer",
                  "id": 500,
                  "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": {
                "category": "CategoryANC",
                "id": 453,
                "retailer": {
                  "name": "Demo Retailer",
                  "code": "demo-retailer",
                  "id": 500,
                  "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"
                }
              },
              "inventory": {
                "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_updated_at": "2022-11-10T15:24:56Z",
                "estimated_availability_date": "2022-09-10T15:24:56Z",
                "discontinued": true,
                "discontinued_updated_at": null,
                "inventory": 0,
                "sellable": "No",
                "replenishable": true,
                "locations": [
                  {
                    "id": 1,
                    "address": {
                      "name1": "Demo Brand, Inc",
                      "street1": "1332 Hermosa Ave",
                      "city": "Hermosa Beach",
                      "province": "CA",
                      "postal_code": "90254",
                      "country": "US",
                      "id": 10,
                      "type": "residential",
                      "name2": null,
                      "street2": null,
                      "phone1": "3105551212",
                      "phone2": "3105551213",
                      "fax": null,
                      "email": null,
                      "federal_tax_id": null
                    },
                    "inventory": 0,
                    "nickname": "LA Warehouse"
                  }
                ]
              }
            },
            "invoice_line_number": 2,
            "item_brand_identifier": "Vend134",
            "item_upc": "911911911112",
            "name": "SamPro1",
            "description": "Sample description of product",
            "canceled_at": null,
            "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": [
        {
          "quantity": 10,
          "id": 566,
          "variant": {
            "id": 100024,
            "name": "T-Shirt, Blue, L",
            "brand": {
              "code": "demo-brand",
              "id": 500,
              "name": "Marla Cielo",
              "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": [
              {
                "code": "size",
                "name": "Size",
                "type": "money",
                "id": 44,
                "editable_by": "brand",
                "grouping": "general",
                "description": "demo product description",
                "units": "USD",
                "values": {
                  "id": 123,
                  "value": "<string>",
                  "unit": {
                    "id": 677,
                    "name": "Sample unit",
                    "standard_unit": "<string>",
                    "type": "cost",
                    "system": "metric",
                    "symbol": "USD"
                  },
                  "retailer": {
                    "name": "Demo Retailer",
                    "code": "demo-retailer",
                    "id": 500,
                    "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": "<unknown>",
                "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": {
                "name": "Demo Retailer",
                "code": "demo-retailer",
                "id": 500,
                "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": {
                  "name": "Demo Retailer",
                  "code": "demo-retailer",
                  "id": 500,
                  "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": {
                    "name": "Demo Retailer",
                    "code": "demo-retailer",
                    "id": 500,
                    "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": {
                "name": "Demo Retailer",
                "code": "demo-retailer",
                "id": 500,
                "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": {
              "category": "CategoryANC",
              "id": 453,
              "retailer": {
                "name": "Demo Retailer",
                "code": "demo-retailer",
                "id": 500,
                "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"
              }
            },
            "inventory": {
              "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_updated_at": "2022-11-10T15:24:56Z",
              "estimated_availability_date": "2022-09-10T15:24:56Z",
              "discontinued": true,
              "discontinued_updated_at": null,
              "inventory": 0,
              "sellable": "No",
              "replenishable": true,
              "locations": [
                {
                  "id": 1,
                  "address": {
                    "name1": "Demo Brand, Inc",
                    "street1": "1332 Hermosa Ave",
                    "city": "Hermosa Beach",
                    "province": "CA",
                    "postal_code": "90254",
                    "country": "US",
                    "id": 10,
                    "type": "residential",
                    "name2": null,
                    "street2": null,
                    "phone1": "3105551212",
                    "phone2": "3105551213",
                    "fax": null,
                    "email": null,
                    "federal_tax_id": null
                  },
                  "inventory": 0,
                  "nickname": "LA Warehouse"
                }
              ]
            }
          },
          "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

RMA ID

retailer_pk · number · required

Retailer ID

Body

application/json

order_id · integer · required

Order ID

Example:

1000

reason_id · integer · required

ID associated with return reason

Example:

344

rma_number · string | null

RMA number

Maximum string length: 32

Example:

"ABC123"

status · enum<string> | null

RMA status. Default is Pending.

Available options: pending, approved, rejected

Example:

"Pending"

currency · object

Show child attributes

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

acknowledged_at · string<date-time> | null

Time of RMA acknowledgement (UTC format)

Example:

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

retailer · object

Show child attributes

brand · object

Show child attributes

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 · read-only

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

Example:

4

purchase_order_number · string · read-only

Purchase order number

Minimum string length: 1

Example:

"CS192168"

rma_number · string | null

RMA number

Maximum string length: 32

Example:

"ABC123"

status · enum<string> | null

RMA status. Default is Pending.

Available options: pending, approved, rejected

Example:

"Pending"

currency · object

Show child attributes

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> · read-only

Time of order finalization (UTC format)

Example:

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

acknowledged_at · string<date-time> | null

Time of RMA acknowledgement (UTC format)

Example:

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

rma_lines · object[] · read-only

Show child attributes

reason · string · read-only

Reason for return

Minimum string length: 1

Example:

"Incorrect"

memos · object[] · read-only

Show child attributes

attachments · object[] · read-only

Show child attributes

retailer · object

Show child attributes

brand · object

Show child attributes

total_amount · string · read-only

Total amount

Example:

"34.00"

credits · object[] · read-only

Show child attributes