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

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "OrderStatus - Data API",
  "description": "Represents the status of the order entity. This object is available in API version 48.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "ApiName": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "Uniquely identifies a picklist value so it can be retrieved without using an id or primary label."
    },
    "IsDefault": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether this is the default order status value (true) or not (false) in the picklist."
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Master label for this order status value. This display value is the internal label that doesn’t get translated."
    },
    "SortOrder": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Number used to sort this value in the order status picklist. These numbers aren’t guaranteed to be sequential, as some previous contract status values might have been deleted."
    },
    "StatusCode": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Status of the order. Possible values are: Activated Draft Superseded-This value is applicable only to Revenue Cloud Advanced users and is available in API version 64.0 and later."
    }
  },
  "usage": "This object represents a value in the order status picklist. The order status picklist provides additional information about the status of an Order, such as its current state (Draft, Activated, or Superseded). You can query these records to retrieve the set of values in the order status picklist, and then use that information while processing Order objects to determine more information about a given order. For example, the application could test whether a given order is activated based on its Status value and the value of the StatusCode property in the associated OrderStatus object.",
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<complexType name=\"OrderStatus\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ApiName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"IsDefault\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SortOrder\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"StatusCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "ApiName": {
      "field_label": "API Name",
      "type": "string",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Order Status Value ID",
      "type": "id",
      "length": "18"
    },
    "IsDefault": {
      "field_label": "Is Default",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Master Label",
      "type": "string",
      "length": "255"
    },
    "SortOrder": {
      "field_label": "Sort Order",
      "type": "int",
      "digits": "9"
    },
    "StatusCode": {
      "field_label": "Status Code",
      "type": "picklist",
      "length": "40"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}