Jump to

• Request
• Response

Retrieves the asset detail based on id

get

/ccstore/v1/selfservice/assets/{id}

Retrieves the asset based on id. If the profile is not logged in or is anonymous then the endpoint will fail. The user should be granted required access rights based on which the this api will return the asset detail

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  ID of asset.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response containing the asset detail

Body ()

Root Schema : assetDetails_Response

Type: object

Show Source

• AssetDescription: string
  Title: Description

  Maximum Length: 2000

  The description of the asset.
• AssetId: integer(int64)
  Title: Asset ID

  The unique identifier of the asset.
• AssetName: string
  Title: Asset Name

  Maximum Length: 300

  The name of the asset.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 100

  The alternate identifier of the asset.
• CustomerId: integer(int64)
  Title: Asset Owner Party ID

  The unique identifier of the existing customer party.
• Description: string
  Title: Product Item

  Maximum Length: 240

  The brief description of the asset item.
• IBAssetId: integer(int64)
  Title: Installed Base Asset ID

  This attribute is deprecated. The unique identifier of the Install Base asset record.
• InstallDate: string(date)
  Title: Install Date

  The date the asset was installed.
• OrderKey: string
  Title: Order Key

  Maximum Length: 120

  The key assigned to an order.
• OrderNumber: string
  Title: Order Number

  Maximum Length: 120

  The number assigned to an order.
• Product: string
  Title: Product

  Maximum Length: 250

  The name of the product associated with the asset.
• Quantity: number
  Title: Quantity

  The quantity purchased.
• QuoteKey: string
  Title: Quote Key

  Maximum Length: 120

  The key used to identify the quote.
• QuoteLineNumber: string
  Title: Quote Line Number

  Maximum Length: 120

  The number used to identify the line within a quote.
• QuoteNumber: string
  Title: Quote Number

  Maximum Length: 120

  The number used to identify the quote.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 100

  The serial number of the asset.
• StatusCode: string
  Title: Status

  Maximum Length: 50

  The lookup code that represents the asset status.

