Create Catalog Items

1 min

POST

https://api.upstartcommerce.com/v1/catalog/import

This endpoint provides the ability to create multiple catalog entities at once.

Authorized permissions:

catalog.create

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

bodyCreateCatalogItem[]required
- activationDatestring<date-time>
  Format
  date-time
- brandNamestring
- deactivationDatestring<date-time>
  Format
  date-time
- dynamicPropertiesobject
- hiddenboolean
  Default
  false
- idCatalogItemId
- ignoreInventoryboolean
  Default
  false
- manufacturerNamestring
- mediamap<string, MediaValue>
- namestringrequired
- offeredStandardWarrantyGeneralTermsAndConditions
  - 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
- offeredWarrantyIdCatalogItemId
- offeredProtectionPlanTypeOfferedProtectionPlanType
  - DmOfferedProtectionPlanType
    - typestring<DenverMattress>required
      Allowed
      DenverMattress
  - StandardOfferedProtectionPlanType
    - typestring<Standard>required
      Allowed
      Standard
    - idstringrequired
- serviceQualificationServiceQualification
  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.
  - eligibleProductIdsCatalogItemId[]
    Description
    Lists products this service can be bought for. If empty, buying of the service is not tight to any product.
  - eligibleShippingMethodIdsShippingMethodId[]
    Description
    Lists shipping methods this service can be bought for. If empty, buying of the service is not tight to any shipping method.
- productItemsCreateSkuItem[]
  - CreateProductItem
    - 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
  - CreateProtectionPlanItem
    - typestringrequired
    - skuIdstring
    - namestringrequired
    - descriptionstringrequired
    - termsAndConditionsTermsAndConditionsUpdaterequired
      - UrlTermsAndConditionsUpdate
        urlstringrequired
      - DrupalTermsAndConditionsUpdate
        Max depth limit reached
      - CloudinaryAssetUpdate
        Max depth limit reached
    - dynamicPropertiesobject
    - purchasablebooleanrequired
    - disabledbooleanrequired
    - pimVariantIdstring
      Default
      N/A
  - CreateServiceItem
    - typestringrequired
    - skuIdstring
    - namestringrequired
    - descriptionstringrequired
    - termsAndConditionsGeneralTermsAndConditions
      - DrupalTermsAndConditionsUpdate
        Max depth limit reached
      - CloudinaryAssetUpdate
        Max depth limit reached
    - dynamicPropertiesobject
    - purchasablebooleanrequired
    - disabledbooleanrequired
  - CreateWarrantyItem
    - typestringrequired
    - descriptionstringrequired
    - disabledboolean
    - namestringrequired
    - purchasablebooleanrequired
    - skuIdstring
    - termsAndConditionsTermsAndConditionsUpdaterequired
      - UrlTermsAndConditionsUpdate
        Max depth limit reached
      - DrupalTermsAndConditionsUpdate
        Max depth limit reached
      - CloudinaryAssetUpdate
        Max depth limit reached
    - dynamicPropertiesobject
    - pimVariantIdstring
      Default
      N/A
- relatedIdsCatalogItemId[]
- seoSeo
  - pageTitlestring
  - descriptionstring
  - metaKeywordsstring[]
- shippingMethodIdsShippingMethodId[]required
- siteIdsSiteId[]required
- tagsstring[]
- taxCodestring
- typeIdCatalogItemTypeIdrequired
  Example
  FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318
  Description
  Unique identifier for the catalog item type. This must be an id of an existing catalog item type.
- excludesClearanceItemsboolean

Responses

201

Success-resources created.

CatalogItemSummary[]
- idCatalogItemIdrequired
- activationDatestring<date-time>
  Format
  date-time
- archivedboolean
  Default
  false
- avgRatingnumber<double>
  Format
  double
- avgGroupRatingnumber<double>
  Format
  double
- excludesClearanceItemsboolean
- brandNamestring
- deactivationDatestring<date-time>
  Format
  date-time
- dynamicPropertiesobjectrequired
- hiddenbooleanrequired
  Default
  false
- ignoreInventorybooleanrequired
  Default
  false
- liveDatestring<date-time>
  Format
  date-time
- manufacturerNamestring
- mediamap<string, MediaValue>
- modifiedDatestring<date-time>
  Format
  date-time
