Get connections of a single vendor

Gets the connection details for a specified vendor

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

brand

object

required

Show child attributes

brand.code

string

required

Vendor contact code

Required string length: 1 - 64

brand.assigned_onboarding_tasks

object

Show child attributes

brand.assigned_onboarding_tasks.completed_at

string

Time of task completion (UTC format)

brand.assigned_onboarding_tasks.completed_by

object

Show child attributes

brand.assigned_onboarding_tasks.completed_by.email

string | null

Email address of user

Maximum length: 128

brand.assigned_onboarding_tasks.completed_by.first_name

string | null

First name of user

Maximum length: 64

brand.assigned_onboarding_tasks.completed_by.id

integer

User ID

brand.assigned_onboarding_tasks.completed_by.last_name

string | null

Last name of user

Maximum length: 64

brand.assigned_onboarding_tasks.completed_by.name

string

Full name of user

Minimum length: 1

brand.assigned_onboarding_tasks.completed_by.status

enum<string>

User status

Available options:

active,

invited,

locked

brand.assigned_onboarding_tasks.completed_by.title

string | null

Title of user

Maximum length: 64

brand.assigned_onboarding_tasks.completed_by.type

enum<string>

User type

Available options:

standard,

api

brand.assigned_onboarding_tasks.created_at

string

Time of task creation (UTC format)

brand.assigned_onboarding_tasks.id

integer

Onboarding task ID (vendor context)

brand.assigned_onboarding_tasks.info

object

JSON object with details, if applicable

brand.assigned_onboarding_tasks.onboarding_task

object

Show child attributes

brand.assigned_onboarding_tasks.onboarding_task.code

string

required

Task code

Required string length: 1 - 64

brand.assigned_onboarding_tasks.onboarding_task.name

string

required

Task name

Required string length: 1 - 128

brand.assigned_onboarding_tasks.onboarding_task.priority

integer

required

Task prority

Required range: 0 < x < 4294967295

brand.assigned_onboarding_tasks.onboarding_task.status

enum<string>

required

Task status

Available options:

active,

inactive

brand.assigned_onboarding_tasks.onboarding_task.type

enum<string>

required

Task type

Available options:

initial,

conditional,

network

brand.assigned_onboarding_tasks.onboarding_task.content_type

string

Content type

Minimum length: 1

brand.assigned_onboarding_tasks.onboarding_task.created_at

string

Time of task creation (UTC format)

brand.assigned_onboarding_tasks.onboarding_task.description

string | null

Task descripton

Maximum length: 256

brand.assigned_onboarding_tasks.onboarding_task.id

integer

Onboarding task ID

brand.attachments

object[]

Show child attributes

brand.attachments.content_type

integer

Content type

brand.attachments.file

string | null

File name

brand.attachments.filename

string | null

File name used for sharing

Maximum length: 255

brand.attachments.id

integer

Attachment or document ID

brand.attachments.object_id

integer

Attachement object ID

brand.attachments.original_filename

string | null

Original file name

Maximum length: 255

brand.attachments.tags

object[]

Show child attributes

brand.attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

brand.attachments.tags.id

integer

Attachment tag ID

brand.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

brand.attachments.url

string

URL of attachment

Minimum length: 1

brand.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

brand.connections_manager

object

Show child attributes

brand.connections_manager.email

string | null

Email address of user

Maximum length: 128

brand.connections_manager.first_name

string | null

First name of user

Maximum length: 64

brand.connections_manager.id

integer

User ID

brand.connections_manager.is_me

boolean

true: logged in user is me <br /> logged in user is not me

brand.connections_manager.last_name

string | null

Last name of user

Maximum length: 64

brand.connections_manager.phone

string | null

Contact number of user

Maximum length: 16

brand.connections_manager.photo_url

string

URL of user image

Minimum length: 1

brand.connections_manager.profile_photo

string

URL of profile image

Minimum length: 1

brand.connections_manager.status

enum<string>

Status of user

Available options:

active,

invited,

locked

brand.connections_manager.title

string | null

Title of the user

Maximum length: 64

brand.connections_manager.type

enum<string>

User type

Available options:

standard,

api

brand.cover_url

string

URL of the vendor cover

Minimum length: 1

brand.default_ship_from_location

object

Show child attributes

brand.default_ship_from_location.nickname

string

required

Location nickname

Required string length: 1 - 64

brand.default_ship_from_location.address

string

Location address

brand.default_ship_from_location.id

integer

Location ID

brand.default_ship_from_location.type

enum<string>

Location type

Available options:

warehouse,

store,

headquarters,

billing,

return_center,