{
    "type":"object",
    "properties":{
        "Description":{
            "description":"The brief description of the asset item.",
            "title":"Product Item",
            "type":"string",
            "maxLength":240
        },
        "AssetDescription":{
            "description":"The description of the asset.",
            "title":"Description",
            "type":"string",
            "maxLength":2000
        },
        "Product":{
            "description":"The name of the product associated with the asset.",
            "title":"Product",
            "type":"string",
            "maxLength":250
        },
        "Quantity":{
            "description":"The quantity purchased.",
            "title":"Quantity",
            "type":"number"
        },
        "OrderNumber":{
            "description":"The number assigned to an order.",
            "title":"Order Number",
            "type":"string",
            "maxLength":120
        },
        "CustomerId":{
            "format":"int64",
            "description":"The unique identifier of the existing customer party.",
            "title":"Asset Owner Party ID",
            "type":"integer"
        },
        "InstallDate":{
            "format":"date",
            "description":"The date the asset was installed.",
            "title":"Install Date",
            "type":"string"
        },
        "AssetNumber":{
            "description":"The alternate identifier of the asset.",
            "title":"Asset Number",
            "type":"string",
            "maxLength":100
        },
        "StatusCode":{
            "description":"The lookup code that represents the asset status.",
            "title":"Status",
            "type":"string",
            "maxLength":50
        },
        "AssetName":{
            "description":"The name of the asset.",
            "title":"Asset Name",
            "type":"string",
            "maxLength":300
        },
        "QuoteKey":{
            "description":"The key used to identify the quote.",
            "title":"Quote Key",
            "type":"string",
            "maxLength":120
        },
        "QuoteNumber":{
            "description":"The number used to identify the quote.",
            "title":"Quote Number",
            "type":"string",
            "maxLength":120
        },
        "SerialNumber":{
            "description":"The serial number of the asset.",
            "title":"Serial Number",
            "type":"string",
            "maxLength":100
        },
        "IBAssetId":{
            "format":"int64",
            "description":"This attribute is deprecated. The unique identifier of the Install Base asset record.",
            "title":"Installed Base Asset ID",
            "type":"integer"
        },
        "AssetId":{
            "format":"int64",
            "description":"The unique identifier of the asset.",
            "title":"Asset ID",
            "type":"integer"
        },
        "OrderKey":{
            "description":"The key assigned to an order.",
            "title":"Order Key",
            "type":"string",
            "maxLength":120
        },
        "QuoteLineNumber":{
            "description":"The number used to identify the line within a quote.",
            "title":"Quote Line Number",
            "type":"string",
            "maxLength":120
        }
    },
    "example":{
        "ProdGroupId":null,
        "CreationDate":"2024-03-26T13:55:06+00:00",
        "ProdGroupName":null,
        "AssetDescription":null,
        "Product":"LIMITRONIC UV inkjet printer V6 Color Downjet",
        "OrderNumber":null,
        "CurcyConvRateType":"Corporate",
        "ShipToPartyId":"1006",
        "AccountSourceSystem":"PSFT_DOO",
        "QuoteKey":null,
        "IBAssetId":"300100591056783",
        "SourceObjectCode":"InstalledBaseAsset",
        "BOMComponentFlag":false,
        "UOMCode":"Ea",
        "AssetOrigSystemReference":null,
        "LastUpdatedBy":"CONMGR",
        "CreatedBy":"CONMGR",
        "InventoryItemId":"300100591042595",
        "ProductType":"Item",
        "FormattedAddress":"302 Executive Circle,Warehouse B,CHATTANOOGA, TN 37401",
        "InventoryOrgId":"204",
        "CustomerId":"1006",
        "Longitude":null,
        "DeleteFlag":false,
        "AddressName":null,
        "AddressLine3":null,
        "AssetTag":null,
        "AddressLine2":"Warehouse B",
        "AddressLine1":"302 Executive Circle",
        "AddressLine4":null,
        "AddressNumber":"1090",
        "Country":"US",
        "AccountNameTransientForLOV":"Computer Service and Rentals",
        "ItemSourceSystemReference":null,
        "AssetId":"300100591056783",
        "OrderKey":null,
        "LastUpdateLogin":null,
        "Building":null,
        "CurrentLocationContext":"ORA_CUSTOMER",
        "FloorNumber":null,
        "Description":"LIMITRONIC UV inkjet printer V6 Color Downjet",
        "PrContactPartyId":null,
        "AttributeCategory":null,
        "CompetitiveAsset":"N",
        "SearchFilter":null,
        "AssetOrigSystem":null,
        "AnnualRecurringRevenue":null,
        "SoldByBusinessUnitId":"204",
        "QuoteSourceSystem":null,
        "InterfaceRowId":null,
        "OrderFulfillLineNumber":null,
        "AssetAmount":null,
        "OrderSourceSystem":null,
        "ResourceOwnerPartyNumber":null,
        "QuoteLineNumber":null,
        "AssetOwnerCustomerId":"1006",
        "DelFlag":false,
        "LocationId":"937",
        "EndDate":null,
        "@context":{
            "headers":{
                "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            },
            "key":"300100591056783"
        },
        "Year":null,
        "Model":null,
        "OrderFulfillLineKey":null,
        "QuoteAssetKey":null,
        "ItemSourceSystem":null,
        "LastUpdateDate":"2024-03-27T06:53:02.245+00:00",
        "TotalAssetAmount":null,
        "Latitude":null,
        "AssetNumber":"AST10027",
        "StatusCode":"ACTIVE",
        "QuoteRootAssetKey":null,
        "StartDate":"2024-03-26",
        "AssetOwnerCustomerName":"Computer Service and Rentals",
        "Version":null,
        "CustomerPartyNumber":"1006",
        "Manufacturer":null,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstore/v1/selfservice/assets/300100591056783"
            }
        ],
        "CorpCurrencyCode":"USD",
        "AddressId":"1090",
        "EnteredCurrencyCode":null,
        "SubscriptionStatusCode":null,
        "PrContactPartyNumber":null,
        "BatchId":null,
        "City":"Chattanooga",
        "ResourceOwnerId":null,
        "AssetName":"LIMITRONIC UV inkjet printer V6 Color Downjet",
        "Province":null,
        "SerialNumber":"LIMITRONICV6002",
        "ProdGroupReferenceNumber":null,
        "State":"TN",
        "PurchaseDate":null,
        "OrderedDate":null,
        "SoldByBusinessUnitName":"Vision Operations",
        "ExchangeRate":"0",
        "SalesProductType":null,
        "QuoteParentAssetKey":null,
        "PartyUniqueName":"Computer Service and Rentals",
        "AccountSourceSystemReference":"200009",
        "PostalCode":"37401",
        "OrganizationId":"204",
        "ShipToPartyName":"Computer Service and Rentals",
        "SourceAssetNumber":"LIMITRONICV6001",
        "County":"Hamilton",
        "UpdateFlag":true,
        "ItemNumber":"LIMITRONIC UV inkjet printer V6 Color Downjet",
        "CrmConvRate":null,
        "PartyType":"ORGANIZATION",
        "OrderLineKey":null,
        "QuoteLineKey":null,
        "OrderLineNumber":null,
        "SubscriptionNumber":null,
        "IBAssetSyncedVersionNumber":null,
        "ShipToPartyNumber":"1006",
        "Quantity":"1",
        "AssetOwnerCustomerNumber":"1006",
        "InstallDate":null,
        "QuoteNumber":null,
        "AssetGroup":null
    }
}

Example:

