Get terms & conditions status

Retrieve whether T&Cs have been accepted for connections.

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

Response

200 - application/json

OK

count · integer · required

Total number of records

Example:

3

results · object[] · required

Show child attributes

results. brand · string · required

Brand associated with the connection invite

Example:

"TechCorp"

results. retailer · string · required

Retailer associated with the connection invite

Example:

"Retailer X"

results. level · enum<string> · required

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

Available options:

transactions_and_products,

products_only

Example:

"transactions_and_products"

results. status · enum<string> · required

Current status of the terms and conditions acceptance

Available options:

active,

suspended,

pending,

onboarding

Example:

"active"

results. id · integer

Unique identifier for the terms and conditions response

Example:

12345

results. suspended_at · string | null

Timestamp when the terms and conditions were suspended

Example:

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

results. created_at · string | null

Timestamp when the terms and conditions response was created

Example:

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

results. updated_at · string | null

Timestamp when the terms and conditions response was last updated

Example:

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

results. shipping_accounts · string

Shipping accounts associated with the connection invite

Example:

"FedEx, UPS"

results. options · string

Additional options related to the terms and conditions

Example:

"Gift Wrapping Available"

results. attachments · string

Attachments related to the terms and conditions response

Example:

"Attachment1.pdf"

results. approved_items_count · string

Count of approved items under the terms and conditions

Example:

"5"

results. orders_last_7_days_count · string

Count of orders received in the last 7 days under the terms and conditions

Example:

"10"

results. proposals_received_last_7_days_count · string

Count of proposals received in the last 7 days

Example:

"3"

results. contacts · string

Contacts associated with the connection invite

Example:

"[e-mail], [e-mail]"

results. memos · string

Memos associated with the connection invite

Example:

"Terms accepted on 2024-03-01."

results. referral · string

Referral details if applicable

Example:

"Referred by John Doe"

results. commission_profile · string

Commission profile associated with the connection invite

Example:

"Standard Commission"

results. integration_type · enum<string> | null

Type of integration associated with the connection invite

Available options:

console,

edi,

api,

storefront,

console-print-labels,

console-register-tracking-numbers,

shopify,

bigcommerce,

shipstation,

woocommerce

Example:

"api"

results. onboarding_status · enum<string> | null

Current onboarding status for the connection invite

Available options:

pending,

complete

Example:

"pending"

results. retailer_identifier · string | null

Identifier for the retailer

Maximum length: 32

Example:

"Retailer-01"

results. onboarding_target_date · string | null

Target date for onboarding the connection invite

Example:

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

results. intro_call_date · string | null

Date of the introductory call for onboarding

Example:

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

results. onboarded_at · string | null

Timestamp when the invitee was onboarded

Example:

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

results. onboarding_steps · string

Steps completed during the onboarding process

Example:

"Step 1: Account Setup, Step 2: Review Terms"

next · string | null

Next page (applicable in a paginated response)

Example:

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

previous · string | null

Previous page (applicable in a paginated response)

Example:

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