ship_to

brand.id

integer

ID of vendor (or brand) contact

brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

brand.is_onboarded

boolean

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

brand.joined_at

string

Time of vendor joining the platform (UTC format)

brand.logo_url

string

URL of vendor logo

Minimum length: 1

brand.merchandising_manager

object

Show child attributes

brand.merchandising_manager.email

string | null

Email address of user

Maximum length: 128

brand.merchandising_manager.first_name

string | null

First name of user

Maximum length: 64

brand.merchandising_manager.id

integer

User ID

brand.merchandising_manager.is_me

boolean

true: logged in user is me <br /> logged in user is not me

brand.merchandising_manager.last_name

string | null

Last name of user

Maximum length: 64

brand.merchandising_manager.phone

string | null

Contact number of user

Maximum length: 16

brand.merchandising_manager.photo_url

string

URL of user image

Minimum length: 1

brand.merchandising_manager.profile_photo

string

URL of profile image

Minimum length: 1

brand.merchandising_manager.status

enum<string>

Status of user

Available options:

active,

invited,

locked

brand.merchandising_manager.title

string | null

Title of the user

Maximum length: 64

brand.merchandising_manager.type

enum<string>

User type

Available options:

standard,

api

brand.name

string

Vendor contact name

Required string length: 1 - 64

brand.onboarded_at

string | null

Time of vendor onboarding (UTC format)

brand.preferences

object[]

Show child attributes

brand.preferences.code

string

required

Preference code

Required string length: 1 - 64

brand.preferences.content_type

integer

required

Content type

brand.preferences.name

string

required

Preference name

Required string length: 1 - 64

brand.preferences.type

enum<string>

required

Preference type

Available options:

boolean,

link,

options,

freeform,

integer,

decimal

brand.preferences.brand_preference

object

Show child attributes

brand.preferences.brand_preference.currency

object

Show child attributes

brand.preferences.brand_preference.currency.id

integer

Currency ID

brand.preferences.brand_preference.currency.name

string

Currency name

Maximum length: 200

brand.preferences.brand_preference.currency.symbol

string | null

Currency symbol

Maximum length: 5

brand.preferences.brand_preference.currency.unit

string

Currency unit

brand.preferences.brand_preference.id

integer

Brand preference ID

brand.preferences.brand_preference.option_id

string

Option ID

brand.preferences.brand_preference.timezone

object

Show child attributes

brand.preferences.brand_preference.timezone.code

string

required

Timezone code

Required string length: 1 - 32

brand.preferences.brand_preference.timezone.name

string

required

Timezone name

Required string length: 1 - 32

brand.preferences.brand_preference.timezone.id

integer

Timezone ID

brand.preferences.brand_preference.value

string | null

Value based on the preference

Maximum length: 256

brand.preferences.default_option

object

Show child attributes

brand.preferences.default_option.code

string

required

Preference option code

Required string length: 1 - 32

brand.preferences.default_option.name

string

required

Preference option name

Required string length: 1 - 32

brand.preferences.default_option.currency

object

Show child attributes

brand.preferences.default_option.currency.id

integer

Currency ID

brand.preferences.default_option.currency.name

string

Currency name

Maximum length: 200

brand.preferences.default_option.currency.symbol

string | null

Currency symbol

Maximum length: 5

brand.preferences.default_option.currency.unit

string

Currency unit

brand.preferences.default_option.id

integer

Preference option ID

brand.preferences.default_option.timezone

object

Show child attributes

brand.preferences.default_option.timezone.code

string

required

Timezone code

Required string length: 1 - 32

brand.preferences.default_option.timezone.name

string

required

Timezone name

Required string length: 1 - 32

brand.preferences.default_option.timezone.id

integer

Timezone ID

brand.preferences.default_option.value

string | null

Preference option value

Maximum length: 256

brand.preferences.description

string

Preference description

brand.preferences.grouping

enum<string>

Grouping preference

Available options:

locale,

misc,

onboarding,

orders,

proposals,

products

brand.preferences.id

integer

Preference ID

brand.preferences.options

object[]

Show child attributes

brand.preferences.options.code

string

required

Preference option code

Required string length: 1 - 32

brand.preferences.options.name

string

required

Preference option name

Required string length: 1 - 32

brand.preferences.options.currency

object

Show child attributes

brand.preferences.options.currency.id

integer

Currency ID

brand.preferences.options.currency.name

string

Currency name

Maximum length: 200

brand.preferences.options.currency.symbol

string | null

Currency symbol

Maximum length: 5

brand.preferences.options.currency.unit

string

Currency unit

brand.preferences.options.id

