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

126 lines
3.7 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"field_reference"
],
"title": "ShippingConfigurationSet - Data API",
"description": "Shipping configuration for a set of products in a store. This object is available in API version 59.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"IsDefault": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the shipping configuration is the default (True) or not (False). The default value is False."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Name of the shipping configuration set."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "ID of the shipping configuration owner. This field is a polymorphic relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
},
"ProcessTime": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The amount of time to process an order before it is ready to ship. The default value is 1 Day."
},
"ProcessTimeUnit": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Unit of time to process an order. Possible values are: Days Hours Weeks"
},
"TargetRecordId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "ID of the target record. This field is a relationship field.",
"relationship_name": "TargetRecord",
"relationship_type": "Lookup",
"refers_to": "WebStore"
}
},
"special_access_rules": "The ShippingConfigurationSet object is available only if the B2B Commerce or D2C Commerce license is enabled.\n\nThe ShippingConfigurationSet object is available\n only if the B2B Commerce or D2C Commerce license is enabled.",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Id": {
"field_label": "Shipping Configuration Set ID",
"type": "id",
"length": "18"
},
"IsDefault": {
"field_label": "Is Default",
"type": "boolean"
},
"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": "Shipping Profile Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"ProcessTime": {
"field_label": "Order Processing Time",
"type": "int",
"digits": "9"
},
"ProcessTimeUnit": {
"field_label": "Unit of Order Processing Time",
"type": "picklist",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"TargetRecordId": {
"field_label": "Store ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}