- namestringrequired
- numReviewsinteger<int32>
  Format
  int32
- numGroupReviewsinteger<int32>
  Format
  int32
- offeredStandardWarrantyGeneralTermsAndConditions
  - 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
- offeredWarrantyIdCatalogItemId
- offeredProtectionPlanTypeOfferedProtectionPlanType
  - DmOfferedProtectionPlanType
    - typestring<DenverMattress>required
      Allowed
      DenverMattress
  - StandardOfferedProtectionPlanType
    - typestring<Standard>required
      Allowed
      Standard
    - idstringrequired
- productItemsSkuItemSummary[]required
  - ProductItemSummary
    - brandNamestring
    - dimensionsDimensions
      Description
      Warning: Deprecated
      Dimensions of the product item (deprecated, use skuDimensions instead)
      - 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
    - disabledboolean
      Default
      false
    - dynamicPropertiesobject
    - ignoreInventoryboolean
    - manufactureNamestring
    - mediamap<string, MediaValue>
    - namestring
      Description
      Name for the product item.
    - numPiecesinteger<int32>
      Format
      int32
      Minimum (exclusive)
      0
    - pricingPricing
      - currencystringrequired
        Example
        USD
        Pattern
        ^[A-Z]{3}$
      - pricenumberrequired
    - purchasablebooleanrequired
      Default
      true
    - 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
    - skuIdSkuItemIdrequired
    - tagsstring[]
    - 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
    - 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
  - ProtectionPlanItemSummary
    - descriptionstringrequired
    - disabledbooleanrequired
    - namestringrequired
    - purchasablebooleanrequired
    - skuIdstringrequired
    - dynamicPropertiesobject
    - pricingPricing
      - currencystringrequired
        Example
        USD
        Pattern
        ^[A-Z]{3}$
      - pricenumberrequired
    - typestring<bundle | product | protectionPlan | service | warranty | fee>required
      Default
      protectionPlan
      Allowed
      bundleproductprotectionPlanservicewarrantyfee
    - termsAndConditionsTermsAndConditionsrequired
      - UrlTermsAndConditions
        urlstringrequired
        versioninteger<int32>
        Example
        17
        Format
        int32
        validSincestring<date-time>
        Format
        date-time
        typestringrequired
        Default
        UrlTermsAndConditions
      - DrupalTermsAndConditions
        Max depth limit reached
      - CloudinaryAssetUpdate
        Max depth limit reached
  - ServiceItemSummary
    - descriptionstringrequired
    - disabledboolean
      Default
      false
    - dynamicPropertiesobject
    - namestringrequired
    - pricingPricing
      - currencystringrequired
        Example
        USD
        Pattern
        ^[A-Z]{3}$
      - pricenumberrequired
    - purchasablebooleanrequired
      Default
      true
    - skuIdSkuItemIdrequired
    - termsAndConditionsGeneralTermsAndConditions
      - DrupalTermsAndConditionsUpdate
        Max depth limit reached
      - CloudinaryAssetUpdate
        Max depth limit reached
    - typestring<product | protectionPlan | service | warranty>required
      Default
      service
      Allowed
      productprotectionPlanservicewarranty
  - WarrantyItemSummary
    - descriptionstringrequired
    - disabledbooleanrequired
    - namestringrequired
    - purchasablebooleanrequired
    - skuIdstringrequired
    - termsAndConditionsTermsAndConditionsrequired
      - UrlTermsAndConditions
        Max depth limit reached
      - DrupalTermsAndConditions
        Max depth limit reached
      - CloudinaryAssetUpdate
        Max depth limit reached
    - dynamicPropertiesobject
    - pricingPricing
      - Max depth limit reached
    - typestring<bundle | product | protectionPlan | service | warranty | fee>required
      Default
      warranty
      Allowed
      bundleproductprotectionPlanservicewarrantyfee
- productPopularitynumber<double>
  Format
  double
- productPopularityBySitemap<string, number>
  Description
  Per-site popularity values, keyed by site id. A site absent from this map has no popularity value set yet.
- relatedIdsCatalogItemId[]required
- seoSeo
  - pageTitlestring
  - descriptionstring
  - metaKeywordsstring[]
