Get connections of a single vendor

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
- GET
  Get vendor connections
- GET
  Get connections of a single vendor
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

GET

retailers

{retailer_pk}

connections

{id}

Authorizations

Authorization

string

headerrequired

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

Path Parameters

integer

required

Connection ID

retailer_pk

number

required

Retailer ID

Response

200 - application/json

brand

object

required

brand.code

string

required

Vendor contact code

Required string length: 1 - 64

brand.id

integer

ID of vendor (or brand) contact

brand.name

string

Vendor contact name

Required string length: 1 - 64

brand.logo_url

string

URL of vendor logo

Minimum length: 1

brand.cover_url

string

URL of the vendor cover

Minimum length: 1

brand.profile_tile_url

string

URL of the vendor profile image

Minimum length: 1

brand.uuid

string

Universally unique identifier (UUID)

Maximum length: 36

brand.joined_at

string

Time of vendor joining the platform (UTC format)

brand.default_ship_from_location

object

brand.connections_manager

object

brand.merchandising_manager

object

brand.shipping_manager

object

brand.preferences

object[]

brand.preferences.id

integer

Preference ID

brand.preferences.name

string

required

Preference name

Required string length: 1 - 64

brand.preferences.code

string

required

Preference code

Required string length: 1 - 64

brand.preferences.type

enum<string>

required

Preference type

Available options:

boolean,

link,

options,

freeform,

integer,

decimal

brand.preferences.grouping

enum<string>

Grouping preference

Available options:

locale,

misc,

onboarding,

orders,

proposals,

products

brand.preferences.priority

integer

Preference priority

Required range: 0 < x < 4294967295

brand.preferences.description

string

Preference description

brand.preferences.content_type

integer

required

Content type

brand.preferences.default_option

object

brand.preferences.options

object[]

brand.preferences.payload_type

string

Payload type. Default type is value.

brand.preferences.brand_preference

object

brand.preferences.retailer_preference

object

brand.preferences.user_preference

object

brand.verticals

object[]

brand.attachments

object[]

brand.website

string | null

Brand URL

Maximum length: 100

brand.is_onboarded

boolean

true: brand is onboarded <br /> false: brand is not onboarded

brand.onboarded_at

string | null

Time of vendor onboarding (UTC format)

brand.assigned_onboarding_tasks

object

brand.assigned_onboarding_tasks.id

integer

Onboarding task ID (vendor context)

brand.assigned_onboarding_tasks.onboarding_task

object

brand.assigned_onboarding_tasks.info

object

JSON object with details, if applicable

brand.assigned_onboarding_tasks.completed_at

string

Time of task completion (UTC format)

brand.assigned_onboarding_tasks.completed_by

object

brand.assigned_onboarding_tasks.created_at

string

Time of task creation (UTC format)

brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

connection_credentials

object[]

required

integer

Retailer connection ID

level

enum<string>

Retailer connection type

Available options:

basic,

full

status

enum<string>

Retailer connection status

Available options:

active,

suspended,

pending,

onboarding

suspended_at

string | null

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

created_at

string

Time of retailer connection creation (UTC format)

updated_at

string

Time of retailer connection update (UTC format)

shipping_accounts

object[]

connection_contacts

object[]

connection_contacts.id

integer

ID of connection contact

connection_contacts.contact_type

enum<string>

Contact type

Available options:

orders,

merchandising,

finance,

inventory

connection_contacts.brand

object

connection_contacts.retailer

object

connection_contacts.user_id

integer

User ID

connection_contacts.first_name

string

First name of contact

Minimum length: 1

connection_contacts.last_name

string

Last name of contact

Minimum length: 1

connection_contacts.email

string

Email ID of contact

Minimum length: 1

connection_contacts.phone

string

Phone number of contact

Minimum length: 1

connection_fees

object

connection_slas

object

connection_adjustments

object[]

options

object

approved_items_count

integer

Count of approved items

orders_last_7_days_count

integer

Count of orders in the last 7 days

proposals_received_last_7_days_count

integer

Count of proposals received in the last 7 days

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

retailer_identifier

string | null

Retailer identifier

Maximum length: 32

onboarding_status

enum<string> | null

Status of retailer onboarding

Available options:

pending,

complete

onboarding_target_date

string | null

Target date for retailer onboarding (UTC format)

onboarded_at

string | null

Time of retailer onboarding (UTC format)

Was this page helpful?

Get vendor connections Get inventory of a single variant