GET
/
v1
/
retailers
/
{retailer_pk}
/
connections
/
{id}
/
curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/connections/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 1050,
  "brand": {
    "id": 5424,
    "name": "Vendor ABC",
    "code": "vendor_abc",
    "logo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
    "cover_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
    "profile_tile_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
    "uuid": "54a947ea-19db-4563-8447-1bb2f113c127",
    "joined_at": "2021-09-10T15:24:56Z",
    "default_ship_from_location": {
      "id": 87574,
      "nickname": "Sample Location",
      "type": "warehouse",
      "address": null
    },
    "connections_manager": {
      "id": 355,
      "first_name": "Demo",
      "last_name": "Sample",
      "email": "demo.sample@gmail.com",
      "title": "Dr",
      "phone": "1234567890",
      "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
    },
    "merchandising_manager": {
      "id": 355,
      "first_name": "Demo",
      "last_name": "Sample",
      "email": "demo.sample@gmail.com",
      "title": "Dr",
      "phone": "1234567890",
      "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
    },
    "shipping_manager": {
      "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
    },
    "preferences": [
      {
        "id": 901,
        "name": "Currency",
        "code": "currency",
        "type": "freeform",
        "grouping": "Orders",
        "priority": 5,
        "description": "Sample description for demo preference",
        "content_type": null,
        "default_option": {
          "id": 234,
          "name": "Sample Prefs",
          "code": "sample_prefs",
          "value": "<string>",
          "currency": {
            "id": 1,
            "name": "United States Dollar",
            "symbol": "$",
            "unit": "USD"
          },
          "timezone": {
            "id": 7567,
            "name": "Demo",
            "code": "demo"
          }
        },
        "options": [
          {
            "id": 234,
            "name": "Sample Prefs",
            "code": "sample_prefs",
            "value": "<string>",
            "currency": {
              "id": 1,
              "name": "United States Dollar",
              "symbol": "$",
              "unit": "USD"
            },
            "timezone": {
              "id": 7567,
              "name": "Demo",
              "code": "demo"
            }
          }
        ],
        "payload_type": "value",
        "brand_preference": {
          "id": 545,
          "option_id": "656",
          "currency": {
            "id": 1,
            "name": "United States Dollar",
            "symbol": "$",
            "unit": "USD"
          },
          "timezone": {
            "id": 7567,
            "name": "Demo",
            "code": "demo"
          },
          "value": "<string>"
        },
        "retailer_preference": {
          "id": 124,
          "option_id": "SampleOpt123",
          "currency": {
            "id": 1,
            "name": "United States Dollar",
            "symbol": "$",
            "unit": "USD"
          },
          "timezone": {
            "id": 7567,
            "name": "Demo",
            "code": "demo"
          },
          "value": "<string>"
        },
        "user_preference": {
          "id": 154,
          "option_id": "Sample Option",
          "currency": {
            "id": 1,
            "name": "United States Dollar",
            "symbol": "$",
            "unit": "USD"
          },
          "timezone": {
            "id": 7567,
            "name": "Demo",
            "code": "demo"
          },
          "value": "<string>"
        }
      }
    ],
    "verticals": [
      {
        "id": 123,
        "name": "Sample Vertical",
        "code": "sample_vertical",
        "assets": [
          {}
        ]
      }
    ],
    "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"
      }
    ],
    "website": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
    "is_onboarded": true,
    "onboarded_at": "2021-09-10T15:24:56Z",
    "assigned_onboarding_tasks": {
      "id": 125,
      "onboarding_task": {
        "id": 345,
        "name": "Task1",
        "code": "task1",
        "description": "Onboard sample task 1",
        "type": "Initial",
        "priority": 2,
        "status": "In Progress",
        "content_type": "PDF",
        "created_at": "2021-09-10T15:24:56Z"
      },
      "info": {},
      "completed_at": "2021-09-10T15:24:56Z",
      "completed_by": {
        "id": 145,
        "first_name": "Demo",
        "last_name": "Sample",
        "name": "Demo Sample",
        "email": "demo@xyz.com",
        "title": "Mr",
        "status": "active",
        "type": "standard"
      },
      "created_at": "2021-09-10T15:24:56Z"
    },
    "requires_subscription": "disabled",
    "inventory_policy": "unmanaged"
  },
  "level": "basic",
  "status": "active",
  "suspended_at": null,
  "created_at": "2021-09-10T15:24:56Z",
  "updated_at": "2022-11-10T15:24:56Z",
  "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"
        }
      }
    }
  ],
  "connection_contacts": [
    {
      "id": 1546,
      "contact_type": "merchandising",
      "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"
      },
      "user_id": 201,
      "first_name": "Demo",
      "last_name": "Sample",
      "email": "demo-sample@anc.com",
      "phone": "12456245984"
    }
  ],
  "connection_credentials": [
    {
      "id": 125,
      "name": "SampleCred",
      "value": "Sample1",
      "code": "sample_cred",
      "is_encrypted": true
    }
  ],
  "connection_fees": {
    "id": 1000,
    "payment_model": "managed",
    "payment_terms": "net60",
    "net_price_method": "permit_cost",
    "revshare_fraction": "0.4000",
    "revc_fee_flat": "0.00",
    "revc_fee_fraction": "0.0300",
    "brand_fee_flat": "0.00",
    "brand_flat_order_fee": "0.00",
    "brand_percent_order_fee": "0.0000",
    "effective_at": "2015-10-10T00:00:00Z"
  },
  "connection_slas": {
    "id": 1000,
    "brand_inventory_hours": 24,
    "brand_fulfillment_hours": 48,
    "brand_cancel_hours": 24,
    "brand_acknowledge_hours": 12,
    "retailer_cancel_hours": 24,
    "retailer_return_hours": 720
  },
  "connection_adjustments": [
    {
      "id": 123442,
      "adjustment_code": {
        "id": 1,
        "adjustment_type": "Allowance",
        "code": "returns_allowance",
        "description": "returns_allowance"
      },
      "description": "Sample description for monetary adjustments",
      "adjustment_type": "Discount",
      "adjustment_amount_type": "flat",
      "adjustment_amount": "12",
      "content_type": "PDF",
      "object_id": 45646
    }
  ],
  "options": {
    "id": 8753,
    "name": "Sample Option",
    "code": "Sample_Option",
    "description": "Sample description for connection",
    "viewable_by": "All",
    "editable_by": "Staff"
  },
  "approved_items_count": 2,
  "orders_last_7_days_count": 8,
  "proposals_received_last_7_days_count": 8,
  "metadata": "<string>",
  "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"
    }
  ],
  "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
  },
  "packing_slip_template": "<string>",
  "integration_type": "API",
  "retailer_identifier": "Retailer 877",
  "onboarding_status": "Completed",
  "onboarding_target_date": "2021-09-10T15:24:56Z",
  "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