integer

Preference option ID

brand.preferences.options.timezone

object

Show child attributes

brand.preferences.options.timezone.code

string

required

Timezone code

Required string length: 1 - 32

brand.preferences.options.timezone.name

string

required

Timezone name

Required string length: 1 - 32

brand.preferences.options.timezone.id

integer

Timezone ID

brand.preferences.options.value

string | null

Preference option value

Maximum length: 256

brand.preferences.payload_type

string

Payload type. Default type is value.

brand.preferences.priority

integer

Preference priority

Required range: 0 < x < 4294967295

brand.preferences.retailer_preference

object

Show child attributes

brand.preferences.retailer_preference.currency

object

Show child attributes

brand.preferences.retailer_preference.currency.id

integer

Currency ID

brand.preferences.retailer_preference.currency.name

string

Currency name

Maximum length: 200

brand.preferences.retailer_preference.currency.symbol

string | null

Currency symbol

Maximum length: 5

brand.preferences.retailer_preference.currency.unit

string

Currency unit

brand.preferences.retailer_preference.id

integer

Retailer preference ID

brand.preferences.retailer_preference.option_id

string

Option ID

brand.preferences.retailer_preference.timezone

object

Show child attributes

brand.preferences.retailer_preference.timezone.code

string

required

Timezone code

Required string length: 1 - 32

brand.preferences.retailer_preference.timezone.name

string

required

Timezone name

Required string length: 1 - 32

brand.preferences.retailer_preference.timezone.id

integer

Timezone ID

brand.preferences.retailer_preference.value

string | null

Value based on the preference

Maximum length: 256

brand.preferences.user_preference

object

Show child attributes

brand.preferences.user_preference.currency

object

Show child attributes

brand.preferences.user_preference.currency.id

integer

Currency ID

brand.preferences.user_preference.currency.name

string

Currency name

Maximum length: 200

brand.preferences.user_preference.currency.symbol

string | null

Currency symbol

Maximum length: 5

brand.preferences.user_preference.currency.unit

string

Currency unit

brand.preferences.user_preference.id

integer

User preference ID

brand.preferences.user_preference.option_id

string

Option ID

brand.preferences.user_preference.timezone

object

Show child attributes

brand.preferences.user_preference.timezone.code

string

required

Timezone code

Required string length: 1 - 32

brand.preferences.user_preference.timezone.name

string

required

Timezone name

Required string length: 1 - 32

brand.preferences.user_preference.timezone.id

integer

Timezone ID

brand.preferences.user_preference.value

string | null

Value based on the preference

Maximum length: 256

brand.profile_tile_url

string

URL of the vendor profile image

Minimum length: 1

brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

brand.shipping_manager

object

Show child attributes

brand.shipping_manager.first_name

string | null

First name of user

Maximum length: 64

brand.shipping_manager.id

integer

User ID who accepted or rejected the invoice

brand.shipping_manager.is_me

boolean

true: user is me: <br /> false: user is not me

brand.shipping_manager.last_name

string | null

Last name of user

Maximum length: 64

brand.shipping_manager.photo_url

string

URL of the user photo

Minimum length: 1

brand.shipping_manager.profile_photo

string

URL of the user's profile photo

Minimum length: 1

brand.shipping_manager.status

enum<string>

User status

Available options:

active,

invited,

locked

brand.shipping_manager.title

string | null

User title

Maximum length: 64

brand.shipping_manager.type

enum<string>

User type

Available options:

standard,

api

brand.uuid

string

Universally unique identifier (UUID)

Maximum length: 36

brand.verticals

object[]

Show child attributes

brand.verticals.code

string

required

Vertical code

Required string length: 1 - 32

brand.verticals.name

string

required

Vertical name

Required string length: 1 - 32

brand.verticals.assets

any[]

brand.verticals.id

integer

Vertical ID

brand.website

string | null

Brand URL

Maximum length: 100

connection_credentials

object[]

required

Show child attributes

connection_credentials.code

string

required

Connection credential code

Required string length: 1 - 256

connection_credentials.name

string

required

Connection credential name

Required string length: 1 - 256

connection_credentials.value

string

required

Connection credential value

Required string length: 1 - 2048

connection_credentials.id

integer

Connection credential ID

connection_credentials.is_encrypted

boolean

true: connection is encrypted <br /> <br /> connection is not encrypted

approved_items_count

integer

Count of approved items

attachments

object[]

Show child attributes

attachments.content_type

integer

Content type

attachments.file

string | null

File name

attachments.filename

string | null

File name used for sharing

Maximum length: 255

attachments.id

integer

