GET
/
v1
/
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

id
integer
required

Connection ID

retailer_pk
number
required

Retailer ID

Response

200 - application/json
brand
object
required
connection_credentials
object[]
required
id
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_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 connectionsGet inventory of a single variant