GET
/
v1
/
retailers
/
{retailer_id}
/
connections
curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/connections/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 1023,
  "next": "https://api.example.org/demo/accounts/?page=5",
  "previous": "https://api.example.org/demo/accounts/?page=3",
  "results": [
    {
      "id": 1000,
      "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": 500,
        "name": "Demo Retailer",
        "code": "demo-retailer",
        "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
        "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
        "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
        "joined_at": "2021-08-03T17:24:12Z",
        "is_rcn_retailer": false,
        "is_onboarded": false,
        "platform": "fabric",
        "requires_subscription": "disabled",
        "brand_permit_creation_allowed": false,
        "website": "https://demoabc.com",
        "status": "active"
      },
      "level": "full",
      "status": "active",
      "suspended_at": null,
      "created_at": "2022-06-22T06:56:16Z",
      "updated_at": "2022-08-08T15:48:05Z",
      "shipping_accounts": [
        {
          "id": 1,
          "nickname": "Sample13",
          "owner": "DemoABC",
          "carrier": "ALP Brand",
          "shipping_methods": {
            "id": 5,
            "name": "White Glove Bronze",
            "code": "cory_white_glove",
            "type": "ltl (less than truck load)",
            "carrier": {
              "id": 229,
              "name": "Cory Companies",
              "code": "CJCD"
            },
            "generic_shipping_method": {
              "id": 5,
              "name": "LTL",
              "description": "Less than truckload (LTL)",
              "type": "ltl"
            }
          }
        }
      ],
      "options": {
        "id": 8753,
        "name": "Sample Option",
        "code": "Sample_Option",
        "description": "Sample description for connection",
        "viewable_by": "All",
        "editable_by": "Staff"
      },
      "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"
        }
      ],
      "approved_items_count": 1,
      "orders_last_7_days_count": 0,
      "proposals_received_last_7_days_count": 4,
      "contacts": [
        {
          "id": 1010,
          "name": "sample contact",
          "email": "demo@xyz.com",
          "phone": "9765314368",
          "description": "Call",
          "created_at": "2021-09-10T15:24: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"
        }
      ],
      "referral": {
        "id": 125,
        "referrer": {
          "id": 675,
          "code": "retailer_abc",
          "name": "Retailer ABC"
        },
        "referee": {
          "id": 675,
          "code": "retailer_abc",
          "name": "Retailer ABC"
        },
        "is_brand_first_connection": "false\"",
        "is_retailer_first_connection": true
      },
      "integration_type": "console",
      "onboarding_status": "pending",
      "retailer_identifier": null,
      "onboarding_target_date": null,
      "onboarded_at": "2021-09-10T15:24:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
retailer_id
number
required

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

Query Parameters

​
brand_id
number[]

Brand (vendor) IDs. Multiple comma separated values may be added

​
retailer_id
number[]

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

​
vertical_id
number[]

ID for verticals such as shoes, clothing, furniture. Multiple values may be added, separated by commas

​
integration_type
string[]

Integration types such as EDI, API, WooCommerce, etc. Multiple values may be separated by commas

​
brand_has_adjustments
number

1: Brand (vendor) has monetary adjustments | 0: Brand doesn't have adjustments

​
brand_has_allowances
number

1: brand has allowances such as discounts | 0: brand does not have allowances

​
brand_has_charges
number

1: brand has charges such as shipping and handling | 0: brand does not have charges

​
brand_inventory_policy
string

Managed: brand wants to manage inventory; Unmanaged: brand does not want to manage inventory

​
retailer_identifier
number[]

Retailer IDs. Multiple values may be separated by commas.

​
options_enabled
string[]

Connection options enabled. Multiple values may be separated by commas.

​
options_disabled
string

Connection options disabled

​
status
string[]

Connection status. Multiple values may be separated by commas.

​
onboarding_target_date_lt
number

Onboarding target date is less than specified Time (Unix epoch format)

​
onboarding_target_date_lte
number

Onboarding target date is less than or equal to specified Time (Unix epoch format)

​
onboarding_target_date_gt
number

Onboarding target date is greater than specified Time (Unix epoch format)

​
onboarding_target_date_gte
number

Onboarding target date is greater than or equal to specified Time (Unix epoch format)

​
order_by
string

Sorting criteria

​
page
integer

Page number within the paginated result set

​
limit
integer

Number of records per page

Response

200 - application/json
OK
​
count
integer
required

Total number of records

Example:

1023

​
results
object[]
required
​
next
string | null

Next page (applicable in a paginated response)

Example:

"https://api.example.org/demo/accounts/?page=5"

​
previous
string | null

Previous page (applicable in a paginated response)

Example:

"https://api.example.org/demo/accounts/?page=3"