Jump to

• Request
• Response
• Examples

Get a purchased product

get

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

Request

Path Parameters

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

Back to Top

Response

Default Response

Body ()

Root Schema : purchasedProducts

Type: object

The information about a purchased product.

Show Source

• campaign: [ "object", "null" ]
  The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service. It is the reference to a resource in 'campaigns' collection. Only ID or lookupName can be provided to specify the resource.
• comment: [ "string", "null" ]
  Maximum Length: 1333

  The comments or notes associated with the line item.
• contact: [ "object", "null" ]
  The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
• createdTime: string
  The date and time when the purchased product was created. This attribute is read-only.
• finalizedByAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the purchased product.
• licenseEndTime: [ "string", "null" ]
  The end date of the license.
• licenseStartTime: [ "string", "null" ]
  The start date of the license.
• lookupName: string
  Maximum Length: 255

  The name used to look up the purchased product.
• mailing: object namedIDs-purchasedProducts-mailing
  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.
• opportunity: [ "object", "null" ]
  The information about a specific sale or a pending deal with a contact or an organization that is tracked and maintained in the Oracle B2C Service knowledge base. It is the reference to a resource in 'opportunities' collection. Only ID or lookupName can be provided to specify the resource.
• organization: [ "object", "null" ]
  The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
• price: object purchasedProducts-price
  The monetary value that consists of currency, exchange rate, and value.
• purchaseTime: [ "string", "null" ]
  The date and time of the purchase.
• salesProduct: [ "object", "null" ]
  The items or services sold by an organization. Sales products are available to customers through quotes and promotions. It is the reference to a resource in 'salesProducts' collection. Only ID or lookupName can be provided to specify the resource.
• serialNumber: [ "string", "null" ]
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The serial number of the purchased product.
• updatedTime: string
  The date and time when the purchased product was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The information about a purchased product.",
    "properties":{
        "comment":{
            "type":[
                "string",
                "null"
            ],
            "description":"The comments or notes associated with the line item.",
            "maxLength":"1333"
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the purchased product was last updated. This attribute is read-only."
        },
        "campaign":{
            "type":[
                "object",
                "null"
            ],
            "description":"The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service. It is the reference to a resource in 'campaigns' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "salesProduct":{
            "type":[
                "object",
                "null"
            ],
            "description":"The items or services sold by an organization. Sales products are available to customers through quotes and promotions. It is the reference to a resource in 'salesProducts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "opportunity":{
            "type":[
                "object",
                "null"
            ],
            "description":"The information about a specific sale or a pending deal with a contact or an organization that is tracked and maintained in the Oracle B2C Service knowledge base. It is the reference to a resource in 'opportunities' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "purchaseTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time of the purchase."
        },
        "serialNumber":{
            "pattern":"^[^\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The serial number of the purchased product.",
            "maxLength":"80"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the purchased product.",
            "maxLength":"255"
        },
        "licenseEndTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The end date of the license."
        },
        "price":{
            "type":[
                "object",
                "null"
            ],
            "description":"The price of the purchased product in a given currency.",
            "$ref":"#/definitions/purchasedProducts-price"
        },
        "licenseStartTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The start date of the license."
        },
        "contact":{
            "type":[
                "object",
                "null"
            ],
            "description":"The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the purchased product was created. This attribute is read-only."
        },
        "organization":{
            "type":[
                "object",
                "null"
            ],
            "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "mailing":{
            "type":[
                "object",
                "null"
            ],
            "description":"The associated mailing.",
            "$ref":"#/definitions/namedIDs-purchasedProducts-mailing"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the purchased product.",
            "maximum":"9223372036854776000"
        },
        "finalizedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        }
    }
}

Nested Schema : namedIDs-purchasedProducts-mailing

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 : purchasedProducts-price

Type: object

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

Show Source

• currency: object namedIDs-purchasedProducts-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-purchasedProducts-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-purchasedProducts-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-purchasedProducts-price-exchangeRate"
        }
    }
}

Nested Schema : namedIDs-purchasedProducts-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-purchasedProducts-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 purchased product:

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

Request URI example

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

Response body example

{
  "id": 6,
  "lookupName": "6",
  "campaign": null,
  "comment": null,
  "contact": null,
  "customFields": {
    "c": {}
  },
  "finalizedByAccount": null,
  "licenseEndTime": null,
  "licenseStartTime": null,
  "mailing": null,
  "opportunity": null,
  "organization": null,
  "price": {
    "currency": {
      "id": 1,
      "lookupName": "USD"
    },
    "exchangeRate": null,
    "value": 750
  },
  "purchaseTime": null,
  "salesProduct": {
    "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"
      }
    ]
  },
  "serialNumber": "SN0007",
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/purchasedProducts/6"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/purchasedProducts/6"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/purchasedProducts",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top