​
id
integer
required

Connection ID

​
retailer_pk
number
required

Retailer ID

Response

200 - application/json

OK

​
brand
object
required
​
connection_credentials
object[]
required
​
id
integer

Retailer connection ID

Example:

1050

​
level
enum<string>

Retailer connection type

Available options:
basic,
full
Example:

"basic"

​
status
enum<string>

Retailer connection status

Available options:
active,
suspended,
pending,
onboarding
Example:

"active"

​
suspended_at
string | null

Time of when the retailer connection got suspended (UTC format)

Example:

null

​
created_at
string

Time of retailer connection creation (UTC format)

Example:

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

​
updated_at
string

Time of retailer connection update (UTC format)

Example:

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

​
shipping_accounts
object[]
​
connection_contacts
object[]
​
connection_fees
object
​
connection_slas
object
​
connection_adjustments
object[]
​
options
object
​
approved_items_count
integer

Count of approved items

Example:

2

​
orders_last_7_days_count
integer

Count of orders in the last 7 days

Example:

8

​
proposals_received_last_7_days_count
integer

Count of proposals received in the last 7 days

Example:

8

​
metadata
string

Additional information, if any

​
attachments
object[]
​
memos
object[]
​
referral
object
​
packing_slip_template
string | null

Template of the packing slip

Maximum length: 64
​
integration_type
enum<string> | null

Integration type

Available options:
console,
edi,
api,
storefront,
console-print-labels,
console-register-tracking-numbers,
shopify,
bigcommerce,
shipstation
Example:

"API"

​
retailer_identifier
string | null

Retailer identifier

Maximum length: 32
Example:

"Retailer 877"

​
onboarding_status
enum<string> | null

Status of retailer onboarding

Available options:
pending,
complete
Example:

"Completed"

​
onboarding_target_date
string | null

Target date for retailer onboarding (UTC format)

Example:

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

​
onboarded_at
string | null

Time of retailer onboarding (UTC format)

Example:

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