Jump to

• Request
• Response
• Examples

Get a sales product

get

/services/rest/connect/v1.4/salesProducts/{id}

Request

Path Parameters

• id(required): integer
  The unique identifier of the sales product.

Back to Top

Response

Default Response

Body ()

Root Schema : salesProducts

Type: object

The items or services sold by an organization. Sales products are available to customers through quotes and promotions.

Show Source

• acceptCount: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of times an offer for the sales product was accepted through offer advisor.
• adminVisibleInterfaces: object namedIDs-salesProducts-adminVisibleInterfaces
  The named ID that can be included in a list.
• attributes: object salesProducts-attributes
  The information about a product, whether it has a serial number, is disabled, and is of type Sales or Service.
• createdTime: string
  The date and time when the sales product was created. This attribute is read-only.
• descriptions: object salesProducts-descriptions
  The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The display position of the sales product within the folder list in the product catalog.
• excludeFromOfferAdvisor: boolean
  Indicates whether the product is excluded from the offer advisor. This attribute does not have a default value.
• folder: object salesProducts-folder
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the sales product.
• lookupName: string
  Maximum Length: 255

  The name used to look up the sales product.
• name: string
  Maximum Length: 80

  The name of the product in the language of the current interface. This attribute is read-only.
• names: object salesProducts-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
• partNumber: [ "string", "null" ]
  Maximum Length: 40

  Pattern: ^[^ ^|]*$

  The text string which identifies the product. For example, stock keeping unit (SKU) or model number.
• respondCount: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of times the product was offered through the offer advisor.
• schedules: object salesProducts-schedules
  The price schedule for a sales product.
• serviceProduct: [ "object", "null" ]
  The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime: string
  The date and time when the sales product was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The items or services sold by an organization. Sales products are available to customers through quotes and promotions.",
    "properties":{
        "serviceProduct":{
            "type":[
                "object",
                "null"
            ],
            "description":"The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the sales product was last updated. This attribute is read-only."
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/salesProducts-names"
        },
        "name":{
            "type":"string",
            "description":"The name of the product in the language of the current interface. This attribute is read-only.",
            "maxLength":"80"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the sales product.",
            "maxLength":"255"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the sales product.",
            "maximum":"9223372036854776000"
        },
        "respondCount":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of times the product was offered through the offer advisor.",
            "maximum":"2147483647"
        },
        "descriptions":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of descriptions, one for each supported language.",
            "$ref":"#/definitions/salesProducts-descriptions"
        },
        "acceptCount":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of times an offer for the sales product was accepted through offer advisor.",
            "maximum":"2147483647"
        },
        "schedules":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of associated price schedules.",
            "$ref":"#/definitions/salesProducts-schedules"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the sales product was created. This attribute is read-only."
        },
        "attributes":{
            "type":"object",
            "description":"The sales product options such as Disabled, Sales, Service, and HasSerialNumber.",
            "$ref":"#/definitions/salesProducts-attributes"
        },
        "partNumber":{
            "pattern":"^[^\n^|]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The text string which identifies the product. For example, stock keeping unit (SKU) or model number.",
            "maxLength":"40"
        },
        "adminVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the sales product is visible.",
            "$ref":"#/definitions/namedIDs-salesProducts-adminVisibleInterfaces"
        },
        "folder":{
            "type":[
                "object",
                "null"
            ],
            "description":"The product catalog folder in which the sales product is present.",
            "$ref":"#/definitions/salesProducts-folder"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The display position of the sales product within the folder list in the product catalog.",
            "maximum":"2147483647"
        },
        "excludeFromOfferAdvisor":{
            "type":"boolean",
            "description":"Indicates whether the product is excluded from the offer advisor. This attribute does not have a default value."
        }
    }
}

Nested Schema : namedIDs-salesProducts-adminVisibleInterfaces

Type: object

The named ID that can be included in a list.

Show Source

• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the object. This is the key for the list entry.
• lookupName: string
  Maximum Length: 255

  The name used to look up the object.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the object. This is the key for the list entry.",
            "maximum":"9223372036854776000"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":"255"
        }
    }
}

Nested Schema : salesProducts-attributes

Type: object

The information about a product, whether it has a serial number, is disabled, and is of type Sales or Service.

Show Source

• disabled: boolean
  Indicates whether the product is temporarily disabled and will not be displayed. The default value is false.
• hasSerialNumber: boolean
  Indicates whether the product has a serial number. The default value is false.
• isSalesProduct: boolean
  Indicates whether the product is a sales product. The default value is true.
• isServiceProduct: boolean
  Indicates whether the product is a service product. The default value is false.

