Get vendor connections

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

brand_id

array

retailer_id

array

vertical_id

array

integration_type

array

brand_has_adjustments

number

brand_has_allowances

number

brand_has_charges

number

brand_inventory_policy

string

retailer_identifier

array

options_enabled

array

options_disabled

string

status

array

onboarding_target_date_lt

number

onboarding_target_date_lte

number

onboarding_target_date_gt

number

onboarding_target_date_gte

number

order_by

string

page

integer

limit

integer

Authorizations

Authorization

string

headerrequired

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

Path Parameters

retailer_pk

number

required

Retailer ID

Query Parameters

brand_id

number[]

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

retailer_id

number[]

Retailer IDs. Multiple values may be separated by commas. Retailer ID

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 <br /> 0: Brand doesn't have adjustments

brand_has_allowances

number

1: brand has allowances such as discounts <br /> 0: brand does not have allowances

brand_has_charges

number

1: brand has charges such as shipping and handling <br /> 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

count

integer

required

Total number of records

results

object[]

required

results.id

integer

Connection ID

results.brand

object

results.retailer

object

results.level

enum<string>

Connection level

Available options:

basic,

full

results.status

enum<string>

Connection status

Available options:

active,

suspended,

pending,

onboarding

results.suspended_at

string | null

Time of when connection got suspended (UTC format)

results.created_at

string

Time of connection creation (UTC format)

results.updated_at

string

Time of connection update (UTC format)

results.shipping_accounts

object[]

results.options

object

results.attachments

object[]

results.approved_items_count

integer

Count of approved items

results.orders_last_7_days_count

integer

Count of orders in the last 7 days

results.proposals_received_last_7_days_count

integer

Count of proposals received in the last 7 days

results.contacts

object[]

results.memos

object[]

results.referral

object

results.integration_type

enum<string> | null

Integration type

Available options:

console,

edi,

api,

storefront,

console-print-labels,

console-register-tracking-numbers,

shopify,

bigcommerce,

shipstation

results.onboarding_status

enum<string> | null

Status of onboarding

Available options:

pending,

complete

results.retailer_identifier

string | null

Retailer ID

Maximum length: 32

results.onboarding_target_date

string | null

Target date of retailer onboarding (UTC format)

results.onboarded_at

string | null

Time of retailer onboarding (UTC format)

string | null

Next page (applicable in a paginated response)

string | null

Previous page (applicable in a paginated response)

Was this page helpful?

Get details of a single invoice Get connections of a single vendor