Add SKU (Product Item)

1 min

PUT

https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem

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

Authorized permissions:

catalog.update

Path Parameters

catalogItemIdstringrequired
Description
Unique identifier for a catalog item.

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.
x-upstart-sitestring
Description
Unique identifier for the site.

Body Parameters

bodyCreateSkuItemrequired
- objectCreateProductItem
  - typestringrequired
  - skuIdSkuItemId
  - namestring
  - brandNamestring
  - manufacturerNamestring
  - mediamap<string, MediaValue>
  - tagsstring[]
  - dynamicPropertiesobject
  - shippingMethodIdsShippingMethodId[]
  - ignoreInventoryboolean
  - dimensionsDimensions
    Description
    Warning: Deprecated
    - widthnumber<double>required
      Example
      18.5
      Format
      double
    - lengthnumber<double>required
      Example
      18.5
      Format
      double
    - heightnumber<double>required
      Example
      18.5
      Format
      double
    - unitstring<cm | m | in | mm>required
      Allowed
      cmminmm
  - weightWeight
    Description
    Defines a common structure for representing weights.
    - valuenumber<double>required
      Format
      double
      Minimum
      0
    - unitstring<g | kg | lb>required
      Description
      Unit of measurement.
      Allowed
      gkglb
  - numPiecesinteger<int32>
    Format
    int32
    Minimum (exclusive)
    0
  - shippingPackagesShippingPackage[]
    - dimensionsDimensionsrequired
      Description
      This is a common definition of a dimension.
      - widthnumber<double>required
        Example
        18.5
        Format
        double
      - lengthnumber<double>required
        Example
        18.5
        Format
        double
      - heightnumber<double>required
        Example
        18.5
        Format
        double
      - unitstring<cm | m | in | mm>required
        Allowed
        cmminmm
    - weightWeightrequired
      Description
      Defines a common structure for representing weights.
      - valuenumber<double>required
        Format
        double
        Minimum
        0
      - unitstring<g | kg | lb>required
        Description
        Unit of measurement.
        Allowed
        gkglb
  - purchasablebooleanrequired
  - disabledboolean
    Default
    false
  - upcstring
  - feeMultiplierinteger<int32>
    Format
    int32
  - skuDimensionsDimensionsInfo[]
    Description
    This is a common definition of a sku's dimension.
    - namestringrequired
    - descriptionstring
    - widthnumber<double>required
      Example
      18.5
      Format
      double
    - lengthnumber<double>required
      Example
      18.5
      Format
      double
    - heightnumber<double>required
      Example
      18.5
      Format
      double
    - unitstring<cm | m | in | mm>required
      Allowed
      cmminmm
  - pimVariantIdstring
    Default
    N/A
- objectCreateProtectionPlanItem
  - typestringrequired
  - skuIdstring
  - namestringrequired
  - descriptionstringrequired
  - termsAndConditionsTermsAndConditionsUpdaterequired
    - UrlTermsAndConditionsUpdate
      - urlstringrequired
    - DrupalTermsAndConditionsUpdate
      - resourceDrupalResourcerequired
        NidDrupalResource
        nIdinteger<int64>required
        Format
        int64
        ResolvedDrupalResource
        Max depth limit reached
      - typestring
        Default
        DrupalTermsAndConditions
    - CloudinaryAssetUpdate
      - contentTypestring
        Example
        pdf
        Description
        The MIME type category of the asset
      - vendorstring
        Example
        Cloudinary
        Description
        The storage vendor for the asset
      - urlstring
        Description
        The URL of the asset
      - namestring
        Example
        My test file2
        Description
        Display name of the asset
      - idstring
        Example
        cloudinary-id
        Description
        Unique identifier from the vendor
      - typestringrequired
        Default
        CloudinaryAsset
  - dynamicPropertiesobject
  - purchasablebooleanrequired
  - disabledbooleanrequired
  - pimVariantIdstring
    Default
    N/A
