Get vendor connections

curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/connections/ \
  --header 'Authorization: Bearer <token>'

{
  "count": 1023,
  "results": [
    {
      "id": 1000,
      "brand": {
        "code": "demo-brand",
        "id": 500,
        "name": "Marla Cielo",
        "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": {
        "name": "Demo Retailer",
        "code": "demo-retailer",
        "id": 500,
        "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"
      },
      "level": "full",
      "status": "active",
      "suspended_at": null,
      "created_at": "2022-06-22T06:56:16Z",
      "updated_at": "2022-08-08T15:48:05Z",
      "shipping_accounts": [
        {
          "nickname": "Sample13",
          "id": 1,
          "owner": "DemoABC",
          "carrier": "ALP Brand",
          "shipping_methods": {
            "name": "White Glove Bronze",
            "code": "cory_white_glove",
            "id": 5,
            "type": "ltl (less than truck load)",
            "carrier": {
              "id": 229,
              "name": "Cory Companies",
              "code": "CJCD"
            },
            "generic_shipping_method": {
              "name": "LTL",
              "description": "Less than truckload (LTL)",
              "id": 5,
              "type": "ltl"
            }
          }
        }
      ],
      "options": {
        "name": "Sample Option",
        "code": "Sample_Option",
        "id": 8753,
        "description": "Sample description for connection",
        "viewable_by": "All",
        "editable_by": "Staff"
      },
      "attachments": [
        {
          "id": 268,
          "content_type": 1,
          "object_id": 666,
          "file": "Sample file",
          "uploaded_by": 646,
          "visible_by": "connections",
          "original_filename": "Sample1",
          "filename": "Sample1",
          "tags": [
            {
              "tag": "demotag",
              "id": 432
            }
          ],
          "url": "https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"
        }
      ],
      "approved_items_count": 1,
      "orders_last_7_days_count": 0,
      "proposals_received_last_7_days_count": 4,
      "contacts": [
        {
          "name": "sample contact",
          "email": "[email protected]",
          "id": 1010,
          "phone": "9765314368",
          "description": "Call",
          "created_at": "2021-09-10T15:24:56Z"
        }
      ],
      "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": {
          "code": "retailer_abc",
          "name": "Retailer ABC",
          "id": 675
        },
        "referee": {
          "code": "retailer_abc",
          "name": "Retailer ABC",
          "id": 675
        },
        "is_brand_first_connection": "false\"",
        "is_retailer_first_connection": true
      },
      "integration_type": "console",
      "onboarding_status": "pending",
      "retailer_identifier": null,
      "onboarding_target_date": null,
      "onboarded_at": "2021-09-10T15:24:56Z"
    }
  ],
  "next": "https://api.example.org/demo/accounts/?page=5",
  "previous": "https://api.example.org/demo/accounts/?page=3"
}

GET

retailers

{retailer_pk}

connections

Get vendor connections

curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_pk}/connections/ \
  --header 'Authorization: Bearer <token>'

