Merchant API

Upload Product Data

Update product and alias details for the specified product SKU. <br/><br/> Note: The SKU you use to lookup the product can be either a Master SKU in CartRover, or an alias code. Either match will update and return the product result. If no match is found, an error is returned.

Note: This endpoint can not currently create a new product. Only update existing ones. To create a new product, call Update Inventory which will create a new product if the SKU passed is new.

Request

Array Request Fields

Field NameData TypeLengthRequired?Description
nameString150NProduct Name
descriptionLong TextNProduct Description
retail_priceFloatRetail Price
wholesale_priceStringWholesale Price
weight_lbsFloatProduct Weight (In LBS)
wms_product_main_idString45NID of Product in WMS System
warehouse_product_typeString45NProduct Type in WMS System
parent_skuString45NIf this item is a variant, provide the parent SKU it belongs under
aliasesArrayNArray containing list of Aliases to Add/Update
extra_fieldsArrayNArray containing additional custom fields to save with this product

Aliases Array Fields

  • Array Key: Alias Type Name. Eg. UPC, EAN, CUSTOM_ALIAS_TYPE
  • Array Value: Alias Value. Must be Unique across all products.
    • Pass NULL to remove specified Alias Type from the product's Alias list.
    • You may also pass an array of values to load multiple values for the same key.
    • Any previous values for the given key will be removed

Extra Fields Array Fields

  • Array Key: Extra Field Name: Eg. supplier_code, tags
  • Array Value: Extra Field Value.

List of standard Extra Fields:

If using these Extra Field Names, CartRover can sync full product details with any Order Source that supports Product Detail Sync.

  • brand
  • buy_price
  • categories - json encoded array
  • image_url
    • For multiple images you can also use image_url_X, where X starts at 1.
  • image_name
    • Optional field if image_url doesn't include a useful name. Note, each cart will decide whether or not it needs to use the separate name.
    • For multiple images you can also use image_name_X, where X starts at 1.
  • product_type
  • supplier_code
  • tags - json encoded array
  • parent_name
    • Parent product name from WMS
  • parent_id
    • Parent product id from WMS
  • attribute_names - json encoded array of the attributes that make up this product. eg: [ "color", "size", "fabric" ]
    • Each attribute name/value should also be saved as a product extra field. Example below:
    • { "extra_fields": {"attribute_names": [ "color", "size", "fabric" ], "color": "red", "size": "large", "fabric": "silk"} }
  • country_of_manufacture
  • sort_order - Use to provide preferred sort order of variants. Lowest sort comes first.
  • min_order_qty
  • ship_within_days - How many days will the warehouse guarantee to ship this item within? Int
  • returns_allowed - true, false
  • warranty - Provide Warranty text
  • ca_prop_65 - Provide CA Prop 65 text
  • status
    • Allowed values: active, disabled

Marketplace Specific Fields

Ebay

Joor

  • joor_category_id
    • JSON array of IDs. Eg: [123,987]
    • If not passed, the above categories list will be used instead and matched using the closest name in Joor.

Response Fields - Same as Get Product Data

FieldData TypeLengthDescription
skuString45Always provided
nameString150Name if known
descriptionLong TextDescription if known
retail_priceFloat
wholesale_priceFloat
weight_lbsFloat
wms_product_main_idStringOptional additional identifier provided by warehouse
last_updated_datetimeTimestampTime product data last changed
aliasesArrayList of aliases for this product

Alias Fields

FieldData TypeLengthDescription
code_typeString45Code type name. Eg: UPC
codeString45Alias code value
post/v1/merchant/product/{SKU}

Request

Path parameters

SKUstring required

Headers

Content-Typestring

Request body */*

string required

Example request

"\"{\\n    \\\"name\\\": \\\"Test Product\\\",\\n    \\\"description\\\": \\\"It's a wonderful product\\\",\\n    \\\"retail_price\\\": 11,\\n    \\\"wholesale_price\\\": null,\\n    \\\"weight_lbs\\\": null,\\n    \\\"wms_product_main_id\\\": null,\\n    \\\"aliases\\\": {\\n        \\\"UPC\\\": \\\"123456789012\\\",\\n        \\\"ASIN\\\": [\\n            \\\"DEFG98742SP\\\",\\n            \\\"DEFG98742SS\\\"\\n        ]\\n    },\\n    \\\"extra_fields\\\": {\\n        \\\"field_1\\\": \\\"Whatever\\\",\\n        \\\"field_2\\\": null,\\n        \\\"slogan\\\": \\\"Baby, you've got a stew going\\\"\\n    }\\n}\""

Response

OK

object required

Changes

No recorded changes to this operation across all 1 revision of this API.