afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ProductAttribute.json

110 lines
3.3 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"field_reference"
],
"title": "ProductAttribute - Data API",
"description": "Represents the attributes that can be associated with a product. This object is available in API version 50.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The default value is USD. Possible values are: USD—U.S. Dollar"
},
"Name": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "Name of the product attribute set."
},
"ProductId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The ID of the product that the attribute is associated with. This field is unique within your organization."
},
"Sequence": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The order that product attributes appear in."
},
"VariantParentId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the variation parent record associated with the product attribute."
}
},
"special_access_rules": "You must have the B2B Commerce license and a CMS workspace to access products.",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **ProductAttributeEvent (API version 55.0)**: Change events are available for the object.",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"Id": {
"field_label": "Product Attribute ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"Name": {
"field_label": "Product Attribute Name",
"type": "string",
"length": "255"
},
"ProductId": {
"field_label": "Product ID",
"type": "reference",
"length": "18"
},
"Sequence": {
"field_label": "Sequence",
"type": "int",
"digits": "9"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"VariantParentId": {
"field_label": "Product ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}