Get connection invite by ID

Retrieve a specific connection invite by ID.

GET /v1/retailers/{retailer_id}/connection-invites/{id}

Get connection invite by ID

cURL

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

200

{
  "company_name": "TechCorp",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[e-mail]",
  "id": 12345,
  "memos": "Please review the terms.",
  "status": "pending",
  "retailer": "Retailer X",
  "connection": "TechCorp-Connection",
  "fees": "15.00",
  "commission_profile": "Standard",
  "level": "transactions_and_products",
  "adjustments": "Discount applied",
  "slas": "Next Day Delivery",
  "options": "Gift Wrapping available",
  "shipping_accounts": "FedEx, UPS",
  "onboarding_target_date": "2024-04-30T00:00:00Z",
  "retailer_identifier": "Retailer-01",
  "created_at": "2024-03-01T12:00:00Z",
  "invite_sent_at": "2024-03-01T14:00:00Z"
}

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<email> · required

Email address of the invite recipient

Required string length: 1 - 255

Example:

"[e-mail]"

id · integer · read-only

Unique identifier for the connection invite

Example:

12345

memos · string · read-only

Any additional notes or memos associated with the invite

Example:

"Please review the terms."

status · enum<string> · read-only

Current status of the invite

Available options: pending, approved, rejected

Example:

"pending"

retailer · string · read-only

Retailer associated with the invite

Example:

"Retailer X"

connection · string · read-only

Connection associated with the invite

Example:

"TechCorp-Connection"

fees · string · read-only

Any fees associated with the invite

Example:

"15.00"

commission_profile · string · read-only

Commission profile associated with the invite

Example:

"Standard"

level · enum<string> · read-only

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

Available options: transactions_and_products, products_only

Example:

"transactions_and_products"

adjustments · string · read-only

Adjustments made to the invite

Example:

"Discount applied"

slas · string · read-only

Service level agreements associated with the invite

Example:

"Next Day Delivery"

options · string · read-only

Additional options related to the connection invite

Example:

"Gift Wrapping available"

shipping_accounts · string · read-only

Shipping accounts associated with the invite

Example:

"FedEx, UPS"

onboarding_target_date · string<date-time> | 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 string length: 32

Example:

"Retailer-01"

created_at · string<date-time> · read-only

Timestamp when the connection invite was created

Example:

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

invite_sent_at · string<date-time> | null · read-only

Timestamp when the invite was sent

Example:

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