{"openapi":"3.0.1","info":{"title":"Merchant Data Orchestration","description":"API for Orchestration Merchant Data\n","termsOfService":"https://developer.cimpress.io/legal/api-terms-of-service","contact":{"name":"Firesharks","email":"firesharks@cimpress.com"},"version":"0.0.1"},"servers":[{"url":"/"}],"security":[{"auth0":[]},{"cimpressToken":[]},{"session":[]}],"paths":{"/v1/products/{productId}/availability":{"get":{"tags":["Product Availability"],"summary":"Provides the overall availability for a given product and version, along with selections and context based unavailability constraints","operationId":"getProductUnavailability","parameters":[{"name":"offset","in":"query","description":"Number of records to skip","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Number of records to fetch","required":false,"schema":{"type":"integer"}},{"name":"productId","in":"path","description":"Product Identifier of the Merchant Product","required":true,"schema":{"type":"string"}},{"name":"productVersion","in":"query","description":"Version of the Merchant Product","required":false,"schema":{"type":"integer"}},{"name":"unavailabilityConstraintType","in":"query","description":"This helps filter out the unavailabilities by their type","required":false,"schema":{"type":"string","enum":["TEMPORARILY_UNAVAILABLE","DISCONTINUED"]}},{"name":"allowPartialMatching","in":"query","required":false,"description":"To optionally return constraints that partially matches with the given selections","schema":{"type":"boolean"}},{"name":"source","in":"query","description":"Array of source types to filter constraints by. If not provided, all sources are included.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["MERCHANT","SUPPLIER"]},"example":["MERCHANT","SUPPLIER"]}},{"name":"selections","in":"query","description":"Selections on the Merchant Product.","style":"deepObject","required":false,"schema":{"type":"object","additionalProperties":{"type":"string"},"example":{"Color":"White","Size":"L"}}},{"name":"context","in":"query","description":"Context on the Merchant Product.","style":"deepObject","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"},"example":{"Merchant":"VISTAPRINT","Country":"IN"}}}],"responses":{"200":{"$ref":"#/components/responses/ProductUnavailabilityResponse"},"401":{"description":"Unauthorized","content":{}},"404":{"$ref":"#/components/responses/ErrorResponseModel"},"422":{"$ref":"#/components/responses/ErrorResponseModel"},"500":{"$ref":"#/components/responses/ErrorResponseModel"}}}},"/v1/products/{productId}/categories":{"get":{"tags":["Product Categories"],"summary":"Retrieves categories for a given product with optional locale support","operationId":"getProductCategories","parameters":[{"name":"productId","in":"path","description":"Product Identifier of the Merchant Product","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"Locale for localized category data or 'all' which will return all locales(e.g., 'en-gb', 'es-es', 'it-it')","required":false,"schema":{"type":"string","example":"en-gb"}}],"responses":{"200":{"$ref":"#/components/responses/ProductCategoriesResponse"},"401":{"description":"Unauthorized","content":{}},"404":{"$ref":"#/components/responses/ErrorResponseModel"},"500":{"$ref":"#/components/responses/ErrorResponseModel"}}}},"/v1/hierarchy/{hierarchyId}/category/{categoryId}/ancestors":{"get":{"tags":["Category Hierarchy"],"summary":"Retrieves ancestor categories for a given category in a hierarchy","operationId":"getCategoryAncestors","parameters":[{"name":"hierarchyId","in":"path","description":"Hierarchy Identifier","required":true,"schema":{"type":"string"}},{"name":"categoryId","in":"path","description":"Category Identifier","required":true,"schema":{"type":"string"}},{"name":"inclusive","in":"query","description":"Whether to include the specified category in the result","required":false,"schema":{"type":"boolean","default":false}},{"name":"locale","in":"query","description":"Locale identifier (e.g., 'en-us', 'it-it') or 'all' for all locales","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response with ancestor categories","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"categoryId":{"type":"string"},"hierarchyId":{"type":"string"},"path":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"slug":{"type":"string"},"parentCategoryId":{"type":"string"}}}}}}},"401":{"description":"Unauthorized","content":{}},"404":{"$ref":"#/components/responses/ErrorResponseModel"},"500":{"$ref":"#/components/responses/ErrorResponseModel"}}}},"/v1/purpose/{purposeName}/products/paths":{"get":{"tags":["Product Categories"],"summary":"Retrieves category paths for all products belonging to a given purpose","operationId":"getProductPaths","parameters":[{"name":"purposeName","in":"path","description":"Name of the purpose","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","description":"Account identifier","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Number of records to skip","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"Number of records to fetch. Max: 50","required":false,"schema":{"type":"integer","default":20,"maximum":50}},{"name":"primaryOnly","in":"query","description":"When true, returns only primary category paths","required":false,"schema":{"type":"boolean","default":false}},{"name":"productId","in":"query","description":"Filter results to a single product","required":false,"schema":{"type":"string","example":"prod-123"}},{"name":"locale","in":"query","description":"Locale for translations (e.g., 'en-us') or 'all' for all available locales. Translations are omitted when not provided.","required":false,"schema":{"type":"string","example":"en-us"}}],"responses":{"200":{"$ref":"#/components/responses/ProductPathsResponse"},"401":{"description":"Unauthorized","content":{}},"404":{"$ref":"#/components/responses/ErrorResponseModel"},"500":{"$ref":"#/components/responses/ErrorResponseModel"}}}},"/v1/products/{productId}/versions/{version}:productconfiguration":{"get":{"tags":["Product Configuration"],"summary":"An endpoint to return the product configuration URL for a given merchant product, version, and selections","operationId":"getProductConfigurationUrl","parameters":[{"name":"productId","in":"path","description":"Product Identifier of the Merchant Product","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Version of the Merchant Product","required":true,"schema":{"type":"integer"}},{"name":"selections","in":"query","description":"Selections on the Merchant Product.","style":"deepObject","required":false,"schema":{"type":"object","additionalProperties":{"type":"string"},"example":{"Color":"White","Size":"L"}}}],"responses":{"200":{"$ref":"#/components/responses/ProductConfigurationResponseData"},"401":{"description":"Unauthorized","content":{}},"404":{"$ref":"#/components/responses/ErrorResponseModel"},"422":{"$ref":"#/components/responses/ErrorResponseModel"},"500":{"$ref":"#/components/responses/ErrorResponseModel"}}}},"/v2/products/{productId}/versions/{version}/productconfiguration":{"get":{"tags":["Product Configuration"],"summary":"An endpoint to return the product configuration URL for a given merchant product, version, contexts and selections. It will respect product constraints as well as unavailability constraints while completing partial selections.","operationId":"v2GetProductConfigurationUrl","parameters":[{"name":"productId","in":"path","description":"Product Identifier of the Merchant Product","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Version of the Merchant Product","required":true,"schema":{"type":"integer"}},{"name":"context","in":"query","description":"Context on the Merchant Product.","style":"deepObject","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"},"example":{"Merchant":"VISTAPRINT","Country":"IN"}}},{"name":"selections","in":"query","description":"Selections on the Merchant Product.","style":"deepObject","required":false,"schema":{"type":"object","additionalProperties":{"type":"string"},"example":{"Color":"White","Size":"L"}}}],"responses":{"200":{"$ref":"#/components/responses/V2ProductConfigurationResponseData"},"401":{"description":"Unauthorized","content":{}},"404":{"$ref":"#/components/responses/ErrorResponseModel"},"422":{"$ref":"#/components/responses/ErrorResponseModel"},"500":{"$ref":"#/components/responses/ErrorResponseModel"}}}},"/v1/products/{productId}/versions/{version}/merchantProductConfiguration":{"get":{"tags":["Merchant Product Configuration"],"summary":"An endpoint to return the merchant configuration URL for a given merchant product, version and selections","description":"**Note:** This endpoint is fully functional in Swagger UI.\n\nThis endpoint accepts selections in one of two formats:\n- **Object format**: `{\"color\": \"red\", \"size\": \"large\"}`\n- **Array format**: `[{\"key\": \"color\", \"value\": \"red\"}, {\"key\": \"size\", \"value\": \"large\"}]`\n\nFor detailed usage examples using the array format, refer to the [Merchant Data Orchestration User Documentation](https://cimpress-support.atlassian.net/wiki/spaces/TS2/pages/16493052231/Merchant+Data+Orchestration+User+Document#Guide-for-constructing-requests-on-Postman-or-Curl).\n","operationId":"getMerchantProductConfigurationUrl","parameters":[{"name":"productId","in":"path","description":"Product Identifier of the Merchant Product","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Version of the Merchant Product","required":true,"schema":{"type":"integer","minimum":0}},{"name":"context","in":"query","description":"Context on the Merchant Product.","style":"deepObject","required":false,"schema":{"type":"object","additionalProperties":{"type":"string"},"example":{"Merchant":"VISTAPRINT","Country":"IN"}}},{"name":"selections","in":"query","description":"Selections on the Merchant Product. Accepts either a map/object (e.g., {\"color\":\"red\"}) or an array of objects (e.g., [{\"key\":\"color\",\"value\":\"red\"}]).","required":false,"schema":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"},"example":{"Color":"White","Size":"L"}},{"type":"array","description":"List of attribute selections for the product","example":[{"key":"color","value":"red"},{"key":"size","value":"large"}],"items":{"$ref":"#/components/schemas/Selection"}}]},"style":"deepObject","explode":true}],"responses":{"200":{"$ref":"#/components/responses/MerchantProductConfigurationResponseData"},"401":{"description":"Unauthorized","content":{}},"404":{"$ref":"#/components/responses/ErrorResponseModel"},"422":{"$ref":"#/components/responses/ErrorResponseModel"},"500":{"$ref":"#/components/responses/ErrorResponseModel"}}}},"/livecheck":{"get":{"tags":["Livecheck"],"summary":"Runs a healthcheck to ensure that the service is running.","operationId":"getLivecheck","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}},"head":{"tags":["Livecheck"],"summary":"Runs a healthcheck to ensure that the service is running.","operationId":"headLivecheck","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}}},"components":{"schemas":{"CategoryItem":{"type":"object","required":["id","name","key","path","hierarchyName","hierarchyId","createdOn","createdBy","modifiedOn","modifiedBy"],"properties":{"id":{"type":"string","example":"6ac0e638-58da-4792-82ac-c6165cdaa8f9"},"name":{"type":"string","example":"Mens Clothing"},"key":{"type":"string","example":"mens-clothing"},"path":{"type":"string","example":"Apparell-->Mens Cloth-->T Shirt"},"slug":{"type":"string","example":"mens-clothing-slug"},"hierarchyName":{"type":"string","example":"Apparel"},"hierarchyId":{"type":"string","example":"018b1e89-4d10-4b32-a27d-0e5d7c99844a"},"localizedData":{"$ref":"#/components/schemas/LocalizedData"},"createdOn":{"type":"string","format":"date-time","example":"2025-09-26T10:23:49.806Z"},"createdBy":{"type":"string","example":"user@example.com"},"modifiedOn":{"type":"string","format":"date-time","example":"2025-09-26T10:23:49.806Z"},"modifiedBy":{"type":"string","example":"user@example.com"}}},"LocalizedData":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/LocalizedCategoryData"},"example":{"es-es":{"name":"Ropa de Hombre","slug":"ropa-de-hombre","key":"mens-clothing","hierarchyName":"Ropa","path":"Ropa-->Ropa de Hombre-->Camiseta"},"it-it":{"name":"Abbigliamento Maschile","slug":"abbigliamento-maschile","key":"mens-clothing","hierarchyName":"Abbigliamento","path":"Abbigliamento-->Abbigliamento Maschile-->Maglietta"}}},"LocalizedCategoryData":{"type":"object","required":["name","slug","key","hierarchyName","path"],"properties":{"name":{"type":"string","example":"Ropa de Hombre"},"slug":{"type":"string","example":"ropa-de-hombre"},"key":{"type":"string","example":"mens-clothing"},"hierarchyName":{"type":"string","example":"Ropa"},"path":{"type":"string","example":"Ropa-->Ropa de Hombre-->Camiseta"}}},"CategoriesTranslationField":{"type":"object","required":["value","translation"],"properties":{"value":{"type":"string","example":"cat1test"},"translation":{"type":"string","example":"cat1test (fr)"}}},"CategoriesLocalizedContentTranslation":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/CategoriesTranslationField"},"description":{"$ref":"#/components/schemas/CategoriesTranslationField"},"slug":{"$ref":"#/components/schemas/CategoriesTranslationField"},"key":{"$ref":"#/components/schemas/CategoriesTranslationField"},"hierarchyName":{"$ref":"#/components/schemas/CategoriesTranslationField"},"categoryPath":{"$ref":"#/components/schemas/CategoriesTranslationField"},"imageUrl":{"$ref":"#/components/schemas/CategoriesTranslationField"},"metadata":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CategoriesTranslationField"},"description":"Additional dynamic metadata fields with translated values"}}},"CategoriesLocalizedContentItem":{"type":"object","required":["categoryKey","translations"],"properties":{"categoryKey":{"type":"string","example":"mens-clothing"},"translations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CategoriesLocalizedContentTranslation"},"description":"Keyed by locale (e.g. \"en-us\", \"fr-fr\")"}}},"LocalizedContentTranslation":{"type":"object","description":"Translated fields for a category in a single locale. All fields are omitted if null.","properties":{"name":{"type":"string","example":"Mens Clothing"},"description":{"type":"string","example":"Men's clothing category"},"slug":{"type":"string","example":"mens-clothing-slug"},"key":{"type":"string","example":"mens-clothing"},"hierarchyName":{"type":"string","example":"Taxonomy"},"categoryPath":{"type":"string","example":"Root-->Apparel-->Mens Clothing"},"imageUrl":{"type":"string","example":"https://cdn.example.com/img.jpg"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional dynamic metadata fields","example":{"urlSegment":"mens-clothing"}}}},"LocalizedContentItem":{"type":"object","description":"Keyed by locale (e.g. \"en-US\", \"fr-FR\"). Each value is the translated content for that locale.","additionalProperties":{"$ref":"#/components/schemas/LocalizedContentTranslation"}},"PathCategory":{"type":"object","required":["categoryKey","parentCategoryKey","categoryId","hierarchyId","path","name","description","key","slug","purpose"],"properties":{"categoryKey":{"type":"string","example":"mens-clothing"},"parentCategoryKey":{"type":"string","example":"apparel"},"categoryId":{"type":"string","format":"uuid","example":"6ac0e638-58da-4792-82ac-c6165cdaa8f9"},"hierarchyId":{"type":"string","format":"uuid","example":"018b1e89-4d10-4b32-a27d-0e5d7c99844a"},"parentCategoryId":{"type":"string","format":"uuid","nullable":true,"example":null},"path":{"type":"string","example":"Root-->Apparel-->Mens Clothing"},"name":{"type":"string","example":"Mens Clothing"},"description":{"type":"string","example":"Men's clothing category"},"key":{"type":"string","example":"mens-clothing"},"slug":{"type":"string","example":"mens-clothing-slug"},"imageUrl":{"type":"string","nullable":true,"example":null},"metadata":{"type":"object","nullable":true,"additionalProperties":true,"description":"Arbitrary key-value metadata attached to the category","example":{"anyKey":"anyValue"}},"purpose":{"type":"string","example":"navigation"}}},"ProductPath":{"type":"object","required":["isPrimary","categories"],"properties":{"isPrimary":{"type":"boolean","example":true},"categories":{"type":"array","description":"Ordered root to leaf","items":{"$ref":"#/components/schemas/PathCategory"}}}},"ProductPathsItem":{"type":"object","required":["productId","paths"],"properties":{"productId":{"type":"string","example":"PRD-ABCDEF"},"paths":{"type":"array","items":{"$ref":"#/components/schemas/ProductPath"}}}},"PurposeCategoryItem":{"type":"object","required":["categoryKey","depth","isPrimary"],"properties":{"categoryKey":{"type":"string","example":"mens-clothing"},"depth":{"type":"integer","example":0},"isPrimary":{"type":"boolean","example":true},"translations":{"type":"object","additionalProperties":{"type":"object"},"description":"Present only when locale query param is provided","example":{"en-US":{}}}}},"Selection":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"type":"string"}},"description":"Attribute selection for the product","example":{"key":"color","value":"red"}},"Attribute":{"type":"object","required":["key","value","buckets"],"properties":{"key":{"type":"string"},"value":{"type":"string"},"buckets":{"type":"array","description":"The bucket, attribute belongs to.","items":{"type":"string","example":["option","property"]}}}},"MerchantConfigAdditionalData":{"type":"object","properties":{"merchantProduct":{"type":"object","properties":{"completedSelections":{"type":"array","description":"It includes attributes completed by the API on the merchant product.","example":[{"key":"color","value":"red"},{"key":"size","value":"large"}],"items":{"$ref":"#/components/schemas/Selection"}}}}}},"V2AdditionalData":{"type":"object","properties":{"merchantProduct":{"type":"object","properties":{"completedSelections":{"$ref":"#/components/schemas/AttributeSelectionModel"}}}}},"AdditionalData":{"type":"object","properties":{"merchantProduct":{"type":"object","properties":{"completedSelections":{"$ref":"#/components/schemas/AttributeSelectionModel"}}},"rootProduct":{"type":"object","properties":{"productId":{"type":"string"},"version":{"type":"string"},"selections":{"$ref":"#/components/schemas/AttributeSelectionModel"}}}}},"AttributeSelectionModel":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]},"description":"Key-value map of the attribute name and selected value.","example":{"Finish":"No Finish","Weight":"90 g"}},"IMerchantConfigLinks":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Href"},"merchantProductConfiguration":{"$ref":"#/components/schemas/MerchantConfigurationLinks"},"productConfiguration":{"$ref":"#/components/schemas/ProductConfigurationLinks"}}},"ProductConfigurationLinks":{"type":"object","properties":{"href":{"type":"string"}}},"MerchantConfigurationLinks":{"type":"object","properties":{"href":{"type":"string"}}},"Self":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Href"}}},"Href":{"type":"object","properties":{"href":{"type":"string"}}},"ProductConfiguration":{"type":"object","properties":{"configuration":{"type":"object","properties":{"uri":{"type":"string"},"productId":{"type":"string"},"version":{"type":"string"},"selections":{"$ref":"#/components/schemas/AttributeSelectionModel"}}}}},"MerchantConfiguration":{"type":"object","required":["productId","productVersion","selections","attributes","additionalData","_links"],"properties":{"productId":{"type":"string"},"productVersion":{"type":"string"},"context":{"type":"object","additionalProperties":{"type":"string"},"description":"Context information for the merchant product (included when context is provided in request)","example":{"Merchant":"VISTAPRINT","Country":"IN"}},"selections":{"type":"array","description":"It includes attribute selections made by the user and attributes completed by the API on the merchant product.","example":[{"key":"color","value":"red"},{"key":"size","value":"large"}],"items":{"$ref":"#/components/schemas/Selection"}},"attributes":{"type":"array","description":"It includes attribute selections made by the user, attributes completed by the API, as well as attributes derived from both user selections and API-completed selections on the merchant product.","example":[{"key":"color","value":"red","buckets":["option"]},{"key":"size","value":"large","buckets":["option"]}],"items":{"$ref":"#/components/schemas/Attribute"}},"additionalData":{"$ref":"#/components/schemas/MerchantConfigAdditionalData"},"_links":{"$ref":"#/components/schemas/IMerchantConfigLinks"}}}},"responses":{"ProductCategoriesResponse":{"description":"RFC-compliant response with product categories and localized data","content":{"application/json":{"schema":{"type":"object","required":["_links","_embedded"],"properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.example.com/v1/products/PRD-ABCFGJ/categories"}}}}},"_embedded":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CategoryItem"}}}}}},"example":{"_links":{"self":{"href":"https://api.example.com/v1/products/PRD-ABCFGJ/categories"}},"_embedded":{"items":[{"id":"6ac0e638-58da-4792-82ac-c6165cdaa8f9","name":"Mens Clothing","key":"mens-clothing","path":"Apparell-->Mens Cloth-->T Shirt","slug":"mens-clothing-slug","hierarchyName":"Apparel","hierarchyId":"018b1e89-4d10-4b32-a27d-0e5d7c99844a","localizedData":{"es-es":{"name":"Ropa de Hombre","slug":"ropa-de-hombre","key":"mens-clothing","hierarchyName":"Ropa","path":"Ropa-->Ropa de Hombre-->Camiseta"}},"createdOn":"2025-09-26T10:23:49.806Z","createdBy":"user@example.com","modifiedOn":"2025-09-26T10:23:49.806Z","modifiedBy":"user@example.com"}]}}}}},"ProductPathsResponse":{"description":"Paginated response with product category paths for a given purpose","content":{"application/json":{"schema":{"type":"object","required":["_links","offset","total","count","_embedded"],"properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.example.com/v1/purpose/navigation/products/paths?accountId=acc-123"}}},"next":{"type":"object","properties":{"href":{"type":"string","example":"https://api.example.com/v1/purpose/navigation/products/paths?accountId=acc-123&offset=20"}}}}},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":10},"count":{"type":"integer","example":2},"_embedded":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductPathsItem"}},"localizedContents":{"type":"object","description":"Present only when locale query param is provided. Keyed by categoryKey, then by locale.","additionalProperties":{"$ref":"#/components/schemas/LocalizedContentItem"}}}}}}}}},"ProductPrimaryCategoryResponse":{"description":"Primary category assignment for a product under a given purpose","content":{"application/json":{"schema":{"type":"object","required":["id","productId","categoryKey","purposeId","purposeName","isPrimary","createdOn","createdBy","modifiedOn","modifiedBy"],"properties":{"id":{"type":"string","example":"assignment-id-123"},"productId":{"type":"string","format":"uuid","example":"6ac0e638-58da-4792-82ac-c6165cdaa8f9"},"categoryKey":{"type":"string","example":"mens-clothing"},"purposeId":{"type":"string","format":"uuid","example":"018b1e89-4d10-4b32-a27d-0e5d7c99844a"},"purposeName":{"type":"string","example":"navigation"},"isPrimary":{"type":"boolean","example":true},"createdOn":{"type":"string","format":"date-time","example":"2025-09-26T10:23:49.806Z"},"createdBy":{"type":"string","example":"user@example.com"},"modifiedOn":{"type":"string","format":"date-time","example":"2025-09-26T10:23:49.806Z"},"modifiedBy":{"type":"string","example":"user@example.com"},"translations":{"type":"object","additionalProperties":{"type":"object"},"description":"Present only when locale query param is provided","example":{"en-US":{}}}}}}}},"ProductPurposeCategoriesResponse":{"description":"All category branches for a product under a given purpose, each branch being a root-to-leaf path ordered by depth ascending.","content":{"application/json":{"schema":{"type":"object","required":["paths"],"properties":{"paths":{"type":"array","description":"List of category paths, each being a root-to-leaf ordered array of categories","items":{"$ref":"#/components/schemas/ProductPath"}},"localizedContents":{"type":"array","description":"Present only when locale query param is provided","items":{"$ref":"#/components/schemas/CategoriesLocalizedContentItem"}}}}}}},"ErrorResponseModel":{"description":"Error Response Model","content":{"*/*":{"schema":{"required":["logEventId","message"],"type":"object","properties":{"message":{"type":"string"},"logEventId":{"type":"string"},"details":{"type":"object","properties":{}}}}}}},"ProductConfigurationResponseData":{"description":"Response containing Product Configuration URL and completed selections on Merchant PRD","content":{"*/*":{"schema":{"type":"object","properties":{"_link":{"$ref":"#/components/schemas/Self"},"_embedded":{"$ref":"#/components/schemas/ProductConfiguration"},"additionalData":{"$ref":"#/components/schemas/AdditionalData"}}}}}},"V2ProductConfigurationResponseData":{"description":"Response containing Product Configuration URL and completed selections on Merchant PRD","content":{"*/*":{"schema":{"type":"object","properties":{"_link":{"$ref":"#/components/schemas/Self"},"_embedded":{"$ref":"#/components/schemas/ProductConfiguration"},"additionalData":{"$ref":"#/components/schemas/V2AdditionalData"}}}}}},"MerchantProductConfigurationResponseData":{"description":"Response containing Merchant Configuration URL and completed selections on Merchant PRD","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MerchantConfiguration"}}}},"ProductUnavailabilityResponse":{"description":"Response for Product Availability respecting the selections and context for a productId and productVersion","content":{"*/*":{"schema":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Self"},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":15},"count":{"type":"integer","example":10},"status":{"type":"string","description":"Represents the status on the requested context","enum":["OPEN","ACTIVE","RETIRED","ARCHIVED"]},"_embedded":{"type":"object","properties":{"unavailabilityConstraints":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["TEMPORARILY_UNAVAILABLE","DISCONTINUED"]},"reason":{"type":"string","example":"Production Issues"},"name":{"type":"string","example":"Permanent US - Capacity Restriction"},"source":{"type":"string","enum":["MERCHANT","SUPPLIER"],"example":"MERCHANT","description":"Source of the constraint - MERCHANT or SUPPLIER"},"assortment":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"Brand"},"values":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["stringLiteral"]},"stringLiteral":{"type":"string","example":"Puma"}}}}}}}}}}}}}}}}}},"securitySchemes":{"auth0":{"type":"oauth2","description":"Authentication with Auth0","flows":{"implicit":{"authorizationUrl":"https://cimpress.auth0.com/authorize","scopes":{}}}},"cimpressToken":{"type":"oauth2","description":"Authentication with Cimpress Issued Tokens","flows":{"implicit":{"authorizationUrl":"https://oauth.cimpress.io/authorize","scopes":{}}}},"session":{"type":"apiKey","description":"Format on how to provide session scheme `Session {sessionId}`","name":"Authorization","in":"header"}}}}