- objectCreateServiceItem
  - typestringrequired
  - skuIdstring
  - namestringrequired
  - descriptionstringrequired
  - termsAndConditionsGeneralTermsAndConditions
    - DrupalTermsAndConditionsUpdate
      - resourceDrupalResourcerequired
        NidDrupalResource
        nIdinteger<int64>required
        Format
        int64
        ResolvedDrupalResource
        nIdinteger<int64>required
        Format
        int64
        idstringrequired
        versioninteger<int32>required
        Format
        int32
        urlstringrequired
        resolvedAtstring<date-time>required
        Format
        date-time
      - typestring
        Default
        DrupalTermsAndConditions
    - CloudinaryAssetUpdate
      - contentTypestring
        Example
        pdf
        Description
        The MIME type category of the asset
      - vendorstring
        Example
        Cloudinary
        Description
        The storage vendor for the asset
      - urlstring
        Description
        The URL of the asset
      - namestring
        Example
        My test file2
        Description
        Display name of the asset
      - idstring
        Example
        cloudinary-id
        Description
        Unique identifier from the vendor
      - typestringrequired
        Default
        CloudinaryAsset
  - dynamicPropertiesobject
  - purchasablebooleanrequired
  - disabledbooleanrequired
- objectCreateWarrantyItem
  - typestringrequired
  - descriptionstringrequired
  - disabledboolean
  - namestringrequired
  - purchasablebooleanrequired
  - skuIdstring
  - termsAndConditionsTermsAndConditionsUpdaterequired
    - UrlTermsAndConditionsUpdate
      - urlstringrequired
    - DrupalTermsAndConditionsUpdate
      - resourceDrupalResourcerequired
        NidDrupalResource
        nIdinteger<int64>required
        Format
        int64
        ResolvedDrupalResource
        Max depth limit reached
      - typestring
        Default
        DrupalTermsAndConditions
    - CloudinaryAssetUpdate
      - contentTypestring
        Example
        pdf
        Description
        The MIME type category of the asset
      - vendorstring
        Example
        Cloudinary
        Description
        The storage vendor for the asset
      - urlstring
        Description
        The URL of the asset
      - namestring
        Example
        My test file2
        Description
        Display name of the asset
      - idstring
        Example
        cloudinary-id
        Description
        Unique identifier from the vendor
      - typestringrequired
        Default
        CloudinaryAsset
  - dynamicPropertiesobject
  - pimVariantIdstring
    Default
    N/A

Responses

200

Success-product object submitted to the work-in-progress catalog.

SkuItem
- objectProductItem
  - brandnamestring
  - disabledboolean
    Default
    false
  - dynamicPropertiesobject
  - feeMultiplierinteger<int32>
    Format
    int32
  - ignoreInventoryboolean
  - manufacturerNamestring
  - mediamap<string, MediaValue>
  - namestring
  - numPiecesinteger<int32>
    Example
    2
    Format
    int32
    Minimum (exclusive)
    0
  - purchasablebooleanrequired
  - shippingMethodIdsShippingMethodId[]
  - shippingPackagesShippingPackage[]required
    - dimensionsDimensionsrequired
      Description
      This is a common definition of a dimension.
      - widthnumber<double>required
        Example
        18.5
        Format
        double
      - lengthnumber<double>required
        Example
        18.5
        Format
        double
      - heightnumber<double>required
        Example
        18.5
        Format
        double
      - unitstring<cm | m | in | mm>required
        Allowed
        cmminmm
    - weightWeightrequired
      Description
      Defines a common structure for representing weights.
      - valuenumber<double>required
        Format
        double
        Minimum
        0
      - unitstring<g | kg | lb>required
        Description
        Unit of measurement.
        Allowed
        gkglb
  - dimensionsobject
    Description
    Warning: Deprecated
    Dimensions of the SKU item (deprecated, use skuDimensions instead)
    - lengthnumber<double>required
      Description
      Length of the SKU item
      Format
      double
    - widthnumber<double>required
      Description
      Width of the SKU item
      Format
      double
    - heightnumber<double>required
      Description
      Height of the SKU item
      Format
      double
    - unitstring<cm | m | in | mm>required
      Allowed
      cmminmm
  - skuDimensionsDimensionsInfo[]required
    Description
    This is a common definition of a sku's dimension.
    - namestringrequired
    - descriptionstring
    - widthnumber<double>required
      Example
      18.5
      Format
      double
    - lengthnumber<double>required
      Example
      18.5
      Format
      double
    - heightnumber<double>required
      Example
      18.5
      Format
      double
    - unitstring<cm | m | in | mm>required
      Allowed
      cmminmm
  - skuIdSkuItemIdrequired
  - tagsstring[]
  - upcstring
  - weightWeight
    Description
    Defines a common structure for representing weights.
    - valuenumber<double>required
      Format
      double
      Minimum
      0
    - unitstring<g | kg | lb>required
      Description
      Unit of measurement.
      Allowed
      gkglb
  - pimVariantIdstring
    Description
    Product Information Management (PIM) variant ID for the SKU item
    Default
    N/A
