Get connection invite by ID

Retrieve a specific connection invite by ID.

Authorizations

Authorization · string · header · required

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

Path Parameters

retailer_id · integer · required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Example:

1001

id · integer · required

The connection invite ID used to retrieve a specific connection invite. This ID is generated when a connection invite is sent. Use the /v1/retailers/{retailer_id}/connections/ endpoint to retrieve a list of connection invites and their IDs.

Example:

2002

Response

200 - application/json

Connection invite details

company_name · string · required

Name of the company sending the invite

Required string length: 1 - 64

Example:

"TechCorp"

first_name · string · required

First name of the person associated with the connection invite

Required string length: 1 - 64

Example:

"John"

last_name · string · required

Last name of the person associated with the connection invite

Required string length: 1 - 64

Example:

"Doe"

email · string · required

Email address of the invite recipient

Required string length: 1 - 255

Example:

"[e-mail]"

id · integer

Unique identifier for the connection invite

Example:

12345

memos · string

Any additional notes or memos associated with the invite

Example:

"Please review the terms."

status · enum<string>

Current status of the invite

Available options:

pending,

approved,

rejected

Example:

"pending"

retailer · string

Retailer associated with the invite

Example:

"Retailer X"

connection · string

Connection associated with the invite

Example:

"TechCorp-Connection"

fees · string

Any fees associated with the invite

Example:

"15.00"

commission_profile · string

Commission profile associated with the invite

Example:

"Standard"

level · enum<string>

Level of the invite (e.g., product only or transactions + products)

Available options:

transactions_and_products,

products_only

Example:

"transactions_and_products"

adjustments · string

Adjustments made to the invite

Example:

"Discount applied"

slas · string

Service level agreements associated with the invite

Example:

"Next Day Delivery"

options · string

Additional options related to the connection invite

Example:

"Gift Wrapping available"

shipping_accounts · string

Shipping accounts associated with the invite

Example:

"FedEx, UPS"

onboarding_target_date · string | null

Target date for the onboarding of the invite recipient

Example:

"2024-04-30T00:00:00Z"

retailer_identifier · string | null

Identifier for the retailer

Maximum length: 32

Example:

"Retailer-01"

created_at · string

Timestamp when the connection invite was created

Example:

"2024-03-01T12:00:00Z"

invite_sent_at · string | null

Timestamp when the invite was sent

Example:

"2024-03-01T14:00:00Z"