Attachment or document ID

attachments.object_id

integer

Attachement object ID

attachments.original_filename

string | null

Original file name

Maximum length: 255

attachments.tags

object[]

Show child attributes

attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

attachments.tags.id

integer

Attachment tag ID

attachments.uploaded_by

integer | null

User ID that uploaded the attachment

attachments.url

string

URL of attachment

Minimum length: 1

attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

connection_adjustments

object[]

Show child attributes

connection_adjustments.description

string

required

Description of adjustment

Required string length: 1 - 256

connection_adjustments.adjustment_amount

string

Adjustment amount

connection_adjustments.adjustment_amount_type

enum<string>

Adjustment type - dollar amount or percentage

Available options:

percent,

flat

connection_adjustments.adjustment_code

object

Show child attributes

connection_adjustments.adjustment_code.adjustment_type

enum<string>

required

Adjustment type

Available options:

allowance,

charge

connection_adjustments.adjustment_code.code

string

required

Adjustment code

Required string length: 1 - 64

connection_adjustments.adjustment_code.description

string

required

Description of adjustment

Required string length: 1 - 128

connection_adjustments.adjustment_code.id

integer

Adjustment ID

connection_adjustments.adjustment_type

string

Adjustment type

connection_adjustments.content_type

string

Content type

Minimum length: 1

connection_adjustments.id

integer

Connection adjustment ID, used for monetary adjustments

connection_adjustments.object_id

integer | null

Object ID

Required range: 0 < x < 4294967295

connection_contacts

object[]

Show child attributes

connection_contacts.brand

object

Show child attributes

connection_contacts.brand.code

string

required

Vendor code, which is vendor name in lower case and underscore

Required string length: 1 - 64

connection_contacts.brand.cover_url

string

URL of the cover image

Minimum length: 1

connection_contacts.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

connection_contacts.brand.id

integer

Vendor (brand) ID

connection_contacts.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

connection_contacts.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

connection_contacts.brand.is_onboarded

boolean

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

connection_contacts.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

connection_contacts.brand.logo_url

string

URL of the brand logo

Minimum length: 1

connection_contacts.brand.name

string

Vendor name

Required string length: 1 - 64

connection_contacts.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

connection_contacts.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

connection_contacts.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

connection_contacts.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

connection_contacts.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

connection_contacts.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

connection_contacts.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

connection_contacts.brand.website

string | null

URL of brand website

Maximum length: 100

connection_contacts.contact_type

enum<string>

Contact type

Available options:

orders,

merchandising,

finance,

inventory

connection_contacts.email

string

Email ID of contact

Minimum length: 1

connection_contacts.first_name

string

First name of contact

Minimum length: 1

connection_contacts.id

integer

ID of connection contact

connection_contacts.last_name

string

Last name of contact

Minimum length: 1

connection_contacts.phone

string

Phone number of contact

Minimum length: 1

connection_contacts.retailer

object

Show child attributes

connection_contacts.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

connection_contacts.retailer.name

string

required

Retailer name

Required string length: 1 - 64

connection_contacts.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

connection_contacts.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

connection_contacts.retailer.id

integer

Retailer ID

connection_contacts.retailer.is_onboarded

boolean

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

connection_contacts.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

connection_contacts.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

connection_contacts.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

connection_contacts.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

connection_contacts.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

connection_contacts.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

connection_contacts.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

connection_contacts.retailer.website

string | null

Website URL

Maximum length: 100

connection_contacts.user_id

integer

User ID

connection_fees

object

Show child attributes

connection_fees.brand_fee_flat

string

Internal only

Minimum length: 1

connection_fees.brand_flat_order_fee

string | null

Internal only

connection_fees.brand_percent_order_fee

string | null

Vendor percentage of order fee

connection_fees.effective_at

string

Time connection fee became effective (UTC format)

connection_fees.id

integer

Connection fee ID

connection_fees.net_price_method

enum<string> | null

Method used to calculate net price

Available options:

estimated_commission,

product_cost,

specified_in_order,

revshare,

permit_cost

connection_fees.payment_model

enum<string> | null

Payment model

Available options:

direct,

managed

connection_fees.payment_terms

enum<string> | null

Payment terms

Available options:

net15,

net30,

net45,

net60,

net90

connection_fees.revc_fee_flat

string

Internal only

Minimum length: 1

connection_fees.revc_fee_fraction

string

Internal only

Minimum length: 1

connection_fees.revshare_fraction

string | null

Internal only

connection_slas

object

Show child attributes

connection_slas.brand_acknowledge_hours

integer

Timeframe for vendor to acknowledge order

