Outfits and Similar Items

Overview

You can request outfits, partner outfits (also known as "model wears"; available only when enabled), and/or similar items in a single call via the browser JavaScript client library or by direct HTTP request.

Important:

• Follow the Interaction Tracking guide and do not change the order or grouping of items returned.

• Partner outfits are available only if Dressipi/Mapp Fashion has the necessary data.

Endpoint (HTTP)

GET https://api.dressipi.com/api/items/{item_id}/related

All properties on the request object are translated into query string parameters. Unrecognized keys are passed through (e.g., locale).

Dressipi("related", "items", {
  item_id: "YOUR_PRODUCT_CODE_OR_SKU",
  placement_id: "A_UUID_PROVIDED_BY_DRESSIPI",
  response_format: "detailed",
  methods: ["outfits", "partner_outfits", "similar_items"], // should be an array, amend as required
  try_all_methods: true, // if false (the default), the methods listed are attempted until one succeeds
  onSuccess: (data) => {},
  onFailure: (err) => {},
});

Common query params

• methods – comma-separated list of methods to request

• garment_format – maps from response_format (see below)

• try_all_methods – boolean

Request Parameters

Pass-through behavior:

Any additional keys you include (e.g., locale) will be forwarded as URL parameters.

IdentifierType

RequestedResponseFormat

Config Key - URL Parameter Mapping

Example Requests

HTTP

GET https://api.dressipi.com/api/items/123456/related?methods=outfits,similar_items&garment_format=detailed

JavaScript Client Library

Dressipi("related", "items", {
  item_id: "123456",
  response_format: "detailed",
  methods: ["outfits", "similar_items"],
  try_all_methods: false,
  onSuccess: (data) => console.log(data),
  onFailure: (err) => console.error(err),
});

Response

The top-level structure depends on which methods are requested. If multiple are requested, each appears by key. If a single method is requested (e.g., outfits), you may receive that section directly.

Combined methods

{
  response_id: string;
  outfits?: Outfit[];
  partner_outfits?: Outfit[];
  similar_items?: {
    content_id: string;
    items: Item[] | DetailedItem[];
  };
}

JSON Example:

{
  "response_id": "b3c1b6b0-9c2e-4a8b-9f1a-1234567890ab",
  "outfits": [
    {
      "content_id": "65dfa7",
      "items": [
        {
          "dressipi_item_id": 1322,
          "id": "REDDRESS01"
        }
      ],
      "occasion": "casual"
    }
  ],
  "partner_outfits": [
    {
      "content_id": "65dfa7",
      "items": [
        {
          "dressipi_item_id": 1322,
          "id": "REDDRESS01"
        }
      ],
      "occasion": null
    }
  ],
  "similar_items": {
    "content_id": "65dfa7",
    "items": [
      {
        "dressipi_item_id": 35122,
        "id": "602849501492"
      }
    ]
  }
}

Outfits-only

{
  response_id: string;
  outfits: Outfit[];
}

JSON Example:

{
  "response_id": "b3c1b6b0-9c2e-4a8b-9f1a-1234567890ab",
  "outfits": [
    {
      "content_id": "65dfa7",
      "occasion": "casual",
      "items": [
        { "dressipi_item_id": 1322, "id": "REDDRESS01" }
      ]
    }
  ]
}

Types

// Minimal item
interface Item {
  id: string;
  dressipi_item_id: number;
}
// Detailed item
interface DetailedItem extends Item {
  name: string;
  price?: string;
  old_price?: string;
  brand_name: string;
  url: string;
  category_name?: string;
  category_id?: number;
  images: string[];
  image_url: string;
  best_model_image?: string | null;
  best_product_image?: string | '' | null;
  thumbnail_image_url?: string;
  has_outfits: boolean;
  status: 'in stock' | 'out of stock';
  style_id?: string;
}
interface Outfit {
  content_id: string;
  occasion: string | null;
  items: DetailedItem[] | Item[];
}

Cookies

_pantheon2-dressipi_session – Rails session cookie on responses.

Implementation Notes & Best Practices

• Prefer response_format in JavaScript Client Library calls; it maps to garment_format in the URL.

• Preserve item order and grouping as returned.

• If try_all_methods is true, the JavaScript Client Library will attempt fallbacks across the methods list.

• When using identifier_type, ensure the provided item_id aligns (e.g., sku).

• You can pass through locale and other non-typed params as needed.