{
  "count": 1023,
  "results": [
    {
      "id": 1000,
      "brand": {
        "code": "demo-brand",
        "id": 500,
        "name": "Marla Cielo",
        "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": {
        "name": "Demo Retailer",
        "code": "demo-retailer",
        "id": 500,
        "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"
      },
      "level": "full",
      "status": "active",
      "suspended_at": null,
      "created_at": "2022-06-22T06:56:16Z",
      "updated_at": "2022-08-08T15:48:05Z",
      "shipping_accounts": [
        {
          "nickname": "Sample13",
          "id": 1,
          "owner": "DemoABC",
          "carrier": "ALP Brand",
          "shipping_methods": {
            "name": "White Glove Bronze",
            "code": "cory_white_glove",
            "id": 5,
            "type": "ltl (less than truck load)",
            "carrier": {
              "id": 229,
              "name": "Cory Companies",
              "code": "CJCD"
            },
            "generic_shipping_method": {
              "name": "LTL",
              "description": "Less than truckload (LTL)",
              "id": 5,
              "type": "ltl"
            }
          }
        }
      ],
      "options": {
        "name": "Sample Option",
        "code": "Sample_Option",
        "id": 8753,
        "description": "Sample description for connection",
        "viewable_by": "All",
        "editable_by": "Staff"
      },
      "attachments": [
        {
          "id": 268,
          "content_type": 1,
          "object_id": 666,
          "file": "Sample file",
          "uploaded_by": 646,
          "visible_by": "connections",
          "original_filename": "Sample1",
          "filename": "Sample1",
          "tags": [
            {
              "tag": "demotag",
              "id": 432
            }
          ],
          "url": "https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"
        }
      ],
      "approved_items_count": 1,
      "orders_last_7_days_count": 0,
      "proposals_received_last_7_days_count": 4,
      "contacts": [
        {
          "name": "sample contact",
          "email": "[email protected]",
          "id": 1010,
          "phone": "9765314368",
          "description": "Call",
          "created_at": "2021-09-10T15:24:56Z"
        }
      ],
      "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": {
          "code": "retailer_abc",
          "name": "Retailer ABC",
          "id": 675
        },
        "referee": {
          "code": "retailer_abc",
          "name": "Retailer ABC",
          "id": 675
        },
        "is_brand_first_connection": "false\"",
        "is_retailer_first_connection": true
      },
      "integration_type": "console",
      "onboarding_status": "pending",
      "retailer_identifier": null,
      "onboarding_target_date": null,
      "onboarded_at": "2021-09-10T15:24:56Z"
    }
  ],
  "next": "https://api.example.org/demo/accounts/?page=5",
  "previous": "https://api.example.org/demo/accounts/?page=3"
}

Authorizations

Authorization

string

header

required

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

brand_has_allowances

number

1: brand has allowances such as discounts
0: brand does not have allowances

brand_has_charges

number

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

Example:

1023

results

object[]

required

Show child attributes

results.id

integer

Connection ID

Example:

1000

results.brand

object

Show child attributes

results.brand.code

string<slug>

required

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

Required string length: 1 - 64

Example:

"demo-brand"

results.brand.id

integer

Vendor (brand) ID

Example:

500

results.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

results.brand.joined_at

string<date-time>

Time when vendor joined Dropship (UTC format)

Example:

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

results.brand.logo_url

string<uri>

URL of the brand logo

Minimum string length: 1

Example:

"https://images.revcascade.com/retailers/defaults/logo-lg.png"

results.brand.cover_url

string<uri>

URL of the cover image

Minimum string length: 1

Example:

"https://images.revcascade.com/retailers/defaults/cover.png"

results.brand.profile_tile_url

string<uri>

URL of the profile image

Minimum string length: 1

Example:

"https://images.revcascade.com/retailers/defaults/profile-tile.png"

results.brand.website

string<uri> | null

URL of brand website

Maximum string length: 100

Example:

null

results.brand.is_onboarded

boolean

true: Vendor is onboarded
false: Vendor is not onboarded

Example:

false

results.brand.is_on_rcn

boolean

true: is on Dropship network
false: not on Dropship network

Example:

false

results.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

results.brand.subscription_expires_at

string<date-time> | null

Subscription expiry Time (UTC format)

Example:

"2024-09-19T13:32:10Z"

results.brand.grace_period_ends_at

string<date-time> | null

Time of grace period expiration (UTC format)

Example:

"2024-10-26T13:32:10Z"

results.brand.subscription_is_expired

boolean

true: subscription is expired
false: subscription is active

Example:

false

results.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period
false: subscription is not on grace period

Example:

false

results.brand.subscription_is_delinquent

boolean

true: subscription is overdue
false: subscription is paid

Example:

false

results.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

results.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

results.retailer

object

Show child attributes

results.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

results.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

results.retailer.id

integer

Retailer ID

Example:

500

results.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

results.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

results.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

results.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

results.retailer.is_rcn_retailer

boolean

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

Example:

false

results.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

results.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

results.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

results.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit
false: Platform doesn't require creation of brand permit

Example:

false

results.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

results.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

results.level

enum<string>

Connection level

Available options:

basic,

full

Example:

"full"

results.status

enum<string>

Connection status

Available options:

active,

suspended,

pending,

onboarding

Example:

"active"

results.suspended_at

