Outfit Styling Endpoints¶
Outfit Styling API endpoints.
Overview¶
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/production-requests/{production_request_id}/styling/complete-look-runs |
Create Styling Complete Look Run |
| POST | /api/v1/production-requests/{production_request_id}/styling/outfit-option-runs |
Create Styling Outfit Option Run |
| GET | /api/v1/production-requests/{production_request_id}/styling/outfit-option-runs/latest |
Get Latest Styling Outfit Option Run |
| GET | /api/v1/production-requests/{production_request_id}/styling/outfit-option-runs/{run_id} |
Get Styling Outfit Option Run |
| POST | /api/v1/production-requests/{production_request_id}/styling/product-search |
Search Styling Products |
| GET | /api/v1/production-requests/{production_request_id}/styling/scope |
Get Styling Candidate Scope |
| POST | /api/v1/production-requests/{production_request_id}/styling/slot-options |
Create Styling Slot Options |
| GET | /api/v1/styling/capabilities |
Get Styling Capabilities |
API Reference¶
Sartiq Backend Server - Outfit Styling 0.1.0¶
outfit-styling¶
GET /api/v1/styling/capabilities¶
Get Styling Capabilities
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"slot_options_enabled": {
"type": "boolean",
"title": "Slot Options Enabled"
},
"outfit_options_enabled": {
"type": "boolean",
"title": "Outfit Options Enabled"
},
"product_search_enabled": {
"type": "boolean",
"title": "Product Search Enabled"
}
},
"type": "object",
"required": [
"slot_options_enabled",
"outfit_options_enabled",
"product_search_enabled"
],
"title": "StylingCapabilitiesPublic"
}
GET /api/v1/production-requests/{production_request_id}/styling/scope¶
Get Styling Candidate Scope
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"rules": {
"items": {
"$ref": "#/components/schemas/StylistScopeRule"
},
"type": "array",
"title": "Rules"
},
"inert_rules": {
"items": {
"$ref": "#/components/schemas/StylistScopeRule"
},
"type": "array",
"title": "Inert Rules"
}
},
"type": "object",
"required": [
"rules",
"inert_rules"
],
"title": "StylingCandidateScopePublic",
"description": "The scope rules the next search on this look will apply.\n\nRead from the production snapshot rather than the shooting's guidelines, so\nthe control always reflects the stylist the engine will actually use."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
POST /api/v1/production-requests/{production_request_id}/styling/product-search¶
Search Styling Products
Description
Hybrid rack search: identifier short-circuit, else one semantic pass.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Request body
{
"query": "string",
"catalog_scope": "shooting",
"context_product_ids": [
"6d2f5cd8-82ea-465b-a2f2-d0f0f2f216b9"
],
"slot": null,
"filters": null,
"exclude_product_ids": [
"1bcd717b-68d1-45fb-b5a4-777f8ed1a5f7"
],
"limit": 0
}
Schema of the request body
{
"properties": {
"query": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"title": "Query"
},
"catalog_scope": {
"type": "string",
"enum": [
"shooting",
"filler",
"all"
],
"title": "Catalog Scope",
"description": "Visible Product Rack catalog scope.",
"default": "shooting"
},
"context_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 100,
"title": "Context Product Ids",
"description": "Non-hero products on the active outfit card. Semantic results use them only as soft compatibility context. They remain eligible unless also supplied in exclude_product_ids."
},
"slot": {
"anyOf": [
{
"$ref": "#/components/schemas/StylingEditableSlot"
},
{
"type": "null"
}
],
"description": "Optional slot chip narrowing both identifier and semantic results to one outfit role; omitted searches every product type."
},
"filters": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductSearchFilters"
},
{
"type": "null"
}
]
},
"exclude_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 100,
"title": "Exclude Product Ids",
"description": "Products already shown for this search, to skip. A guarantee: results only ever contain other products, and an exhausted pool returns an empty page rather than repeating one of these."
},
"limit": {
"type": "integer",
"maximum": 48.0,
"minimum": 1.0,
"title": "Limit",
"default": 24
}
},
"additionalProperties": false,
"type": "object",
"required": [
"query"
],
"title": "StylingProductSearchCreate"
}
Responses
{
"mode": "identifier",
"results": [
{
"rank": 0,
"product": {
"id": "061179f8-4093-4d85-acc8-3aca0ba3d9d5",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"barcode": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"product_wear": null,
"product_wear_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"styling_slot": "top",
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"ingest_job_id": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "f5dbc14f-233a-445d-9810-74adbcf2a0e3",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
}
],
"has_more": true
}
Schema of the response body
{
"properties": {
"mode": {
"type": "string",
"enum": [
"identifier",
"semantic"
],
"title": "Mode"
},
"results": {
"items": {
"$ref": "#/components/schemas/StylingSlotOptionPublic"
},
"type": "array",
"title": "Results"
},
"has_more": {
"type": "boolean",
"title": "Has More"
}
},
"type": "object",
"required": [
"mode",
"results",
"has_more"
],
"title": "ProductSearchResultPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
POST /api/v1/production-requests/{production_request_id}/styling/slot-options¶
Create Styling Slot Options
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Request body
{
"context_product_ids": [
"1c2599e0-e530-4501-b074-a1ae2a0093cc"
],
"target": {
"kind": "string",
"product_id": "4acc1a84-e701-42e8-9513-df2b8f8c02b0"
},
"direction": null,
"exclude_product_ids": [
"80b2a047-de4f-4f2b-b205-3844f5472567"
],
"scope_rules": null
}
Schema of the request body
{
"properties": {
"context_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 100,
"title": "Context Product Ids"
},
"target": {
"$ref": "#/components/schemas/StylingSlotReplaceTarget"
},
"direction": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
],
"title": "Direction"
},
"exclude_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 100,
"title": "Exclude Product Ids",
"description": "Products already shown for this target, to skip. A guarantee: results only ever contain other products, and an exhausted pool returns an empty page rather than repeating one of these."
},
"scope_rules": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StylistScopeRule"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Scope Rules",
"description": "Per-request candidate scope override. Omitted/null inherits the stylist's candidate_scope_rules; an empty list searches unscoped."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"context_product_ids",
"target"
],
"title": "StylingSlotOptionsCreate"
}
Responses
{
"request_id": "97ecf667-e232-4943-a6b5-dd1b1dfd1fe5",
"target_slot": "top",
"target_product_id": "790d3824-2156-4f4e-b9c5-178287779e44",
"options": [
{
"rank": 0,
"product": {
"id": "cd93647a-5b13-4fa3-a9c1-b12b5bce29e9",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"barcode": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"product_wear": null,
"product_wear_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"styling_slot": "top",
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"ingest_job_id": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "2a4f0df5-9d59-430c-b62d-df67d1da9ea8",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
}
],
"has_more": true
}
Schema of the response body
{
"properties": {
"request_id": {
"type": "string",
"format": "uuid",
"title": "Request Id"
},
"target_slot": {
"$ref": "#/components/schemas/StylingEditableSlot"
},
"target_product_id": {
"type": "string",
"format": "uuid",
"title": "Target Product Id"
},
"options": {
"items": {
"$ref": "#/components/schemas/StylingSlotOptionPublic"
},
"type": "array",
"title": "Options"
},
"has_more": {
"type": "boolean",
"title": "Has More"
}
},
"type": "object",
"required": [
"request_id",
"target_slot",
"target_product_id",
"options",
"has_more"
],
"title": "StylingSlotOptionsPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
POST /api/v1/production-requests/{production_request_id}/styling/outfit-option-runs¶
Create Styling Outfit Option Run
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Request body
{
"client_request_id": "35a89694-e4ce-475e-9af5-017663439c38",
"direction": null,
"source_canvas": {
"proposal_id": "82e01d9d-f59d-412f-8d31-a52034593ebf",
"product_ids": [
"b85449a8-de5f-4053-8240-c808925c8837"
]
},
"avoid_outfits": [
[
"20494b0f-8b5e-46dd-953e-75d07af6f66c"
]
],
"filler_mode": null,
"scope_rules": null
}
Schema of the request body
{
"properties": {
"client_request_id": {
"type": "string",
"format": "uuid",
"title": "Client Request Id"
},
"direction": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
],
"title": "Direction"
},
"source_canvas": {
"$ref": "#/components/schemas/OutfitOptionSourceCanvas"
},
"avoid_outfits": {
"items": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
"type": "array",
"maxItems": 20,
"title": "Avoid Outfits"
},
"filler_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"auto",
"off"
]
},
{
"type": "null"
}
],
"title": "Filler Mode",
"description": "Per-run filler override: 'off' plans without the generic-filler rescue, 'auto' forces it on. Omitted/null inherits the brief's stylist_fillers_mode."
},
"scope_rules": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StylistScopeRule"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Scope Rules",
"description": "Per-request candidate scope override. Omitted/null inherits the stylist's candidate_scope_rules; an empty list searches unscoped."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"client_request_id",
"source_canvas"
],
"title": "OutfitOptionRunCreate"
}
Responses
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/OutfitOptionRunQueuedPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunRunningPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunSucceededPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunFailedPublic"
}
],
"discriminator": {
"propertyName": "status",
"mapping": {
"queued": "#/components/schemas/OutfitOptionRunQueuedPublic",
"running": "#/components/schemas/OutfitOptionRunRunningPublic",
"succeeded": "#/components/schemas/OutfitOptionRunSucceededPublic",
"failed": "#/components/schemas/OutfitOptionRunFailedPublic"
}
},
"title": "Response Create Styling Outfit Option Run"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/OutfitOptionRunQueuedPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunRunningPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunSucceededPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunFailedPublic"
}
],
"discriminator": {
"propertyName": "status",
"mapping": {
"queued": "#/components/schemas/OutfitOptionRunQueuedPublic",
"running": "#/components/schemas/OutfitOptionRunRunningPublic",
"succeeded": "#/components/schemas/OutfitOptionRunSucceededPublic",
"failed": "#/components/schemas/OutfitOptionRunFailedPublic"
}
},
"title": "Response 200 Create Styling Outfit Option Run"
}
POST /api/v1/production-requests/{production_request_id}/styling/complete-look-runs¶
Create Styling Complete Look Run
Description
Manually start the initial 2-outfit batch for a virgin canvas.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Request body
Responses
{
"run_id": "f48d6552-64fe-4883-986e-fb8171b0fa11",
"status": "string",
"outfit_ids": [
"7af09d68-7208-401b-a505-da424fd00722"
]
}
Schema of the response body
{
"properties": {
"run_id": {
"type": "string",
"format": "uuid",
"title": "Run Id"
},
"status": {
"type": "string",
"const": "queued",
"title": "Status"
},
"outfit_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"maxItems": 2,
"minItems": 2,
"title": "Outfit Ids"
}
},
"type": "object",
"required": [
"run_id",
"status",
"outfit_ids"
],
"title": "CompleteLookRunQueuedPublic",
"description": "Receipt for a manually triggered initial complete-look batch run.\n\nThe delivery pair is created as PENDING proposal rows in the same\ntransaction, so clients poll the production request detail for progress."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
GET /api/v1/production-requests/{production_request_id}/styling/outfit-option-runs/latest¶
Get Latest Styling Outfit Option Run
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Responses
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/OutfitOptionRunQueuedPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunRunningPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunSucceededPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunFailedPublic"
}
],
"discriminator": {
"propertyName": "status",
"mapping": {
"queued": "#/components/schemas/OutfitOptionRunQueuedPublic",
"running": "#/components/schemas/OutfitOptionRunRunningPublic",
"succeeded": "#/components/schemas/OutfitOptionRunSucceededPublic",
"failed": "#/components/schemas/OutfitOptionRunFailedPublic"
}
},
"title": "Response Get Latest Styling Outfit Option Run"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
GET /api/v1/production-requests/{production_request_id}/styling/outfit-option-runs/{run_id}¶
Get Styling Outfit Option Run
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No | ||
run_id |
path | string | No |
Responses
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/OutfitOptionRunQueuedPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunRunningPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunSucceededPublic"
},
{
"$ref": "#/components/schemas/OutfitOptionRunFailedPublic"
}
],
"discriminator": {
"propertyName": "status",
"mapping": {
"queued": "#/components/schemas/OutfitOptionRunQueuedPublic",
"running": "#/components/schemas/OutfitOptionRunRunningPublic",
"succeeded": "#/components/schemas/OutfitOptionRunSucceededPublic",
"failed": "#/components/schemas/OutfitOptionRunFailedPublic"
}
},
"title": "Response Get Styling Outfit Option Run"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"code": {
"$ref": "#/components/schemas/StylingProblemCode"
},
"message": {
"type": "string",
"title": "Message"
},
"retryable": {
"type": "boolean",
"title": "Retryable"
},
"active_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Active Run Id"
}
},
"type": "object",
"required": [
"code",
"message",
"retryable"
],
"title": "StylingProblemPublic"
}
Schemas¶
AgeClass¶
Type: string
CompleteLookRunCreate¶
| Name | Type | Description |
|---|---|---|
scope_rules |
Per-request candidate scope override. Omitted/null inherits the stylist's candidate_scope_rules; an empty list searches unscoped. |
CompleteLookRunQueuedPublic¶
| Name | Type | Description |
|---|---|---|
outfit_ids |
Array<string(uuid)> | |
run_id |
string(uuid) | |
status |
string |
HTTPValidationError¶
| Name | Type | Description |
|---|---|---|
detail |
Array<ValidationError> |
MediaResourcePublic¶
| Name | Type | Description |
|---|---|---|
alt_text |
||
aspect_ratio |
||
caption |
||
color_profile |
||
content_hash |
string | |
created_at |
string(date-time) | |
dominant_color |
||
duration |
||
extension |
string | |
file_size |
integer | |
height |
||
id |
string(uuid) | |
orientation |
||
protected |
boolean | |
resource_type |
MediaResourceType | |
url |
string | |
width |
MediaResourceType¶
Type: string
OutfitOptionItemPublic¶
| Name | Type | Description |
|---|---|---|
product |
ProductPublic | |
slot |
StylingEditableSlot |
OutfitOptionPublic¶
| Name | Type | Description |
|---|---|---|
items |
Array<OutfitOptionItemPublic> | |
rank |
integer | |
rationale |
OutfitOptionRunCreate¶
| Name | Type | Description |
|---|---|---|
avoid_outfits |
Array<Array<string(uuid)>> | |
client_request_id |
string(uuid) | |
direction |
||
filler_mode |
Per-run filler override: 'off' plans without the generic-filler rescue, 'auto' forces it on. Omitted/null inherits the brief's stylist_fillers_mode. | |
scope_rules |
Per-request candidate scope override. Omitted/null inherits the stylist's candidate_scope_rules; an empty list searches unscoped. | |
source_canvas |
OutfitOptionSourceCanvas |
OutfitOptionRunFailedPublic¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
options |
null | |
problem |
StylingProblemPublic | |
source_signature |
OutfitOptionSourceSignaturePublic | |
status |
string |
OutfitOptionRunQueuedPublic¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
options |
null | |
problem |
null | |
source_signature |
OutfitOptionSourceSignaturePublic | |
status |
string |
OutfitOptionRunRunningPublic¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
options |
null | |
problem |
null | |
source_signature |
OutfitOptionSourceSignaturePublic | |
status |
string |
OutfitOptionRunSucceededPublic¶
| Name | Type | Description |
|---|---|---|
delivered_proposal_id |
||
delivery_skipped_reason |
||
id |
string(uuid) | |
options |
Array<OutfitOptionPublic> | |
problem |
null | |
source_signature |
OutfitOptionSourceSignaturePublic | |
status |
string |
OutfitOptionSourceCanvas¶
| Name | Type | Description |
|---|---|---|
product_ids |
Array<string(uuid)> | |
proposal_id |
string(uuid) |
OutfitOptionSourceSignaturePublic¶
| Name | Type | Description |
|---|---|---|
hero_product_id |
string(uuid) | |
product_set_sha256 |
string | |
proposal_id |
string(uuid) |
ProductGender¶
Type: string
ProductPlacement¶
Type: string
ProductPublic¶
| Name | Type | Description |
|---|---|---|
age_class |
||
archived |
boolean | |
back_description |
||
back_image_media |
||
back_image_url |
||
barcode |
||
brand |
||
brand_collection |
||
brand_metadata |
||
category |
||
closure_type |
||
color_code |
||
color_name |
||
color_swatch_media |
||
colour |
||
cover_image_media |
||
cover_image_url |
||
created_at |
string(date-time) | |
data_image_urls |
Array<string> | |
deleted_at |
||
demo |
boolean | |
description |
||
ecommerce_description |
||
enabled |
boolean | |
exports_completed |
||
exports_total |
||
fit_type |
||
gender |
ProductGender | |
id |
string(uuid) | |
in_store_date |
||
incomplete |
boolean | |
ingest_job_id |
||
integration_name |
||
is_filler |
boolean | |
length_type |
||
master_item_code |
||
materials |
||
name |
string | |
neckline |
||
organization_id |
||
owner_id |
string(uuid) | |
pattern |
||
placement |
||
product_family |
||
product_type |
||
product_type_id |
||
product_wear |
||
product_wear_id |
||
public |
boolean | |
reference_images |
Array<string> | |
reference_images_media |
||
season |
||
shot_status |
||
shot_status_production_request_id |
||
shots |
Array<> | |
sku |
||
sleeve_type |
||
style_code |
||
style_group_id |
||
styling_slot |
StylingSlot | |
theme |
||
type |
||
updated_at |
string(date-time) | |
year |
||
zone |
ProductSearchFilters¶
| Name | Type | Description |
|---|---|---|
age_class |
||
brand |
||
brand_collection |
||
closure_type |
||
color_code |
||
color_name |
||
colour |
||
fit_type |
||
gender |
||
length_type |
||
neckline |
||
pattern |
||
product_type |
||
product_wear_id |
||
season |
||
shot_statuses |
||
sleeve_type |
||
year |
ProductSearchResultPublic¶
| Name | Type | Description |
|---|---|---|
has_more |
boolean | |
mode |
string | |
results |
Array<StylingSlotOptionPublic> |
ProductShootingStatus¶
Type: string
ShotStatusFilter¶
Type: string
StylingCandidateScopePublic¶
| Name | Type | Description |
|---|---|---|
inert_rules |
Array<StylistScopeRule> | |
rules |
Array<StylistScopeRule> |
StylingCapabilitiesPublic¶
| Name | Type | Description |
|---|---|---|
outfit_options_enabled |
boolean | |
product_search_enabled |
boolean | |
slot_options_enabled |
boolean |
StylingEditableSlot¶
Type: string
StylingProblemCode¶
Type: string
StylingProblemPublic¶
| Name | Type | Description |
|---|---|---|
active_run_id |
||
code |
StylingProblemCode | |
message |
string | |
retryable |
boolean |
StylingProductSearchCreate¶
| Name | Type | Description |
|---|---|---|
catalog_scope |
string | Visible Product Rack catalog scope. |
context_product_ids |
Array<string(uuid)> | Non-hero products on the active outfit card. Semantic results use them only as soft compatibility context. They remain eligible unless also supplied in exclude_product_ids. |
exclude_product_ids |
Array<string(uuid)> | Products already shown for this search, to skip. A guarantee: results only ever contain other products, and an exhausted pool returns an empty page rather than repeating one of these. |
filters |
||
limit |
integer | |
query |
string | |
slot |
Optional slot chip narrowing both identifier and semantic results to one outfit role; omitted searches every product type. |
StylingSlot¶
Type: string
StylingSlotOptionPublic¶
| Name | Type | Description |
|---|---|---|
product |
ProductPublic | |
rank |
integer |
StylingSlotOptionsCreate¶
| Name | Type | Description |
|---|---|---|
context_product_ids |
Array<string(uuid)> | |
direction |
||
exclude_product_ids |
Array<string(uuid)> | Products already shown for this target, to skip. A guarantee: results only ever contain other products, and an exhausted pool returns an empty page rather than repeating one of these. |
scope_rules |
Per-request candidate scope override. Omitted/null inherits the stylist's candidate_scope_rules; an empty list searches unscoped. | |
target |
StylingSlotReplaceTarget |
StylingSlotOptionsPublic¶
| Name | Type | Description |
|---|---|---|
has_more |
boolean | |
options |
Array<StylingSlotOptionPublic> | |
request_id |
string(uuid) | |
target_product_id |
string(uuid) | |
target_slot |
StylingEditableSlot |
StylingSlotReplaceTarget¶
| Name | Type | Description |
|---|---|---|
kind |
string | |
product_id |
string(uuid) |
StylistScopeRule¶
Type: string
ValidationError¶
| Name | Type | Description |
|---|---|---|
ctx |
||
input |
||
loc |
Array<> | |
msg |
string | |
type |
string |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| OAuth2PasswordBearer | oauth2 |