Required range: 0 < x < 4294967295

connection_slas.brand_cancel_hours

integer

Timeframe for vendor to cancel order

Required range: 0 < x < 4294967295

connection_slas.brand_fulfillment_hours

integer

Fulfillment hours of brand

Required range: 0 < x < 4294967295

connection_slas.brand_inventory_hours

integer

Inventory update SLA (in hours)

Required range: 0 < x < 4294967295

connection_slas.id

integer

Connection SLA ID

connection_slas.retailer_cancel_hours

integer

Timeframe for retailers to cancel order

Required range: 0 < x < 4294967295

connection_slas.retailer_return_hours

integer

Timeframe for retailers to return order

Required range: 0 < x < 4294967295

created_at

string

Time of retailer connection creation (UTC format)

id

integer

Retailer connection ID

integration_type

enum<string> | null

Integration type

Available options:

console,

edi,

api,

storefront,

console-print-labels,

console-register-tracking-numbers,

shopify,

bigcommerce,

shipstation

level

enum<string>

Retailer connection type

Available options:

basic,

full

memos

object[]

Show child attributes

memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

memos.created_at

string

Time of memo creation (UTC format)

memos.created_by

object

Show child attributes

memos.created_by.first_name

string | null

First name of user

Maximum length: 64

memos.created_by.id

integer

User ID who accepted or rejected the invoice

memos.created_by.is_me

boolean

true: user is me: <br /> false: user is not me

memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

memos.created_by.title

string | null

User title

Maximum length: 64

memos.created_by.type

enum<string>

User type

Available options:

standard,

api

memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

memos.id

integer

Memo ID

memos.notify_people

boolean

true: notify stakeholders <br /> false: do not notify

memos.text

string

Memo text

memos.updated_at

string

Time of memo update (UTC format)

memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

metadata

string

Additional information, if any

onboarded_at

string | null

Time of retailer onboarding (UTC format)

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)

options

object

Show child attributes

options.code

string

required

Option code

Required string length: 1 - 64

options.name

string

required

Option name

Required string length: 1 - 64

options.description

string | null

Connection description

options.editable_by

enum<string> | null

User who can edit connection

Available options:

retailer,

brand,

staff

options.id

integer

Option ID

options.viewable_by

enum<string> | null

User who can view the connection details

Available options:

retailer,

brand,

all,

none

orders_last_7_days_count

integer

Count of orders in the last 7 days

packing_slip_template

string | null

Template of the packing slip

Maximum length: 64

proposals_received_last_7_days_count

integer

Count of proposals received in the last 7 days

referral

object

Show child attributes

referral.id

integer

ID of connection referral

referral.is_brand_first_connection

boolean

true: brand is first connection <br /> false: brand is not the first connection

referral.is_retailer_first_connection

boolean

true: retailer is first connection <br /> false: brand is not the first connection

referral.referee

object

Show child attributes

referral.referee.code

string

required

Retailer or Vendor (Brand) code

Required string length: 1 - 32

referral.referee.name

string

required

Retailer or Vendor (Brand) name

Required string length: 1 - 64

referral.referee.id

integer

Retailer or Vendor (Brand) ID

referral.referrer

object

Show child attributes

referral.referrer.code

string

required

Retailer or Vendor (Brand) code

Required string length: 1 - 32

referral.referrer.name

string

required

Retailer or Vendor (Brand) name

Required string length: 1 - 64

referral.referrer.id

integer

Retailer or Vendor (Brand) ID

retailer_identifier

string | null

Retailer identifier

Maximum length: 32

shipping_accounts

object[]

Show child attributes

shipping_accounts.nickname

string

required

Short name of shipping account, for easier identification

Required string length: 1 - 64

shipping_accounts.carrier

string

Shipping carrier

shipping_accounts.id

integer

Shippping account ID

shipping_accounts.owner

string

Owner of shipping account

shipping_accounts.shipping_methods

object

Show child attributes

shipping_accounts.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

shipping_accounts.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

shipping_accounts.shipping_methods.carrier

object

Show child attributes

shipping_accounts.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

shipping_accounts.shipping_methods.carrier.id

integer

Carrier ID

shipping_accounts.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

shipping_accounts.shipping_methods.generic_shipping_method

object

Show child attributes

shipping_accounts.shipping_methods.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

shipping_accounts.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

shipping_accounts.shipping_methods.generic_shipping_method.id

integer

ID of shipping method

shipping_accounts.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

shipping_accounts.shipping_methods.id

integer

ID of shipping method

shipping_accounts.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

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)

updated_at

string

Time of retailer connection update (UTC format)