affiliate
/
Retrieve affiliate information

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description
public.json
public.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://fluid-commerce.redocly.app/_mock/docs/apis/public/
Production API server
https://api.fluid.app/
Local development server
https://api.fluid.test/

Orders

Operations

affiliate

Operations

Retrieve affiliate information

Request

Bodyapplication/json
metadataobjectrequired
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​fluid_localestring(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​fluid_journeystring
metadata.​attributionAttributionEmail (object) or AttributionUsername (object) or AttributionSharedGuid (object) or AttributionFluidRepId (object) or AttributionExternalId (object)(Attribution)required
Any of:
metadata.​attribution.​emailstring(email)required
Example: "salesrep@example.com"
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/public/api/public/v2025-06/affiliates/lookup \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

affiliate found

Bodyapplication/json
statusnumberrequired
Example: 201
affiliateobject(Affiliate)required
affiliate.​namestring or null
Example: "Sales Rep"
affiliate.​emailstring or null(email)
Example: "salesrep@example.com"
affiliate.​image_urlstring or null(uri)
Example: "https://example.com/salesrep.jpg"
affiliate.​usernamestring or null
Example: "salesrep"
affiliate.​share_guidstring or null
Example: "abc123"
affiliate.​external_idstring or null
Example: "U-1234567890"
affiliate.​fluid_rep_idnumber or null
Example: 123456
metadataobject(ResponseMetadata)required
metadata.​fluid_shopstringrequired
metadata.​fluid_sessionstringrequired
metadata.​fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​request_uuidstring(uuid)required
metadata.​timestampstringrequired
Response
application/json
{
  "status": 201,
  "affiliate": {
    "name": "Sales Rep",
    "email": "salesrep@example.com",
    "image_url": "https://example.com/salesrep.jpg",
    "username": "salesrep",
    "share_guid": "abc123",
    "external_id": "U-1234567890",
    "fluid_rep_id": 123456
  },
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "fluid_locale": "en_US",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

carts

Operations

checkout

Operations

events

Operations

lead

Operations

page

Operations

fingerprint

Operations

session

Operations

settings

Operations