{"_id":"5a96ec9789442e00204111df","category":{"_id":"5a96ec9189442e0020411156","version":"5a96ec9189442e002041114d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5a96ec9189442e002041114d","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-02-28T17:53:21.809Z","releaseDate":"2018-02-28T17:53:21.809Z","categories":["5a96ec9189442e002041114e","5a96ec9189442e002041114f","5a96ec9189442e0020411150","5a96ec9189442e0020411151","5a96ec9189442e0020411152","5a96ec9189442e0020411153","5a96ec9189442e0020411154","5a96ec9189442e0020411155","5a96ec9189442e0020411156","5a96ec9189442e0020411157","5a96ec9189442e0020411158"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.24.2 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-27T19:55:07.897Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":120,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`product-status`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Status of the product:\\n  * **A** - Active\\n  * **I** - Inactive\\n  * **D** - Deleted\",\n    \"0-2\": \"Optional\",\n    \"1-0\": \"`product-name`\",\n    \"1-3\": \"Product name.\",\n    \"1-2\": \"**Required**\",\n    \"1-1\": \"*string*\",\n    \"2-0\": \"`product-short-description`\",\n    \"3-0\": \"`product-long-description`\",\n    \"4-0\": \"`product-info-url`\",\n    \"5-0\": \"`product-image`\",\n    \"6-0\": \"`product-merchant-descriptor`\",\n    \"7-0\": \"`product-support-email`\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"4-1\": \"*string*\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"Optional\",\n    \"6-2\": \"Optional\",\n    \"5-2\": \"Optional\",\n    \"4-2\": \"Optional\",\n    \"3-2\": \"Optional\",\n    \"2-2\": \"**Required** for Create Product; Optional for Update Product\",\n    \"2-3\": \"Product short description.\",\n    \"3-3\": \"Product long description.\",\n    \"4-3\": \"Product info URL.\",\n    \"5-3\": \"Product image file name (assuming the file is already uploaded).\",\n    \"6-3\": \"Product merchant descriptor.\",\n    \"7-3\": \"Product support email.\"\n  },\n  \"cols\": 4,\n  \"rows\": 8\n}\n[/block]\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`product-status`\",\n    \"1-0\": \"`product-name`\",\n    \"0-1\": \"*string*\",\n    \"1-1\": \"*string*\",\n    \"0-2\": \"Status of the product:\\n  * **A** - Active\\n  * **I** - Inactive\\n  * **D** - Deleted\",\n    \"1-2\": \"Product name.\",\n    \"2-0\": \"`product-short-description`\",\n    \"3-0\": \"`product-long-description`\",\n    \"4-0\": \"`product-info-url`\",\n    \"5-0\": \"`product-image`\",\n    \"6-0\": \"`product-merchant-descriptor`\",\n    \"7-0\": \"`product-support-email`\",\n    \"8-0\": \"`product-skus`\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"4-1\": \"*string*\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"7-1\": \"*string*\",\n    \"8-1\": \"container\",\n    \"2-2\": \"Product short description.\",\n    \"3-2\": \"Product long description.\",\n    \"4-2\": \"Product info URL.\",\n    \"5-2\": \"Product image file name (assuming the file is already uploaded).\",\n    \"6-2\": \"Product merchant descriptor.\",\n    \"7-2\": \"Product support email.\",\n    \"8-2\": \"Container of [product-skus](doc:product-skus) properties.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]","excerpt":"","slug":"product","type":"basic","title":"product"}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

product

Request

Property Name
Type
Required
Description

product-status

string

Optional

Status of the product:

  • A - Active
  • I - Inactive
  • D - Deleted

product-name

string

Required

Product name.

product-short-description

string

Required for Create Product; Optional for Update Product

Product short description.

product-long-description

string

Optional

Product long description.

product-info-url

string

Optional

Product info URL.

product-image

string

Optional

Product image file name (assuming the file is already uploaded).

product-merchant-descriptor

string

Optional

Product merchant descriptor.

product-support-email

string

Optional

Product support email.

Response

Property Name
Type
Description

product-status

string

Status of the product:

  • A - Active
  • I - Inactive
  • D - Deleted

product-name

string

Product name.

product-short-description

string

Product short description.

product-long-description

string

Product long description.

product-info-url

string

Product info URL.

product-image

string

Product image file name (assuming the file is already uploaded).

product-merchant-descriptor

string

Product merchant descriptor.

product-support-email

string

Product support email.

product-skus

container

Container of product-skus properties.