---
title: List Editable Items by ID
slug: api-documentation/list-editable-items-by-id
docTags:
createdAt: 2026-08-27T16:53:40.115Z
---
{
"id": "x2nfwu65n8qX3ErJ1lVLw",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.upstartcommerce.com/v1/catalog/wip/list",
"servers": [
{
"url": "https://api.upstartcommerce.com/v1/catalog/wip/list"
}
],
"name": "List Editable Items by ID",
"description": "This endpoint retrieves the given catalog items based on the list of ids provided, whether they are live or a work-in-progress.
\nAuthorized permissions:
\n",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "x-upstart-tenant",
"type": "string",
"description": "Tenant identifier associated with the site this call is for."
},
{
"kind": "optional",
"name": "x-upstart-site",
"type": "string",
"description": "Unique identifier for the site."
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "array",
"description": "JSON-formatted formatted array of ids for the required items.
",
"customType": "CatalogItemId[]",
"schema": [],
"modelRef": "#/components/schemas/CatalogItemId",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "NoChannelPortalAccess",
"name": "NoChannelPortalAccess",
"kind": "optional",
"type": "http",
"description": "This authentication is required for clients to interact with any of the management APIs. Similar to \"LoggedIn\", it indicates that the user has actually logged into the system, but in this case with a management role.
",
"scheme": "bearer"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Success-relevant ids located (or not).\nIf any of the items can't be found they are not included in the response; if none are found an empty array will be returned.
",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "array",
"description": "",
"customType": "CatalogItemSummary[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "",
"modelRef": "#/components/schemas/CatalogItemId",
"customType": "CatalogItemId",
"schema": []
},
{
"name": "activationDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "archived",
"kind": "optional",
"type": "boolean",
"description": "",
"default": false
},
{
"name": "avgRating",
"kind": "optional",
"type": "number",
"description": "",
"format": "double"
},
{
"name": "avgGroupRating",
"kind": "optional",
"type": "number",
"description": "",
"format": "double"
},
{
"name": "excludesClearanceItems",
"kind": "optional",
"type": "boolean",
"description": ""
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "deactivationDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "dynamicProperties",
"kind": "required",
"type": "object",
"description": "",
"example": "",
"schema": []
},
{
"name": "hidden",
"kind": "required",
"type": "boolean",
"description": "",
"default": false
},
{
"name": "ignoreInventory",
"kind": "required",
"type": "boolean",
"description": "",
"default": false
},
{
"name": "liveDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "manufacturerName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "media",
"kind": "optional",
"type": "map",
"description": "",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "modifiedDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "numReviews",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "numGroupReviews",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "offeredStandardWarranty",
"kind": "optional",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"DrupalTermsAndConditions": "#/components/schemas/DrupalTermsAndConditionsUpdate",
"CloudinaryAsset": "#/components/schemas/CloudinaryAssetUpdate"
}
},
"description": "",
"modelRef": "#/components/schemas/GeneralTermsAndConditions",
"customType": "GeneralTermsAndConditions",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "DrupalTermsAndConditionsUpdate",
"description": "",
"modelRef": "#/components/schemas/DrupalTermsAndConditionsUpdate",
"schema": [
{
"name": "resource",
"kind": "required",
"type": "object",
"discriminator": {
"propertyName": "type"
},
"description": "",
"modelRef": "#/components/schemas/DrupalResource",
"customType": "DrupalResource",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "NidDrupalResource",
"description": "",
"modelRef": "#/components/schemas/NidDrupalResource",
"schema": [
{
"name": "nId",
"kind": "required",
"type": "integer",
"description": "",
"format": "int64"
}
]
},
{
"name": "ResolvedDrupalResource",
"description": "",
"modelRef": "#/components/schemas/ResolvedDrupalResource",
"schema": [
{
"name": "nId",
"kind": "required",
"type": "integer",
"description": "",
"format": "int64"
},
{
"name": "id",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "version",
"kind": "required",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "url",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "resolvedAt",
"kind": "required",
"type": "string",
"description": "",
"format": "date-time"
}
]
}
]
},
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"default": "DrupalTermsAndConditions"
}
]
},
{
"name": "CloudinaryAssetUpdate",
"description": "",
"modelRef": "#/components/schemas/CloudinaryAssetUpdate",
"schema": [
{
"name": "contentType",
"kind": "optional",
"type": "string",
"description": "The MIME type category of the asset",
"example": "pdf"
},
{
"name": "vendor",
"kind": "optional",
"type": "string",
"description": "The storage vendor for the asset",
"example": "Cloudinary"
},
{
"name": "url",
"kind": "optional",
"type": "string",
"description": "The URL of the asset"
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "Display name of the asset",
"example": "My test file2"
},
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique identifier from the vendor",
"example": "cloudinary-id"
},
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"default": "CloudinaryAsset"
}
]
}
]
},
{
"name": "offeredWarrantyId",
"kind": "optional",
"type": "string",
"description": "",
"modelRef": "#/components/schemas/CatalogItemId",
"customType": "CatalogItemId",
"schema": []
},
{
"name": "offeredProtectionPlanType",
"kind": "optional",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"Standard": "#/components/schemas/StandardOfferedProtectionPlanType",
"DenverMattress": "#/components/schemas/DmOfferedProtectionPlanType"
}
},
"description": "",
"modelRef": "#/components/schemas/OfferedProtectionPlanType",
"customType": "OfferedProtectionPlanType",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "DmOfferedProtectionPlanType",
"description": "",
"modelRef": "#/components/schemas/DmOfferedProtectionPlanType",
"schema": [
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"DenverMattress"
]
}
]
},
{
"name": "StandardOfferedProtectionPlanType",
"description": "",
"modelRef": "#/components/schemas/StandardOfferedProtectionPlanType",
"schema": [
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"Standard"
]
},
{
"name": "id",
"kind": "required",
"type": "string",
"description": ""
}
]
}
]
},
{
"name": "productItems",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/SkuItemSummary",
"customType": "SkuItemSummary[]",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "ProductItemSummary",
"description": "",
"modelRef": "#/components/schemas/ProductItemSummary",
"schema": [
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "dimensions",
"kind": "optional",
"type": "object",
"deprecated": true,
"description": "Warning: Deprecated\nDimensions of the product item (deprecated, use skuDimensions instead)
",
"modelRef": "#/components/schemas/Dimensions",
"customType": "Dimensions",
"schema": [
{
"name": "width",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "length",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "height",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"cm",
"m",
"in",
"mm"
]
}
]
},
{
"name": "disabled",
"kind": "optional",
"type": "boolean",
"description": "",
"default": false
},
{
"name": "dynamicProperties",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": []
},
{
"name": "ignoreInventory",
"kind": "optional",
"type": "boolean",
"description": ""
},
{
"name": "manufactureName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "media",
"kind": "optional",
"type": "map",
"description": "",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "Name for the product item."
},
{
"name": "numPieces",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32",
"minimum": 0,
"exclusiveMinimum": true
},
{
"name": "pricing",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Pricing",
"customType": "Pricing",
"schema": [
{
"name": "currency",
"kind": "required",
"type": "string",
"description": "",
"example": "USD",
"pattern": "^[A-Z]{3}$"
},
{
"name": "price",
"kind": "required",
"type": "number",
"description": ""
}
]
},
{
"name": "purchasable",
"kind": "required",
"type": "boolean",
"description": "",
"default": true
},
{
"name": "shippingMethodIds",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ShippingMethodId",
"customType": "ShippingMethodId[]",
"schema": []
},
{
"name": "shippingPackages",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ShippingPackage",
"customType": "ShippingPackage[]",
"schema": [
{
"name": "dimensions",
"kind": "required",
"type": "object",
"description": "This is a common definition of a dimension.",
"modelRef": "#/components/schemas/Dimensions",
"customType": "Dimensions",
"schema": [
{
"name": "width",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "length",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "height",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"cm",
"m",
"in",
"mm"
]
}
]
},
{
"name": "weight",
"kind": "required",
"type": "object",
"description": "Defines a common structure for representing weights.",
"modelRef": "#/components/schemas/Weight",
"customType": "Weight",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"description": "",
"format": "double",
"minimum": 0
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "Unit of measurement.",
"enum": [
"g",
"kg",
"lb"
]
}
]
}
]
},
{
"name": "skuId",
"kind": "required",
"type": "string",
"description": "",
"modelRef": "#/components/schemas/SkuItemId",
"customType": "SkuItemId",
"schema": []
},
{
"name": "tags",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "weight",
"kind": "optional",
"type": "object",
"description": "Defines a common structure for representing weights.",
"modelRef": "#/components/schemas/Weight",
"customType": "Weight",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"description": "",
"format": "double",
"minimum": 0
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "Unit of measurement.",
"enum": [
"g",
"kg",
"lb"
]
}
]
},
{
"name": "upc",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "feeMultiplier",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "skuDimensions",
"kind": "optional",
"type": "array",
"description": "This is a common definition of a sku's dimension.",
"modelRef": "#/components/schemas/DimensionsInfo",
"customType": "DimensionsInfo[]",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "width",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "length",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "height",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"cm",
"m",
"in",
"mm"
]
}
]
}
]
},
{
"name": "ProtectionPlanItemSummary",
"description": "",
"modelRef": "#/components/schemas/ProtectionPlanItemSummary",
"schema": [
{
"name": "description",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "disabled",
"kind": "required",
"type": "boolean",
"description": ""
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "purchasable",
"kind": "required",
"type": "boolean",
"description": ""
},
{
"name": "skuId",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "dynamicProperties",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": []
},
{
"name": "pricing",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Pricing",
"customType": "Pricing",
"schema": [
{
"name": "currency",
"kind": "required",
"type": "string",
"description": "",
"example": "USD",
"pattern": "^[A-Z]{3}$"
},
{
"name": "price",
"kind": "required",
"type": "number",
"description": ""
}
]
},
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"default": "protectionPlan",
"enum": [
"bundle",
"product",
"protectionPlan",
"service",
"warranty",
"fee"
]
},
{
"name": "termsAndConditions",
"kind": "required",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"UrlTermsAndConditions": "#/components/schemas/UrlTermsAndConditions",
"DrupalTermsAndConditions": "#/components/schemas/DrupalTermsAndConditions",
"CloudinaryAsset": "#/components/schemas/CloudinaryAssetUpdate"
}
},
"description": "",
"modelRef": "#/components/schemas/TermsAndConditions",
"customType": "TermsAndConditions",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "UrlTermsAndConditions",
"description": "",
"modelRef": "#/components/schemas/UrlTermsAndConditions",
"schema": [
{
"name": "url",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "version",
"kind": "optional",
"type": "integer",
"description": "",
"example": 17,
"format": "int32"
},
{
"name": "validSince",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"default": "UrlTermsAndConditions"
}
]
},
{
"name": "DrupalTermsAndConditions",
"description": "",
"modelRef": "#/components/schemas/DrupalTermsAndConditions",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "CloudinaryAssetUpdate",
"description": "",
"modelRef": "#/components/schemas/CloudinaryAssetUpdate",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
}
]
},
{
"name": "ServiceItemSummary",
"description": "",
"modelRef": "#/components/schemas/ServiceItemSummary",
"schema": [
{
"name": "description",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "disabled",
"kind": "optional",
"type": "boolean",
"description": "",
"default": false
},
{
"name": "dynamicProperties",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": []
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "pricing",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Pricing",
"customType": "Pricing",
"schema": [
{
"name": "currency",
"kind": "required",
"type": "string",
"description": "",
"example": "USD",
"pattern": "^[A-Z]{3}$"
},
{
"name": "price",
"kind": "required",
"type": "number",
"description": ""
}
]
},
{
"name": "purchasable",
"kind": "required",
"type": "boolean",
"description": "",
"default": true
},
{
"name": "skuId",
"kind": "required",
"type": "string",
"description": "",
"modelRef": "#/components/schemas/SkuItemId",
"customType": "SkuItemId",
"schema": []
},
{
"name": "termsAndConditions",
"kind": "optional",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"DrupalTermsAndConditions": "#/components/schemas/DrupalTermsAndConditionsUpdate",
"CloudinaryAsset": "#/components/schemas/CloudinaryAssetUpdate"
}
},
"description": "",
"modelRef": "#/components/schemas/GeneralTermsAndConditions",
"customType": "GeneralTermsAndConditions",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "DrupalTermsAndConditionsUpdate",
"description": "",
"modelRef": "#/components/schemas/DrupalTermsAndConditionsUpdate",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "CloudinaryAssetUpdate",
"description": "",
"modelRef": "#/components/schemas/CloudinaryAssetUpdate",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"default": "service",
"enum": [
"product",
"protectionPlan",
"service",
"warranty"
]
}
]
},
{
"name": "WarrantyItemSummary",
"description": "",
"modelRef": "#/components/schemas/WarrantyItemSummary",
"schema": [
{
"name": "description",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "disabled",
"kind": "required",
"type": "boolean",
"description": ""
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "purchasable",
"kind": "required",
"type": "boolean",
"description": ""
},
{
"name": "skuId",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "termsAndConditions",
"kind": "required",
"type": "object",
"discriminator": {
"propertyName": "type",
"mapping": {
"UrlTermsAndConditions": "#/components/schemas/UrlTermsAndConditions",
"DrupalTermsAndConditions": "#/components/schemas/DrupalTermsAndConditions",
"CloudinaryAsset": "#/components/schemas/CloudinaryAssetUpdate"
}
},
"description": "",
"modelRef": "#/components/schemas/TermsAndConditions",
"customType": "TermsAndConditions",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "UrlTermsAndConditions",
"description": "",
"modelRef": "#/components/schemas/UrlTermsAndConditions",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "DrupalTermsAndConditions",
"description": "",
"modelRef": "#/components/schemas/DrupalTermsAndConditions",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "CloudinaryAssetUpdate",
"description": "",
"modelRef": "#/components/schemas/CloudinaryAssetUpdate",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "dynamicProperties",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": []
},
{
"name": "pricing",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Pricing",
"customType": "Pricing",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"default": "warranty",
"enum": [
"bundle",
"product",
"protectionPlan",
"service",
"warranty",
"fee"
]
}
]
}
]
},
{
"name": "productPopularity",
"kind": "optional",
"type": "number",
"description": "",
"format": "double"
},
{
"name": "productPopularityBySite",
"kind": "optional",
"type": "map",
"description": "Per-site popularity values, keyed by site id. A site absent from this map has no popularity value set yet.
",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "relatedIds",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/CatalogItemId",
"customType": "CatalogItemId[]",
"schema": []
},
{
"name": "seo",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Seo",
"customType": "Seo",
"schema": [
{
"name": "pageTitle",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "metaKeywords",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
]
},
{
"name": "serviceQualification",
"kind": "optional",
"type": "object",
"description": "This is supposed to be filled in for all services and it determines associations of the service, i.e. which products and shipping methods can the service be bought for.
",
"modelRef": "#/components/schemas/ServiceQualification",
"customType": "ServiceQualification",
"schema": [
{
"name": "eligibleProductIds",
"kind": "optional",
"type": "array",
"description": "Lists products this service can be bought for. If empty, buying of the service is not tight to any product.
",
"modelRef": "#/components/schemas/CatalogItemId",
"customType": "CatalogItemId[]",
"schema": []
},
{
"name": "eligibleShippingMethodIds",
"kind": "optional",
"type": "array",
"description": "Lists shipping methods this service can be bought for. If empty, buying of the service is not tight to any shipping method.
",
"modelRef": "#/components/schemas/ShippingMethodId",
"customType": "ShippingMethodId[]",
"schema": []
}
]
},
{
"name": "shippingMethodIds",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ShippingMethodId",
"customType": "ShippingMethodId[]",
"schema": []
},
{
"name": "siteIds",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/SiteId",
"customType": "SiteId[]",
"schema": []
},
{
"name": "subVersion",
"kind": "optional",
"type": "integer",
"description": "",
"default": 0,
"format": "int32"
},
{
"name": "tags",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "taxCode",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "type",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"product",
"protectionPlan",
"service",
"warranty"
]
},
{
"name": "typeId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the catalog item type. This must be an id of an existing catalog item type.",
"example": "FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318",
"modelRef": "#/components/schemas/CatalogItemTypeId",
"customType": "CatalogItemTypeId",
"schema": []
},
{
"name": "typeName",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "version",
"kind": "required",
"type": "integer",
"description": "",
"default": 0,
"format": "int32"
},
{
"name": "productLineIds",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "collectionIds",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
}
],
"modelRef": "#/components/schemas/CatalogItemSummary",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ValidationErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ValidationErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "avusd-FaGr8UJofb2A4Bi",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/catalog/wip/list \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'"
},
{
"id": "3OEt9vr1Hb3ETz_l0KsNM",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/catalog/wip/list\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "NJJ31Fb3pDGX_q8B_uQ4f",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/catalog/wip/list\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "7CFXyEFgYdYcZXHYqZFu_",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/catalog/wip/list\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "avusd-FaGr8UJofb2A4Bi"
},
"results": {
"languages": [
{
"id": "IbpZz6gFoWVUJBB6JMynv",
"language": "200",
"code": "// Success-relevant ids located (or not).\nIf any of the items can't be found they are not included in the response; if none are found an empty array will be returned.\n[\n {\n \"id\": \"\",\n \"activationDate\": \"\",\n \"archived\": false,\n \"avgRating\": \"\",\n \"avgGroupRating\": \"\",\n \"excludesClearanceItems\": false,\n \"brandName\": \"\",\n \"deactivationDate\": \"\",\n \"dynamicProperties\": {},\n \"hidden\": false,\n \"ignoreInventory\": false,\n \"liveDate\": \"\",\n \"manufacturerName\": \"\",\n \"media\": \"\",\n \"modifiedDate\": \"\",\n \"name\": \"\",\n \"numReviews\": \"\",\n \"numGroupReviews\": \"\",\n \"offeredStandardWarranty\": {},\n \"offeredWarrantyId\": \"\",\n \"offeredProtectionPlanType\": {},\n \"productItems\": {},\n \"productPopularity\": \"\",\n \"productPopularityBySite\": \"\",\n \"relatedIds\": [\n \"\"\n ],\n \"seo\": {\n \"pageTitle\": \"\",\n \"description\": \"\",\n \"metaKeywords\": [\n \"\"\n ]\n },\n \"serviceQualification\": {\n \"eligibleProductIds\": [\n \"\"\n ],\n \"eligibleShippingMethodIds\": [\n \"\"\n ]\n },\n \"shippingMethodIds\": [\n \"\"\n ],\n \"siteIds\": [\n \"\"\n ],\n \"subVersion\": \"\",\n \"tags\": [\n \"\"\n ],\n \"taxCode\": \"\",\n \"type\": \"\",\n \"typeId\": \"FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318\",\n \"typeName\": \"\",\n \"version\": \"\",\n \"productLineIds\": [\n \"\"\n ],\n \"collectionIds\": [\n \"\"\n ]\n }\n]"
},
{
"id": "1NWsstq36S9L0xipYUkGn",
"language": "400",
"code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}"
},
{
"id": "vxqH3OHqoTM4ubyqi3zWb",
"language": "401",
"code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
}
],
"selectedLanguageId": "IbpZz6gFoWVUJBB6JMynv"
}
},
"children": [
{
"text": ""
}
]
}