string<date-time> | null

Time of when connection got suspended (UTC format)

Example:

null

results.created_at

string<date-time>

Time of connection creation (UTC format)

Example:

"2022-06-22T06:56:16Z"

results.updated_at

string<date-time>

Time of connection update (UTC format)

Example:

"2022-08-08T15:48:05Z"

results.shipping_accounts

object[]

Show child attributes

results.shipping_accounts.nickname

string

required

Short name of shipping account, for easier identification

Required string length: 1 - 64

Example:

"Sample13"

results.shipping_accounts.id

integer

Shippping account ID

Example:

1

results.shipping_accounts.owner

string

Owner of shipping account

Example:

"DemoABC"

results.shipping_accounts.carrier

string

Shipping carrier

Example:

"ALP Brand"

results.shipping_accounts.shipping_methods

object

Show child attributes

results.shipping_accounts.shipping_methods.name

string

required

Name of shipping method

Required string length: 1 - 64

Example:

"White Glove Bronze"

results.shipping_accounts.shipping_methods.code

string

required

Code of shipping method

Required string length: 1 - 64

Example:

"cory_white_glove"

results.shipping_accounts.shipping_methods.id

integer

ID of shipping method

Example:

5

results.shipping_accounts.shipping_methods.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl (less than truck load)"

results.shipping_accounts.shipping_methods.carrier

object

Show child attributes

results.shipping_accounts.shipping_methods.carrier.id

integer

Carrier ID

Example:

229

results.shipping_accounts.shipping_methods.carrier.name

string

Carrier name

Required string length: 1 - 64

Example:

"Cory Companies"

results.shipping_accounts.shipping_methods.carrier.code

string

Carrier code

Required string length: 1 - 64

Example:

"CJCD"

results.shipping_accounts.shipping_methods.generic_shipping_method

object

Show child attributes

results.shipping_accounts.shipping_methods.generic_shipping_method.name

string

required

Name of shipping method

Required string length: 1 - 32

Example:

"LTL"

results.shipping_accounts.shipping_methods.generic_shipping_method.description

string

required

Description of shipping method

Required string length: 1 - 128

Example:

"Less than truckload (LTL)"

results.shipping_accounts.shipping_methods.generic_shipping_method.id

integer

ID of shipping method

Example:

5

results.shipping_accounts.shipping_methods.generic_shipping_method.type

enum<string>

Type of shipping method

Available options:

small_parcel,

ltl

Example:

"ltl"

results.options

object

Show child attributes

results.options.name

string

required

Option name

Required string length: 1 - 64

Example:

"Sample Option"

results.options.code

string

required

Option code

Required string length: 1 - 64

Example:

"Sample_Option"

results.options.id

integer

Option ID

Example:

8753

results.options.description

string | null

Connection description

Example:

"Sample description for connection"

results.options.viewable_by

enum<string> | null

User who can view the connection details

Available options:

retailer,

brand,

all,

none

Example:

"All"

results.options.editable_by

enum<string> | null

User who can edit connection

Available options:

retailer,

brand,

staff

Example:

"Staff"

results.attachments

object[]

Show child attributes

results.attachments.id

integer

Attachment or document ID

Example:

268

results.attachments.content_type

integer

Content type

Example:

1

results.attachments.object_id

integer

Attachement object ID

Example:

666

results.attachments.file

string<uri> | null

File name

Example:

"Sample file"

results.attachments.uploaded_by

integer | null

User ID that uploaded the attachment

Example:

646

results.attachments.visible_by

enum<string>

User permission who can view the attachment

Available options:

me,

connections,

everyone

Example:

"connections"

results.attachments.original_filename

string | null

Original file name

Maximum string length: 255

Example:

"Sample1"

results.attachments.filename

string | null

File name used for sharing

Maximum string length: 255

Example:

"Sample1"

results.attachments.tags

object[]

Show child attributes

results.attachments.tags.tag

string

required

attachment tag

Required string length: 1 - 128

Example:

"demotag"

results.attachments.tags.id

integer

Attachment tag ID

Example:

432

results.attachments.url

string<uri>

URL of attachment

Minimum string length: 1

Example:

