{"_id":"5a96ec9689442e002041119d","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-24T16:58:44.197Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":54,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"3-0\": \"`sku-type`\",\n    \"3-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"3-3\": \"SKU type:\\n  * **PHYSICAL**\\n  * **DIGITAL**\",\n    \"h-4\": \"Description\",\n    \"3-2\": \"**Required**\",\n    \"8-0\": \"`sku-effective-dates`\",\n    \"8-1\": \"container\",\n    \"8-2\": \"Optional\",\n    \"8-3\": \"Container of [sku-effective-dates](doc:sku-effective-dates) properties.\",\n    \"0-0\": \"`contract-name`\",\n    \"0-1\": \"*string*\",\n    \"0-3\": \"Contract's name. If no value was given when creating a SKU, the default name is \\\"Full Version\\\".\",\n    \"0-2\": \"Optional\",\n    \"1-3\": \"ID of the product containing the SKU.\",\n    \"1-2\": \"**Required**\",\n    \"1-0\": \"`product-id`\",\n    \"1-1\": \"*long*\",\n    \"2-0\": \"`sku-status`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Status of the SKU:\\n  * **A** - Active\\n  * **I** - Inactive\\n  * **D** - Deleted\",\n    \"4-0\": \"`pricing-settings`\",\n    \"4-1\": \"container\",\n    \"4-2\": \"**Required**\",\n    \"4-3\": \"Container of [pricing-settings](doc:pricing-settings) properties.\",\n    \"5-1\": \"*string*\",\n    \"5-0\": \"`sku-image`\",\n    \"5-3\": \"SKU image file name (assuming the file is already uploaded).\",\n    \"5-2\": \"Optional\",\n    \"6-0\": \"`sku-quantity-policy`\",\n    \"6-3\": \"Container of [sku-quantity-policy](doc:sku-quantity-policy) properties.\",\n    \"6-1\": \"container\",\n    \"6-2\": \"Optional\",\n    \"7-0\": \"`collect-shipping-address`\",\n    \"7-1\": \"*boolean*\",\n    \"7-2\": \"Optional\",\n    \"7-3\": \"Indicates whether shipping contact information should be collected.\",\n    \"9-0\": \"`sku-coupon-settings`\",\n    \"10-0\": \"`sku-custom-parameters`\",\n    \"9-1\": \"container\",\n    \"10-1\": \"container\",\n    \"9-2\": \"Optional\",\n    \"10-2\": \"Optional\",\n    \"9-3\": \"Container of [sku-coupon-settings](doc:sku-coupon-settings) properties.\",\n    \"10-3\": \"Container of [sku-custom-parameters](doc:sku-custom-parameters) properties.\"\n  },\n  \"cols\": 4,\n  \"rows\": 11\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`contract-name`\",\n    \"1-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n    \"h-4\": \"Description\",\n    \"1-2\": \"Contract's name. If no value was given when creating a SKU, the default name is \\\"Full Version\\\".\",\n    \"4-0\": \"`sku-type`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"SKU type:\\n  * **PHYSICAL**\\n  * **DIGITAL**\",\n    \"2-0\": \"`product-id`\",\n    \"3-0\": \"`sku-status`\",\n    \"2-1\": \"*long*\",\n    \"3-1\": \"*string*\",\n    \"2-2\": \"ID of the product containing the SKU.\",\n    \"3-2\": \"Status of the SKU:\\n  * **A** - Active\\n  * **I** - Inactive\\n  * **D** - Deleted\",\n    \"0-0\": \"`sku-name`\",\n    \"0-1\": \"*string*\",\n    \"5-0\": \"`pricing-settings`\",\n    \"6-0\": \"`sku-image`\",\n    \"7-0\": \"`sku-buynow-urls`\",\n    \"8-0\": \"`sku-quantity-policy`\",\n    \"9-0\": \"`collect-shipping-address`\",\n    \"10-0\": \"`sku-effective-dates`\",\n    \"11-0\": \"`sku-coupon-settings`\",\n    \"12-0\": \"`sku-custom-parameters`\",\n    \"6-1\": \"*string*\",\n    \"9-1\": \"*boolean*\",\n    \"5-1\": \"container\",\n    \"7-1\": \"container\",\n    \"8-1\": \"container\",\n    \"10-1\": \"container\",\n    \"11-1\": \"container\",\n    \"12-1\": \"container\",\n    \"0-2\": \"SKU name is returned as \\\"{product name} -\",\n    \"5-2\": \"Container of [pricing-settings](doc:pricing-settings) properties.\",\n    \"6-2\": \"SKU image file name (assuming the file is already uploaded).\",\n    \"8-2\": \"Container of [sku-quantity-policy](doc:sku-quantity-policy) properties.\",\n    \"9-2\": \"Indicates whether shipping contact information should be collected.\",\n    \"10-2\": \"Container of [sku-effective-dates](doc:sku-effective-dates) properties.\",\n    \"11-2\": \"Container of [sku-coupon-settings](doc:sku-coupon-settings) properties.\",\n    \"12-2\": \"Container of [sku-custom-parameters](doc:sku-custom-parameters) properties.\",\n    \"7-2\": \"Container of [sku-buynow-urls](doc:sku-buynow-urls) properties.\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]","excerpt":"","slug":"catalog-sku","type":"basic","title":"catalog-sku"}

Request

Property Name
Type
Required
Description

contract-name

string

Optional

Contract's name. If no value was given when creating a SKU, the default name is "Full Version".

product-id

long

Required

ID of the product containing the SKU.

sku-status

string

Optional

Status of the SKU:

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

sku-type

string

Required

SKU type:

  • PHYSICAL
  • DIGITAL

pricing-settings

container

Required

Container of pricing-settings properties.

sku-image

string

Optional

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

sku-quantity-policy

container

Optional

Container of sku-quantity-policy properties.

collect-shipping-address

boolean

Optional

Indicates whether shipping contact information should be collected.

sku-effective-dates

container

Optional

Container of sku-effective-dates properties.

sku-coupon-settings

container

Optional

Container of sku-coupon-settings properties.

sku-custom-parameters

container

Optional

Container of sku-custom-parameters properties.

Response

Property Name
Type
Description

sku-name

string

SKU name is returned as "{product name} -

contract-name

string

Contract's name. If no value was given when creating a SKU, the default name is "Full Version".

product-id

long

ID of the product containing the SKU.

sku-status

string

Status of the SKU:

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

sku-type

string

SKU type:

  • PHYSICAL
  • DIGITAL

pricing-settings

container

Container of pricing-settings properties.

sku-image

string

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

sku-buynow-urls

container

Container of sku-buynow-urls properties.

sku-quantity-policy

container

Container of sku-quantity-policy properties.

collect-shipping-address

boolean

Indicates whether shipping contact information should be collected.

sku-effective-dates

container

Container of sku-effective-dates properties.

sku-coupon-settings

container

Container of sku-coupon-settings properties.

sku-custom-parameters

container

Container of sku-custom-parameters properties.