- objectProtectionPlanItem
  - descriptionstringrequired
  - disabledbooleanrequired
  - namestringrequired
  - purchasablebooleanrequired
  - skuIdSkuItemIdrequired
  - dynamicPropertiesobject
  - termsAndConditionsTermsAndConditionsrequired
    - UrlTermsAndConditions
      - urlstringrequired
      - versioninteger<int32>
        Example
        17
        Format
        int32
      - validSincestring<date-time>
        Format
        date-time
      - typestringrequired
        Default
        UrlTermsAndConditions
    - DrupalTermsAndConditions
      - resourceDrupalResourcerequired
        NidDrupalResource
        nIdinteger<int64>required
        Format
        int64
        ResolvedDrupalResource
        Max depth limit reached
    - CloudinaryAssetUpdate
      - contentTypestring
        Example
        pdf
        Description
        The MIME type category of the asset
      - vendorstring
        Example
        Cloudinary
        Description
        The storage vendor for the asset
      - urlstring
        Description
        The URL of the asset
      - namestring
        Example
        My test file2
        Description
        Display name of the asset
      - idstring
        Example
        cloudinary-id
        Description
        Unique identifier from the vendor
      - typestringrequired
        Default
        CloudinaryAsset
- objectServiceItem
  - descriptionstringrequired
  - disabledbooleanrequired
    Default
    false
  - dynamicPropertiesobject
  - namestringrequired
  - purchasablebooleanrequired
    Default
    true
  - skuIdSkuItemIdrequired
  - termsAndConditionsGeneralTermsAndConditions
    - DrupalTermsAndConditionsUpdate
      - resourceDrupalResourcerequired
        NidDrupalResource
        nIdinteger<int64>required
        Format
        int64
        ResolvedDrupalResource
        nIdinteger<int64>required
        Format
        int64
        idstringrequired
        versioninteger<int32>required
        Format
        int32
        urlstringrequired
        resolvedAtstring<date-time>required
        Format
        date-time
      - typestring
        Default
        DrupalTermsAndConditions
    - CloudinaryAssetUpdate
      - contentTypestring
        Example
        pdf
        Description
        The MIME type category of the asset
      - vendorstring
        Example
        Cloudinary
        Description
        The storage vendor for the asset
      - urlstring
        Description
        The URL of the asset
      - namestring
        Example
        My test file2
        Description
        Display name of the asset
      - idstring
        Example
        cloudinary-id
        Description
        Unique identifier from the vendor
      - typestringrequired
        Default
        CloudinaryAsset