{
    "ProdGroupId":null,
    "CreationDate":"2024-03-26T13:55:06+00:00",
    "ProdGroupName":null,
    "AssetDescription":null,
    "Product":"LIMITRONIC UV inkjet printer V6 Color Downjet",
    "OrderNumber":null,
    "CurcyConvRateType":"Corporate",
    "ShipToPartyId":"1006",
    "AccountSourceSystem":"PSFT_DOO",
    "QuoteKey":null,
    "IBAssetId":"300100591056783",
    "SourceObjectCode":"InstalledBaseAsset",
    "BOMComponentFlag":false,
    "UOMCode":"Ea",
    "AssetOrigSystemReference":null,
    "LastUpdatedBy":"CONMGR",
    "CreatedBy":"CONMGR",
    "InventoryItemId":"300100591042595",
    "ProductType":"Item",
    "FormattedAddress":"302 Executive Circle,Warehouse B,CHATTANOOGA, TN 37401",
    "InventoryOrgId":"204",
    "CustomerId":"1006",
    "Longitude":null,
    "DeleteFlag":false,
    "AddressName":null,
    "AddressLine3":null,
    "AssetTag":null,
    "AddressLine2":"Warehouse B",
    "AddressLine1":"302 Executive Circle",
    "AddressLine4":null,
    "AddressNumber":"1090",
    "Country":"US",
    "AccountNameTransientForLOV":"Computer Service and Rentals",
    "ItemSourceSystemReference":null,
    "AssetId":"300100591056783",
    "OrderKey":null,
    "LastUpdateLogin":null,
    "Building":null,
    "CurrentLocationContext":"ORA_CUSTOMER",
    "FloorNumber":null,
    "Description":"LIMITRONIC UV inkjet printer V6 Color Downjet",
    "PrContactPartyId":null,
    "AttributeCategory":null,
    "CompetitiveAsset":"N",
    "SearchFilter":null,
    "AssetOrigSystem":null,
    "AnnualRecurringRevenue":null,
    "SoldByBusinessUnitId":"204",
    "QuoteSourceSystem":null,
    "InterfaceRowId":null,
    "OrderFulfillLineNumber":null,
    "AssetAmount":null,
    "OrderSourceSystem":null,
    "ResourceOwnerPartyNumber":null,
    "QuoteLineNumber":null,
    "AssetOwnerCustomerId":"1006",
    "DelFlag":false,
    "LocationId":"937",
    "EndDate":null,
    "@context":{
        "headers":{
            "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        "key":"300100591056783"
    },
    "Year":null,
    "Model":null,
    "OrderFulfillLineKey":null,
    "QuoteAssetKey":null,
    "ItemSourceSystem":null,
    "LastUpdateDate":"2024-03-27T06:53:02.245+00:00",
    "TotalAssetAmount":null,
    "Latitude":null,
    "AssetNumber":"AST10027",
    "StatusCode":"ACTIVE",
    "QuoteRootAssetKey":null,
    "StartDate":"2024-03-26",
    "AssetOwnerCustomerName":"Computer Service and Rentals",
    "Version":null,
    "CustomerPartyNumber":"1006",
    "Manufacturer":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/selfservice/assets/300100591056783"
        }
    ],
    "CorpCurrencyCode":"USD",
    "AddressId":"1090",
    "EnteredCurrencyCode":null,
    "SubscriptionStatusCode":null,
    "PrContactPartyNumber":null,
    "BatchId":null,
    "City":"Chattanooga",
    "ResourceOwnerId":null,
    "AssetName":"LIMITRONIC UV inkjet printer V6 Color Downjet",
    "Province":null,
    "SerialNumber":"LIMITRONICV6002",
    "ProdGroupReferenceNumber":null,
    "State":"TN",
    "PurchaseDate":null,
    "OrderedDate":null,
    "SoldByBusinessUnitName":"Vision Operations",
    "ExchangeRate":"0",
    "SalesProductType":null,
    "QuoteParentAssetKey":null,
    "PartyUniqueName":"Computer Service and Rentals",
    "AccountSourceSystemReference":"200009",
    "PostalCode":"37401",
    "OrganizationId":"204",
    "ShipToPartyName":"Computer Service and Rentals",
    "SourceAssetNumber":"LIMITRONICV6001",
    "County":"Hamilton",
    "UpdateFlag":true,
    "ItemNumber":"LIMITRONIC UV inkjet printer V6 Color Downjet",
    "CrmConvRate":null,
    "PartyType":"ORGANIZATION",
    "OrderLineKey":null,
    "QuoteLineKey":null,
    "OrderLineNumber":null,
    "SubscriptionNumber":null,
    "IBAssetSyncedVersionNumber":null,
    "ShipToPartyNumber":"1006",
    "Quantity":"1",
    "AssetOwnerCustomerNumber":"1006",
    "InstallDate":null,
    "QuoteNumber":null,
    "AssetGroup":null
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |59000|If there is a missing required property.| |59002|If request can't be processed currently.| |59003|If there is any invalid path parameter| |59004|If resource is not found| |59005|If error occurred while processing input.| |59008|If any issue occurred while triggering the fusion| |59010|If self service is not enabled|

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top