{
    "type":"object",
    "description":"The information about a product, whether it has a serial number, is disabled, and is of type Sales or Service.",
    "properties":{
        "disabled":{
            "type":"boolean",
            "description":"Indicates whether the product is temporarily disabled and will not be displayed. The default value is false."
        },
        "hasSerialNumber":{
            "type":"boolean",
            "description":"Indicates whether the product has a serial number. The default value is false."
        },
        "isSalesProduct":{
            "type":"boolean",
            "description":"Indicates whether the product is a sales product. The default value is true."
        },
        "isServiceProduct":{
            "type":"boolean",
            "description":"Indicates whether the product is a service product. The default value is false."
        }
    }
}

Nested Schema : salesProducts-descriptions

Type: object

The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.

Show Source

• labelText: [ "string", "null" ]
  Maximum Length: 1333

  The label text.
• language: object namedIDs-salesProducts-descriptions-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":[
                "string",
                "null"
            ],
            "description":"The label text.",
            "maxLength":"1333"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-salesProducts-descriptions-language"
        }
    }
}

Nested Schema : salesProducts-folder

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 1

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object
• parents: object salesProducts-folder-parents
  NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "parents":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"List of the parents of the entry, in order from root to immediate parent",
            "$ref":"#/definitions/salesProducts-folder-parents"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : salesProducts-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText: string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language: object namedIDs-salesProducts-names-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":"80"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-salesProducts-names-language"
        }
    }
}

Nested Schema : salesProducts-schedules

Type: object

The price schedule for a sales product.

Show Source

• comment: [ "string", "null" ]
  Maximum Length: 1333

  The comments or notes associated with the sales product schedule.
• price: object salesProducts-schedules-price
  The monetary value that consists of currency, exchange rate, and value.
• schedule: object namedIDs-salesProducts-schedules-schedule
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• scheduleEndDate: [ "string", "null" ]
  The date when the schedule ends.
• scheduleStartDate: string
  The date when the schedule starts. This is part of the key for the list entry.

{
    "type":"object",
    "description":"The price schedule for a sales product.",
    "properties":{
        "comment":{
            "type":[
                "string",
                "null"
            ],
            "description":"The comments or notes associated with the sales product schedule.",
            "maxLength":"1333"
        },
        "scheduleStartDate":{
            "type":"string",
            "description":"The date when the schedule starts. This is part of the key for the list entry."
        },
        "price":{
            "type":"object",
            "description":"The price of the product in the schedule.",
            "$ref":"#/definitions/salesProducts-schedules-price"
        },
        "scheduleEndDate":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date when the schedule ends."
        },
        "schedule":{
            "type":"object",
            "description":"The ID of the schedule. This is part of the key for the list entry.",
            "$ref":"#/definitions/namedIDs-salesProducts-schedules-schedule"
        }
    }
}

Nested Schema : namedIDs-salesProducts-descriptions-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : salesProducts-folder-parents

Type: object

NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

Show Source

• id: integer
  Minimum Value: 1

  ID value. Read-only
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"NamedID in which the ID is read-only.  Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"ID value.  Read-only"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-salesProducts-names-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : salesProducts-schedules-price

Type: object

The monetary value that consists of currency, exchange rate, and value.

Show Source

• currency: object namedIDs-salesProducts-schedules-price-currency
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• exchangeRate: object namedIDs-salesProducts-schedules-price-exchangeRate
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• value: number
  The value of the currency.

{
    "type":"object",
    "description":"The monetary value that consists of currency, exchange rate, and value.",
    "properties":{
        "currency":{
            "type":"object",
            "description":"The ID of the currency.",
            "$ref":"#/definitions/namedIDs-salesProducts-schedules-price-currency"
        },
        "value":{
            "type":"number",
            "description":"The value of the currency."
        },
        "exchangeRate":{
            "type":[
                "object",
                "null"
            ],
            "description":"The exchange rate in effect when the value was set. This is used to convert the value to other currencies.",
            "$ref":"#/definitions/namedIDs-salesProducts-schedules-price-exchangeRate"
        }
    }
}

Nested Schema : namedIDs-salesProducts-schedules-schedule

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-salesProducts-schedules-price-currency

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-salesProducts-schedules-price-exchangeRate

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Back to Top

Examples

Use GET with the following syntax to retrieve a specific sales product:

https://your_site_interface/services/rest/connect/version/salesProducts/product_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4

Response body example

{
  "id": 4,
  "lookupName": "Blizzard",
  "updatedTime": "2016-02-12T14:37:13.000Z",
  "acceptCount": 0,
  "adminVisibleInterfaces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4/adminVisibleInterfaces"
      }
    ]
  },
  "attributes": {
    "disabled": false,
    "hasSerialNumber": true,
    "isSalesProduct": true,
    "isServiceProduct": true
  },
  "customFields": {
    "c": {}
  },
  "descriptions": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4/descriptions"
      }
    ]
  },
  "displayOrder": 4,
  "folder": null,
  "name": "Blizzard",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4/names"
      }
    ]
  },
  "partNumber": "10001",
  "respondCount": 0,
  "schedules": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4/schedules"
      }
    ]
  },
  "serviceProduct": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/66"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceProducts/66"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/serviceProducts",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/salesProducts",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top