- serviceQualificationServiceQualification
  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.
  - eligibleProductIdsCatalogItemId[]
    Description
    Lists products this service can be bought for. If empty, buying of the service is not tight to any product.
  - eligibleShippingMethodIdsShippingMethodId[]
    Description
    Lists shipping methods this service can be bought for. If empty, buying of the service is not tight to any shipping method.
- shippingMethodIdsShippingMethodId[]required
- siteIdsSiteId[]required
- subVersioninteger<int32>
  Default
  0
  Format
  int32
- tagsstring[]
- taxCodestring
- typestring<product | protectionPlan | service | warranty>required
  Allowed
  productprotectionPlanservicewarranty
- typeIdCatalogItemTypeIdrequired
  Example
  FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318
  Description
  Unique identifier for the catalog item type. This must be an id of an existing catalog item type.
- typeNamestringrequired
- versioninteger<int32>required
  Default
  0
  Format
  int32
- productLineIdsstring[]
- collectionIdsstring[]

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

curl

curl --request POST \
     --url https://api.upstartcommerce.com/v1/catalog/import \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '[
     {
     "name": "",
     "offeredStandardWarranty": {
     "resource": {
     "nId": ""
     },
     "type": "DrupalTermsAndConditions"
     },
     "offeredProtectionPlanType": {
     "type": ""
     },
     "productItems": {
     "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"
     },
     "shippingMethodIds": [],
     "siteIds": [],
     "typeId": "FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318"
     }
     ]'

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([
   {
      "name": "",
      "offeredStandardWarranty": {
         "resource": {
            "nId": ""
         },
         "type": "DrupalTermsAndConditions"
      },
      "offeredProtectionPlanType": {
         "type": ""
      },
      "productItems": {
         "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"
      },
      "shippingMethodIds": [],
      "siteIds": [],
      "typeId": "FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318"
   }
]);

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

fetch("https://api.upstartcommerce.com/v1/catalog/import", 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/import")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump([
   {
      "name": "",
      "offeredStandardWarranty": {
         "resource": {
            "nId": ""
         },
         "type": "DrupalTermsAndConditions"
      },
      "offeredProtectionPlanType": {
         "type": ""
      },
      "productItems": {
         "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"
      },
      "shippingMethodIds": [],
      "siteIds": [],
      "typeId": "FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318"
   }
])

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

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/catalog/import"

payload = json.dumps([
   {
      "name": "",
      "offeredStandardWarranty": {
         "resource": {
            "nId": ""
         },
         "type": "DrupalTermsAndConditions"
      },
      "offeredProtectionPlanType": {
         "type": ""
      },
      "productItems": {
         "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"
      },
      "shippingMethodIds": [],
      "siteIds": [],
      "typeId": "FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318"
   }
])
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

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

print(response.text)

201

// Success-resources created.
[
  {
    "id": "",
    "activationDate": "",
    "archived": false,
    "avgRating": "",
    "avgGroupRating": "",
    "excludesClearanceItems": false,
    "brandName": "",
    "deactivationDate": "",
    "dynamicProperties": {},
    "hidden": false,
    "ignoreInventory": false,
    "liveDate": "",
    "manufacturerName": "",
    "media": "",
    "modifiedDate": "",
    "name": "",
    "numReviews": "",
    "numGroupReviews": "",
    "offeredStandardWarranty": {},
    "offeredWarrantyId": "",
    "offeredProtectionPlanType": {},
    "productItems": {},
    "productPopularity": "",
    "productPopularityBySite": "",
    "relatedIds": [
      ""
    ],
    "seo": {
      "pageTitle": "",
      "description": "",
      "metaKeywords": [
        ""
      ]
    },
    "serviceQualification": {
      "eligibleProductIds": [
        ""
      ],
      "eligibleShippingMethodIds": [
        ""
      ]
    },
    "shippingMethodIds": [
      ""
    ],
    "siteIds": [
      ""
    ],
    "subVersion": "",
    "tags": [
      ""
    ],
    "taxCode": "",
    "type": "",
    "typeId": "FA1F5DC8-E4FB-415F-BDD8-8E6F0AD43318",
    "typeName": "",
    "version": "",
    "productLineIds": [
      ""
    ],
    "collectionIds": [
      ""
    ]
  }
]

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": ""
}