"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"

results.approved_items_count

integer

Count of approved items

Example:

1

results.orders_last_7_days_count

integer

Count of orders in the last 7 days

Example:

0

results.proposals_received_last_7_days_count

integer

Count of proposals received in the last 7 days

Example:

4

results.contacts

object[]

Show child attributes

results.contacts.name

string

required

Contact name

Required string length: 1 - 128

Example:

"sample contact"

results.contacts.email

string<email>

required

Contact email

Required string length: 1 - 128

Example:

"[email protected]"

results.contacts.id

integer

Contact ID

Example:

1010

results.contacts.phone

string | null

Contact number

Maximum string length: 16

Example:

"9765314368"

results.contacts.description

string | null

A note related to the contact

Maximum string length: 128

Example:

"Call"

results.contacts.created_at

string<date-time>

Time of contact creation (UTC format)

Example:

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

results.memos

object[]

Show child attributes

results.memos.id

integer

Memo ID

Example:

1234

results.memos.text

string

Memo text

Example:

"Immediate requirement"

results.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

results.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

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

results.memos.notify_people

boolean

true: notify stakeholders
false: do not notify

Example:

true

results.memos.created_by

object

Show child attributes

results.memos.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

results.memos.created_by.first_name

string | null

First name of user

Maximum string length: 64

Example:

"Sample"

results.memos.created_by.last_name

string | null

Last name of user

Maximum string length: 64

Example:

"Demo"

results.memos.created_by.title

string | null

User title

Maximum string length: 64

Example:

"Demo"

results.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

results.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

results.memos.created_by.photo_url

string<uri>

URL of the user photo

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

results.memos.created_by.profile_photo

string<uri>

URL of the user's profile photo

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

results.memos.created_by.is_me

boolean

true: user is me:
false: user is not me

Example:

true

results.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

results.memos.created_at

string<date-time>

Time of memo creation (UTC format)

Example:

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

results.memos.updated_at

string<date-time>

Time of memo update (UTC format)

Example:

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

results.referral

object

Show child attributes

results.referral.id

integer

ID of connection referral

Example:

125

results.referral.referrer

object

Show child attributes

results.referral.referrer.code

string<slug>

required

Retailer or Vendor (Brand) code

Required string length: 1 - 32

Example:

"retailer_abc"

results.referral.referrer.name

string

required

Retailer or Vendor (Brand) name

Required string length: 1 - 64

Example:

"Retailer ABC"

results.referral.referrer.id

integer

Retailer or Vendor (Brand) ID

Example:

675

results.referral.referee

object

Show child attributes

results.referral.referee.code

string<slug>

required

Retailer or Vendor (Brand) code

Required string length: 1 - 32

Example:

"retailer_abc"

results.referral.referee.name

string

required

Retailer or Vendor (Brand) name

Required string length: 1 - 64

Example:

"Retailer ABC"

results.referral.referee.id

integer

Retailer or Vendor (Brand) ID

Example:

675

results.referral.is_brand_first_connection

boolean

true: brand is first connection
false: brand is not the first connection

Example:

"false\""

results.referral.is_retailer_first_connection

boolean

true: retailer is first connection
false: brand is not the first connection

Example:

true

results.integration_type

enum<string> | null

Integration type

Available options:

console,

edi,

api,

storefront,

console-print-labels,

console-register-tracking-numbers,

shopify,

bigcommerce,

shipstation

Example:

"console"

results.onboarding_status

enum<string> | null

Status of onboarding

Available options:

pending,

complete

Example:

"pending"

results.retailer_identifier

string | null

Retailer ID

Maximum string length: 32

Example:

null

results.onboarding_target_date

string<date-time> | null

Target date of retailer onboarding (UTC format)

Example:

null

results.onboarded_at

string | null

Time of retailer onboarding (UTC format)

Example:

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

string<uri> | null

Next page (applicable in a paginated response)

Example:

"https://api.example.org/demo/accounts/?page=5"

string<uri> | null

Previous page (applicable in a paginated response)

Example:

"https://api.example.org/demo/accounts/?page=3"

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

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get vendor connections

Authorizations

Path Parameters

Query Parameters

Response