Skip to main content
POST
/
v2
/
customers
/
{customer_id}
/
link
Link an Imprint customer and partner customer accounts
curl --request POST \
  --url https://dev.sbx.imprint.co/v2/customers/{customer_id}/link \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_customer_id": "PARTNER_USER_456",
  "metadata": {
    "store_id": "store_789",
    "platform_version": "2.1.0"
  }
}
'
{
  "customer_id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
  "partner_customer_id": "PARTNER_USER_456",
  "partner_identifier": "MCD",
  "status": "ACTIVE",
  "created_at": "2025-02-13T19:08:07.000Z",
  "updated_at": "2025-02-13T19:08:07.000Z",
  "metadata": {
    "store_id": "store_789",
    "platform_version": "2.1.0"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path Parameters

​
customer_id
string
required

The unique identifier for the Imprint customer

Example:

"BBB815E9-F654-438D-9AD3-3F7BB8136FC0"

Body

application/json
​
partner_customer_id
string
required

The unique identifier for the customer in the partner's system

Example:

"PARTNER_USER_456"

​
metadata
object

Additional linking metadata

Example:
{
  "store_id": "store_789",
  "platform_version": "2.1.0"
}

Response

Customer accounts linked successfully

​
customer_id
string
required

The ID of the Imprint customer

Example:

"9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4"

​
partner_customer_id
string
required

The unique identifier for the customer in the partner's system

Example:

"PARTNER_USER_456"

​
partner_identifier
string
required

The partner definition (string based, defined when creating a partner account).

Example:

"MCD"

​
status
enum<string>
required

Status of the linked relationship

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
created_at
string
required

the RFC-3339 timestamp when the link was created at.

Example:

"2025-02-13T19:08:07.000Z"

​
updated_at
string

the RFC-3339 timestamp when the link was last updated.

Example:

"2025-02-13T19:08:07.000Z"

​
metadata
object

Additional linking metadata

Example:
{
  "store_id": "store_789",
  "platform_version": "2.1.0"
}