--- title: Add SKU (Product Item) slug: api-documentation/add-sku-product-item docTags: createdAt: 2026-08-27T16:53:40.115Z --- { "id": "03WhY3rB8rnYt1Ml1MQVy", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem", "servers": [ { "url": "https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem" } ], "name": "Add SKU (Product Item)", "description": "

This endpoint allows administrators to append a new product item SKU (stock keeping unit) to the indicated work-in-progress catalog item.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "catalogItemId", "type": "string", "description": "Unique identifier for a catalog item." } ], "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": "object", "description": "", "discriminator": { "propertyName": "type", "mapping": { "protectionPlan": "#/components/schemas/CreateProtectionPlanItem", "service": "#/components/schemas/CreateServiceItem", "warranty": "#/components/schemas/CreateWarrantyItem", "product": "#/components/schemas/CreateProductItem" } }, "customType": "CreateSkuItem", "schema": [], "modelRef": "#/components/schemas/CreateSkuItem", "complexItems": [ { "name": "object", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "skuId", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/SkuItemId", "customType": "SkuItemId", "schema": [] }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "brandName", "kind": "optional", "type": "string", "description": "" }, { "name": "manufacturerName", "kind": "optional", "type": "string", "description": "" }, { "name": "media", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] }, { "name": "tags", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dynamicProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "shippingMethodIds", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ShippingMethodId", "customType": "ShippingMethodId[]", "schema": [] }, { "name": "ignoreInventory", "kind": "optional", "type": "boolean", "description": "" }, { "name": "dimensions", "kind": "optional", "type": "object", "deprecated": true, "description": "Warning: Deprecated\n", "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": "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": "numPieces", "kind": "optional", "type": "integer", "description": "", "format": "int32", "minimum": 0, "exclusiveMinimum": true }, { "name": "shippingPackages", "kind": "optional", "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": "purchasable", "kind": "required", "type": "boolean", "description": "" }, { "name": "disabled", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "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": "pimVariantId", "kind": "optional", "type": "string", "description": "", "default": "N/A" } ], "modelRef": "#/components/schemas/CreateProductItem", "customType": "CreateProductItem" }, { "name": "object", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "skuId", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "required", "type": "string", "description": "" }, { "name": "termsAndConditions", "kind": "required", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "UrlTermsAndConditions": "#/components/schemas/UrlTermsAndConditionsUpdate", "DrupalTermsAndConditions": "#/components/schemas/DrupalTermsAndConditionsUpdate", "CloudinaryAsset": "#/components/schemas/CloudinaryAssetUpdate" } }, "description": "", "modelRef": "#/components/schemas/TermsAndConditionsUpdate", "customType": "TermsAndConditionsUpdate", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "UrlTermsAndConditionsUpdate", "description": "", "modelRef": "#/components/schemas/UrlTermsAndConditionsUpdate", "schema": [ { "name": "url", "kind": "required", "type": "string", "description": "" } ] }, { "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": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "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": "dynamicProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "purchasable", "kind": "required", "type": "boolean", "description": "" }, { "name": "disabled", "kind": "required", "type": "boolean", "description": "" }, { "name": "pimVariantId", "kind": "optional", "type": "string", "description": "", "default": "N/A" } ], "modelRef": "#/components/schemas/CreateProtectionPlanItem", "customType": "CreateProtectionPlanItem" }, { "name": "object", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "skuId", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "required", "type": "string", "description": "" }, { "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": "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": "dynamicProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "purchasable", "kind": "required", "type": "boolean", "description": "" }, { "name": "disabled", "kind": "required", "type": "boolean", "description": "" } ], "modelRef": "#/components/schemas/CreateServiceItem", "customType": "CreateServiceItem" }, { "name": "object", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "description", "kind": "required", "type": "string", "description": "" }, { "name": "disabled", "kind": "optional", "type": "boolean", "description": "" }, { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "purchasable", "kind": "required", "type": "boolean", "description": "" }, { "name": "skuId", "kind": "optional", "type": "string", "description": "" }, { "name": "termsAndConditions", "kind": "required", "type": "object", "discriminator": { "propertyName": "type", "mapping": { "UrlTermsAndConditions": "#/components/schemas/UrlTermsAndConditionsUpdate", "DrupalTermsAndConditions": "#/components/schemas/DrupalTermsAndConditionsUpdate", "CloudinaryAsset": "#/components/schemas/CloudinaryAssetUpdate" } }, "description": "", "modelRef": "#/components/schemas/TermsAndConditionsUpdate", "customType": "TermsAndConditionsUpdate", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "UrlTermsAndConditionsUpdate", "description": "", "modelRef": "#/components/schemas/UrlTermsAndConditionsUpdate", "schema": [ { "name": "url", "kind": "required", "type": "string", "description": "" } ] }, { "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": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "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": "dynamicProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "pimVariantId", "kind": "optional", "type": "string", "description": "", "default": "N/A" } ], "modelRef": "#/components/schemas/CreateWarrantyItem", "customType": "CreateWarrantyItem" } ], "complexType": "oneOf", "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-product object submitted to the work-in-progress catalog.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "discriminator": { "propertyName": "type", "mapping": { "product": "#/components/schemas/ProductItem", "protectionPlan": "#/components/schemas/ProtectionPlanItem", "service": "#/components/schemas/ServiceItem", "warranty": "#/components/schemas/WarrantyItem" } }, "customType": "SkuItem", "schema": [], "modelRef": "#/components/schemas/SkuItem", "complexItems": [ { "name": "object", "schema": [ { "name": "brandname", "kind": "optional", "type": "string", "description": "" }, { "name": "disabled", "kind": "optional", "type": "boolean", "description": "", "default": false }, { "name": "dynamicProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "feeMultiplier", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "ignoreInventory", "kind": "optional", "type": "boolean", "description": "" }, { "name": "manufacturerName", "kind": "optional", "type": "string", "description": "" }, { "name": "media", "kind": "optional", "type": "map", "description": "", "example": "", "customType": "map", "schema": [] }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "numPieces", "kind": "optional", "type": "integer", "description": "", "example": 2, "format": "int32", "minimum": 0, "exclusiveMinimum": true }, { "name": "purchasable", "kind": "required", "type": "boolean", "description": "" }, { "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": "dimensions", "kind": "optional", "type": "object", "deprecated": true, "description": "Warning: Deprecated\n

Dimensions of the SKU item (deprecated, use skuDimensions instead)

", "example": "", "schema": [ { "name": "length", "kind": "required", "type": "number", "description": "Length of the SKU item", "format": "double" }, { "name": "width", "kind": "required", "type": "number", "description": "Width of the SKU item", "format": "double" }, { "name": "height", "kind": "required", "type": "number", "description": "Height of the SKU item", "format": "double" }, { "name": "unit", "kind": "required", "type": "string", "description": "", "enum": [ "cm", "m", "in", "mm" ] } ] }, { "name": "skuDimensions", "kind": "required", "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": "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": "upc", "kind": "optional", "type": "string", "description": "" }, { "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": "pimVariantId", "kind": "optional", "type": "string", "description": "

Product Information Management (PIM) variant ID for the SKU item

", "default": "N/A" } ], "modelRef": "#/components/schemas/ProductItem", "customType": "ProductItem" }, { "name": "object", "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": "", "modelRef": "#/components/schemas/SkuItemId", "customType": "SkuItemId", "schema": [] }, { "name": "dynamicProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "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": "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": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "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" } ] } ] } ], "modelRef": "#/components/schemas/ProtectionPlanItem", "customType": "ProtectionPlanItem" }, { "name": "object", "schema": [ { "name": "description", "kind": "required", "type": "string", "description": "" }, { "name": "disabled", "kind": "required", "type": "boolean", "description": "", "default": false }, { "name": "dynamicProperties", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "name", "kind": "required", "type": "string", "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": "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" } ] } ] } ], "modelRef": "#/components/schemas/ServiceItem", "customType": "ServiceItem" }, { "name": "object", "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": "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": "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": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "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" } ] } ] } ], "modelRef": "#/components/schemas/WarrantyItem", "customType": "WarrantyItem" } ], "complexType": "oneOf", "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 } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "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": "S1HHIF3poS-9zkqiI6-9n", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"type\": \"\",\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n },\n \"shippingPackages\": [\n {\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n }\n }\n ],\n \"purchasable\": \"\",\n \"skuDimensions\": [\n {\n \"name\": \"\",\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n }\n ],\n \"pimVariantId\": \"N/A\"\n }'" }, { "id": "TY5bZDyANwX4CjaG6xOHp", "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 raw = JSON.stringify({\n \"type\": \"\",\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n },\n \"shippingPackages\": [\n {\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n }\n }\n ],\n \"purchasable\": \"\",\n \"skuDimensions\": [\n {\n \"name\": \"\",\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n }\n ],\n \"pimVariantId\": \"N/A\"\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "DxYJYNd_ysN2NUc-PrnWM", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"type\": \"\",\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n },\n \"shippingPackages\": [\n {\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n }\n }\n ],\n \"purchasable\": \"\",\n \"skuDimensions\": [\n {\n \"name\": \"\",\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n }\n ],\n \"pimVariantId\": \"N/A\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "3ybqxt-LKjgehkacs2rGD", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem\"\n\npayload = json.dumps({\n \"type\": \"\",\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n },\n \"shippingPackages\": [\n {\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n }\n }\n ],\n \"purchasable\": \"\",\n \"skuDimensions\": [\n {\n \"name\": \"\",\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n }\n ],\n \"pimVariantId\": \"N/A\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "S1HHIF3poS-9zkqiI6-9n" }, "results": { "languages": [ { "id": "g3kFCtT1QYhN69AvgIwtg", "language": "200", "code": "// Success-product object submitted to the work-in-progress catalog.\n{}" }, { "id": "IMQNOJCSvdxH7YOGEA31t", "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": "W67P5EaYxRoaBO4FuRqWd", "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}" }, { "id": "rLWZZzuQj2el8NmEQOx6J", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "g3kFCtT1QYhN69AvgIwtg" } }, "children": [ { "text": "" } ] }