- objectWarrantyItem
  - descriptionstringrequired
  - disabledbooleanrequired
  - namestringrequired
  - purchasablebooleanrequired
  - skuIdstringrequired
  - dynamicPropertiesobject
  - termsAndConditionsTermsAndConditionsrequired
    - UrlTermsAndConditions
      - urlstringrequired
      - versioninteger<int32>
        Example
        17
        Format
        int32
      - validSincestring<date-time>
        Format
        date-time
      - typestringrequired
        Default
        UrlTermsAndConditions
    - DrupalTermsAndConditions
      - resourceDrupalResourcerequired
        NidDrupalResource
        nIdinteger<int64>required
        Format
        int64
        ResolvedDrupalResource
        Max depth limit reached
    - CloudinaryAssetUpdate
      - contentTypestring
        Example
        pdf
        Description
        The MIME type category of the asset
      - vendorstring
        Example
        Cloudinary
        Description
        The storage vendor for the asset
      - urlstring
        Description
        The URL of the asset
      - namestring
        Example
        My test file2
        Description
        Display name of the asset
      - idstring
        Example
        cloudinary-id
        Description
        Unique identifier from the vendor
      - typestringrequired
        Default
        CloudinaryAsset

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
- namestringrequired
- codestringrequired
- detailstring

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

404The requested resource was not found in the NoChannel system.

ErrorResponse
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

curl

curl --request PUT \
     --url https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "type": "",
     "dimensions": {
     "width": 18.5,
     "length": 18.5,
     "height": 18.5,
     "unit": ""
     },
     "weight": {
     "value": "",
     "unit": ""
     },
     "shippingPackages": [
     {
     "dimensions": {
     "width": 18.5,
     "length": 18.5,
     "height": 18.5,
     "unit": ""
     },
     "weight": {
     "value": "",
     "unit": ""
     }
     }
     ],
     "purchasable": "",
     "skuDimensions": [
     {
     "name": "",
     "width": 18.5,
     "length": 18.5,
     "height": 18.5,
     "unit": ""
     }
     ],
     "pimVariantId": "N/A"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var raw = JSON.stringify({
   "type": "",
   "dimensions": {
      "width": 18.5,
      "length": 18.5,
      "height": 18.5,
      "unit": ""
   },
   "weight": {
      "value": "",
      "unit": ""
   },
   "shippingPackages": [
      {
         "dimensions": {
            "width": 18.5,
            "length": 18.5,
            "height": 18.5,
            "unit": ""
         },
         "weight": {
            "value": "",
            "unit": ""
         }
      }
   ],
   "purchasable": "",
   "skuDimensions": [
      {
         "name": "",
         "width": 18.5,
         "length": 18.5,
         "height": 18.5,
         "unit": ""
      }
   ],
   "pimVariantId": "N/A"
});

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
   "type": "",
   "dimensions": {
      "width": 18.5,
      "length": 18.5,
      "height": 18.5,
      "unit": ""
   },
   "weight": {
      "value": "",
      "unit": ""
   },
   "shippingPackages": [
      {
         "dimensions": {
            "width": 18.5,
            "length": 18.5,
            "height": 18.5,
            "unit": ""
         },
         "weight": {
            "value": "",
            "unit": ""
         }
      }
   ],
   "purchasable": "",
   "skuDimensions": [
      {
         "name": "",
         "width": 18.5,
         "length": 18.5,
         "height": 18.5,
         "unit": ""
      }
   ],
   "pimVariantId": "N/A"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/catalog/{catalogItemId}/wip/productitem"

payload = json.dumps({
   "type": "",
   "dimensions": {
      "width": 18.5,
      "length": 18.5,
      "height": 18.5,
      "unit": ""
   },
   "weight": {
      "value": "",
      "unit": ""
   },
   "shippingPackages": [
      {
         "dimensions": {
            "width": 18.5,
            "length": 18.5,
            "height": 18.5,
            "unit": ""
         },
         "weight": {
            "value": "",
            "unit": ""
         }
      }
   ],
   "purchasable": "",
   "skuDimensions": [
      {
         "name": "",
         "width": 18.5,
         "length": 18.5,
         "height": 18.5,
         "unit": ""
      }
   ],
   "pimVariantId": "N/A"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

200

// Success-product object submitted to the work-in-progress catalog.
{}

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "",
  "code": "",
  "detail": ""
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

404

// The requested resource was not found in the NoChannel system.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}