ProductInventory

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "ProductInventory",
  "id": "http://ingrammicro.com/pa/flat-catalog/1.4",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "public": true
  },
  "properties": {
    "refreshStatsUUID": {
      "type": "string"
    }
  },
  "operations": {
    "getProductItems": {
      "path": "/flat-catalog/product-items",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "BssProductItem"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      }
    },
    "getProducts": {
      "path": "/flat-catalog/products",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "ProductItem"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      }
    },
    "getProductsByDate": {
      "path": "/flat-catalog/products/{date}",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "ProductItem"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      },
      "parameters": {
        "date": {
          "kind": "path",
          "type": "date"
        }
      }
    },
    "getProductsInXlsx": {
      "path": "/flat-catalog/products-xlsx",
      "verb": "GET",
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      }
    },
    "getProductsByDateInXlsx": {
      "path": "/flat-catalog/products-xlsx/{date}",
      "verb": "GET",
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      },
      "parameters": {
        "date": {
          "kind": "path",
          "type": "date"
        }
      }
    },
    "getContext": {
      "path": "/flat-catalog/context",
      "verb": "GET",
      "response": {
        "type": "ProductInventoryContext"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      }
    },
    "createPriceList": {
      "path": "/flat-catalog/price-import-wizard/upload",
      "verb": "POST",
      "response": {
        "type": "PriceListState"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#manage-product-inventory"
      }
    },
    "parsePriceList": {
      "path": "/flat-catalog/price-import-wizard/{dataId}/parse",
      "verb": "POST",
      "response": {
        "type": "PriceListState"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#manage-product-inventory"
      },
      "parameters": {
        "dataId": {
          "kind": "path",
          "type": "integer"
        }
      }
    },
    "prepareProposals": {
      "path": "/flat-catalog/price-import-wizard/{dataId}/prepare-proposals",
      "verb": "POST",
      "response": {
        "type": "PriceListState"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#manage-product-inventory"
      },
      "parameters": {
        "dataId": {
          "kind": "path",
          "type": "integer"
        }
      }
    },
    "getProductDiffs": {
      "path": "/flat-catalog/price-import-wizard/{dataId}/product-diffs",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "ProductDiff"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      },
      "parameters": {
        "dataId": {
          "kind": "path",
          "type": "integer"
        }
      }
    },
    "setPrices": {
      "path": "/flat-catalog/price-import-wizard/{dataId}/set-prices",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#manage-product-inventory"
      },
      "parameters": {
        "dataId": {
          "kind": "path",
          "type": "integer"
        },
        "settings": {
          "kind": "body",
          "type": "PriceImportWizardSettings"
        }
      }
    },
    "updateStats": {
      "path": "/flat-catalog/update-stats",
      "verb": "PUT",
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "referrer": false,
        "public": false
      }
    },
    "getVendors": {
      "path": "/flat-catalog/vendors",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "Vendor"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      }
    },
    "listPlans": {
      "path": "/plan-currency/plans",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "CurrencyPlan"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      }
    },
    "getAvailablePlanPeriods": {
      "path": "/plan-currency/periods",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "Period"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      }
    },
    "setCurrency": {
      "path": "/plan-currency/set-currency",
      "verb": "POST",
      "response": {
        "type": "SetCurrencyStatus"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#manage-product-inventory"
      }
    },
    "cleanCache": {
      "path": "/plan-currency/clean-cache",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-product-inventory"
      }
    },
    "getAllLogItems": {
      "path": "/flat-catalog/audit/importOperations",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "ImportOperation"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-audit"
      }
    },
    "getChanges": {
      "path": "/flat-catalog/audit/importOperations/{id}/changes",
      "verb": "GET",
      "response": {
        "type": "sheet"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-audit"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "getImported": {
      "path": "/flat-catalog/audit/importOperations/{id}/imported",
      "verb": "GET",
      "response": {
        "type": "sheet"
      },
      "errorResponse": {
        "type": "object"
      },
      "access": {
        "public": false,
        "privilege": "http://www.odin.com/products/automation/billing#view-audit"
      },
      "parameters": {
        "id": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  },
  "structures": {
    "Currency": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string"
        },
        "code": {
          "type": "string"
        }
      }
    },
    "BssProductItem": {
      "type": "object",
      "properties": {
        "product": {
          "type": "string"
        },
        "productItem": {
          "type": "string"
        },
        "resourceId": {
          "type": "integer"
        },
        "resourceUUID": {
          "type": "string"
        },
        "mpn": {
          "type": "string"
        },
        "billingPeriod": {
          "type": "integer"
        },
        "billingPeriodType": {
          "type": "integer",
          "enum": [
            "1",
            "2",
            "3"
          ],
          "enumTitles": [
            "Day",
            "Month",
            "Year"
          ]
        },
        "period": {
          "type": "integer"
        },
        "periodType": {
          "type": "integer",
          "enum": [
            "1",
            "2",
            "3"
          ],
          "enumTitles": [
            "Day",
            "Month",
            "Year"
          ]
        },
        "cost": {
          "type": "Currency"
        },
        "price": {
          "type": "Currency"
        },
        "margin": {
          "type": "number"
        },
        "msrpPrice": {
          "type": "Currency"
        },
        "feeType": {
          "type": "string",
          "enum": [
            "SETUP",
            "RECURRING",
            "OVERUSE"
          ]
        },
        "minimum": {
          "type": "number"
        },
        "maximum": {
          "type": "number"
        },
        "subscriptions": {
          "type": "integer"
        },
        "seats": {
          "type": "number"
        },
        "planUuids": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "dependsOn": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "ItemIdentifier": {
      "type": "object",
      "properties": {
        "resourceId": {
          "type": "integer"
        },
        "mpn": {
          "type": "string"
        },
        "manufacturer": {
          "type": "string"
        },
        "billingPeriod": {
          "type": "Period"
        },
        "subscriptionPeriod": {
          "type": "Period"
        },
        "billingModel": {
          "type": "string",
          "enum": [
            "CHARGE_BEFORE_BILLING_PERIOD",
            "CHARGE_AFTER_BILLING_PERIOD",
            "CHARGE_BEFORE_SUBSCRIPTION_PERIOD",
            "CHARGE_EXTERNAL_RATING",
            "CHARGE_ON_PURCHASE"
          ]
        },
        "serviceTemplateId": {
          "type": "integer"
        },
        "serviceTemplateName": {
          "type": "string"
        },
        "priceCurrency": {
          "type": "string"
        }
      }
    },
    "Period": {
      "type": "object",
      "properties": {
        "period": {
          "type": "integer"
        },
        "type": {
          "type": "string",
          "enum": [
            "DAY",
            "MONTH",
            "YEAR"
          ],
          "enumTitles": [
            "Day",
            "Month",
            "Year"
          ]
        }
      }
    },
    "CostBillingPeriod": {
      "type": "object",
      "properties": {
        "period": {
          "type": "Period"
        },
        "useProductItemBillingPeriod": {
          "type": "boolean"
        }
      }
    },
    "Expense": {
      "type": "object",
      "properties": {
        "ranges": {
          "type": "array",
          "items": {
            "type": "PriceRange"
          }
        },
        "model": {
          "type": "string",
          "enum": [
            "FLAT",
            "TIERED",
            "VOLUME_SUBSCRIPTION",
            "VOLUME_ORDER",
            "VOLUME_RESOURCE_AGGREGATED"
          ]
        }
      }
    },
    "PriceRange": {
      "type": "object",
      "properties": {
        "level": {
          "type": "number"
        },
        "price": {
          "type": "Currency"
        },
        "priceLevelHint": {
          "type": "string"
        },
        "ratingAttribute": {
          "type": "string"
        }
      }
    },
    "ItemStats": {
      "type": "object",
      "properties": {
        "subscriptions": {
          "type": "integer"
        },
        "seats": {
          "type": "number"
        }
      }
    },
    "ItemTechnicalInfo": {
      "type": "object",
      "properties": {
        "resourceUUID": {
          "type": "string"
        },
        "planUuids": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "ResourceInfo": {
      "type": "object",
      "properties": {
        "resourceId": {
          "type": "integer"
        },
        "resourceUUID": {
          "type": "string"
        },
        "planUuids": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "dependsOn": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "plans": {
          "type": "array",
          "items": {
            "type": "PlanInfo"
          }
        }
      }
    },
    "PlanInfo": {
      "type": "object",
      "properties": {
        "planId": {
          "type": "integer"
        },
        "billingTerms": {
          "type": "BillingTerms"
        }
      }
    },
    "BillingTerms": {
      "type": "object",
      "properties": {
        "billingPeriodAlignment": {
          "type": "string",
          "default": "SUBSCRIPTION_PERIOD_START",
          "enum": [
            "SUBSCRIPTION_PERIOD_START",
            "SUBSCRIPTION_PERIOD_EXPIRATION"
          ]
        },
        "cotermingPossibility": {
          "type": "string",
          "default": "RESTRICTED",
          "enum": [
            "RESTRICTED",
            "ALLOWED",
            "FIXED_DATE_FROM_VENDOR"
          ]
        },
        "isExpDateAlignedWithEndOfMonth": {
          "type": "boolean"
        },
        "isExpDateAlignedWithSubscr": {
          "type": "boolean"
        }
      }
    },
    "ProductItem": {
      "type": "object",
      "properties": {
        "identifier": {
          "type": "ItemIdentifier"
        },
        "costBillingPeriod": {
          "type": "CostBillingPeriod"
        },
        "cost": {
          "type": "Expense"
        },
        "price": {
          "type": "Expense"
        },
        "msrp": {
          "type": "Expense"
        },
        "feeType": {
          "type": "string",
          "enum": [
            "SETUP",
            "RECURRING",
            "OVERUSE"
          ]
        },
        "effectiveDate": {
          "type": "string",
          "format": "date"
        },
        "application": {
          "type": "string"
        },
        "product": {
          "type": "string"
        },
        "productId": {
          "type": "string"
        },
        "manufacturerName": {
          "type": "string"
        },
        "uom": {
          "type": "string"
        },
        "margin": {
          "type": "number"
        },
        "resellerMargin": {
          "type": "number"
        },
        "minimum": {
          "type": "number"
        },
        "maximum": {
          "type": "number"
        },
        "stats": {
          "type": "ItemStats"
        },
        "dependsOn": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "technicalInfo": {
          "type": "ItemTechnicalInfo"
        },
        "resourcesInfo": {
          "type": "array",
          "items": {
            "type": "ResourceInfo"
          }
        }
      }
    },
    "CostHistoryContext": {
      "type": "object"
    },
    "ProductInventoryContext": {
      "type": "object",
      "properties": {
        "provider": {
          "type": "boolean"
        },
        "costsSupported": {
          "type": "boolean"
        },
        "msrpSupported": {
          "type": "boolean"
        },
        "marginProtectionEnabled": {
          "type": "boolean"
        },
        "baseCurrency": {
          "type": "string"
        },
        "timezoneId": {
          "type": "string"
        }
      }
    },
    "ProductItemWithoutPeriod": {
      "type": "object",
      "properties": {
        "identifier": {
          "type": "ItemIdentifier"
        },
        "planIds": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "withRatePeriod": {
          "type": "boolean"
        }
      }
    },
    "ProductItemOverridings": {
      "type": "object",
      "properties": {
        "effectiveDate": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "currency": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "PriceListState": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "required": true,
          "title": "Price list status",
          "enum": [
            "UPLOAD_FAILED",
            "PARSING_FAILED",
            "PARSED"
          ]
        },
        "errorMessage": {
          "type": "string"
        },
        "missingProducts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "itemsWithoutPeriod": {
          "type": "array",
          "items": {
            "type": "ProductItemWithoutPeriod"
          }
        },
        "priceListStructure": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "pricingModel": {
          "type": "string"
        },
        "feeType": {
          "type": "string"
        },
        "vendorId": {
          "type": "string"
        },
        "dataId": {
          "type": "integer"
        },
        "overridings": {
          "type": "ProductItemOverridings"
        }
      }
    },
    "ProductDiff": {
      "type": "object"
    },
    "PriceImportWizardSettings": {
      "type": "object",
      "properties": {
        "exportCosts": {
          "type": "boolean"
        },
        "exportPrices": {
          "type": "boolean"
        },
        "exportMSRP": {
          "type": "boolean"
        },
        "effectiveDate": {
          "type": "string",
          "format": "date"
        },
        "priceModel": {
          "type": "string",
          "enum": [
            "FLAT",
            "TIERED",
            "VOLUME_SUBSCRIPTION",
            "VOLUME_ORDER",
            "VOLUME_RESOURCE_AGGREGATED"
          ]
        },
        "feeType": {
          "type": "string",
          "enum": [
            "SETUP",
            "RECURRING",
            "OVERUSE"
          ]
        },
        "vendorId": {
          "type": "string"
        },
        "fileName": {
          "type": "string"
        }
      }
    },
    "Vendor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "CurrencyPlan": {
      "type": "object",
      "properties": {
        "planId": {
          "type": "integer"
        },
        "planName": {
          "type": "string"
        },
        "accountId": {
          "type": "integer"
        },
        "billingPeriod": {
          "type": "Period"
        },
        "planCurrency": {
          "type": "string"
        },
        "vendor": {
          "type": "string"
        },
        "serviceTemplateName": {
          "type": "string"
        }
      }
    },
    "SetCurrencyStatus": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "required": true,
          "title": "Set currency status",
          "enum": [
            "SUCCESS",
            "FAILED"
          ]
        },
        "failedPlans": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "ImportOperationUser": {
      "type": "object"
    },
    "ImportOperation": {
      "type": "object",
      "properties": {
        "operationId": {
          "type": "integer"
        },
        "user": {
          "type": "ImportOperationUser"
        },
        "operationType": {
          "type": "string",
          "enum": [
            "UPDATE_PRICES",
            "UPDATE_COSTS",
            "UPDATE_MSRP",
            "NONE"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "INITIATED",
            "PROCESSED",
            "ERROR",
            "WAITING_PROCESSING",
            "NONE"
          ]
        },
        "date": {
          "type": "string"
        },
        "effectiveDate": {
          "type": "string"
        }
      }
    }
  }
}

Properties

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
refreshStatsUUID	String	Not Required

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
getProductItems	GET	/flat-catalog/product-items
getProducts	GET	/flat-catalog/products
getProductsByDate	GET	/flat-catalog/products/{date}
getProductsInXlsx	GET	/flat-catalog/products-xlsx
getProductsByDateInXlsx	GET	/flat-catalog/products-xlsx/{date}
getContext	GET	/flat-catalog/context
createPriceList	POST	/flat-catalog/price-import-wizard/upload
parsePriceList	POST	/flat-catalog/price-import-wizard/{dataId}/parse
prepareProposals	POST	/flat-catalog/price-import-wizard/{dataId}/prepare-proposals
getProductDiffs	GET	/flat-catalog/price-import-wizard/{dataId}/product-diffs
setPrices	POST	/flat-catalog/price-import-wizard/{dataId}/set-prices
updateStats	PUT	/flat-catalog/update-stats
getVendors	GET	/flat-catalog/vendors
listPlans	GET	/plan-currency/plans
getAvailablePlanPeriods	GET	/plan-currency/periods
setCurrency	POST	/plan-currency/set-currency
cleanCache	POST	/plan-currency/clean-cache
getAllLogItems	GET	/flat-catalog/audit/importOperations
getChanges	GET	/flat-catalog/audit/importOperations/{id}/changes
getImported	GET	/flat-catalog/audit/importOperations/{id}/imported

getProductItems

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/product-items

Description

Returns

getProducts

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/products

Description

Returns

getProductsByDate

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/products/{date}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
date	Date

Returns

getProductsInXlsx

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/products-xlsx

Description

Returns

getProductsByDateInXlsx

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/products-xlsx/{date}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
date	Date

Returns

getContext

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/context

Description

Returns

createPriceList

HTTP Request

POST /aps/2/resources/{aps-id}/flat-catalog/price-import-wizard/upload

Description

Returns

parsePriceList

HTTP Request

POST /aps/2/resources/{aps-id}/flat-catalog/price-import-wizard/{dataId}/parse

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
dataId	Integer

Returns

prepareProposals

HTTP Request

POST /aps/2/resources/{aps-id}/flat-catalog/price-import-wizard/{dataId}/prepare-proposals

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
dataId	Integer

Returns

getProductDiffs

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/price-import-wizard/{dataId}/product-diffs

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
dataId	Integer

Returns

setPrices

HTTP Request

POST /aps/2/resources/{aps-id}/flat-catalog/price-import-wizard/{dataId}/set-prices

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
dataId	Integer
settings	PriceImportWizardSettings

Returns

updateStats

HTTP Request

PUT /aps/2/resources/{aps-id}/flat-catalog/update-stats

Description

Returns

getVendors

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/vendors

Description

Returns

listPlans

HTTP Request

GET /aps/2/resources/{aps-id}/plan-currency/plans

Description

Returns

getAvailablePlanPeriods

HTTP Request

GET /aps/2/resources/{aps-id}/plan-currency/periods

Description

Returns

setCurrency

HTTP Request

POST /aps/2/resources/{aps-id}/plan-currency/set-currency

Description

Returns

cleanCache

HTTP Request

POST /aps/2/resources/{aps-id}/plan-currency/clean-cache

Description

Returns

getAllLogItems

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/audit/importOperations

Description

Returns

getChanges

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/audit/importOperations/{id}/changes

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String

Returns

getImported

HTTP Request

GET /aps/2/resources/{aps-id}/flat-catalog/audit/importOperations/{id}/imported

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
id	String

Returns

Structures

Currency

Basic currency structure.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
value	String	Not Required		Amount.
code	String	Not Required		Currency Code

BssProductItem

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
product	String	Not Required
productItem	String	Not Required
resourceId	Integer	Not Required
resourceUUID	String	Not Required
mpn	String	Not Required
billingPeriod	Integer	Not Required
billingPeriodType	Integer	Not Required
period	Integer	Not Required
periodType	Integer	Not Required
cost	Currency	Not Required
price	Currency	Not Required
margin	Number	Not Required
msrpPrice	Currency	Not Required
feeType	Enum	Not Required
minimum	Number	Not Required
maximum	Number	Not Required
subscriptions	Integer	Not Required
seats	Number	Not Required
planUuids	Array of String	Not Required
dependsOn	Array of String	Not Required

ItemIdentifier

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
resourceId	Integer	Not Required
mpn	String	Not Required
manufacturer	String	Not Required
billingPeriod	Period	Not Required
subscriptionPeriod	Period	Not Required
billingModel	Enum	Not Required
serviceTemplateId	Integer	Not Required
serviceTemplateName	String	Not Required
priceCurrency	String	Not Required

Period

Resource identification structure.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
period	Integer	Not Required
type	Enum	Not Required		The type of a period

CostBillingPeriod

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
period	Period	Not Required
useProductItemBillingPeriod	Boolean	Not Required

Expense

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
ranges	Array of PriceRange	Not Required
model	Enum	Not Required

PriceRange

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
level	Number	Not Required
price	Currency	Not Required
priceLevelHint	String	Not Required
ratingAttribute	String	Not Required

ItemStats

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
subscriptions	Integer	Not Required
seats	Number	Not Required

ItemTechnicalInfo

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
resourceUUID	String	Not Required
planUuids	Array of String	Not Required

ResourceInfo

General resource information

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
resourceId	Integer	Not Required
resourceUUID	String	Not Required
planUuids	Array of String	Not Required
dependsOn	Array of String	Not Required
plans	Array of PlanInfo	Not Required

PlanInfo

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
planId	Integer	Not Required
billingTerms	BillingTerms	Not Required

BillingTerms

Defines the subscription charge policy.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
billingPeriodAlignment	Enum	Not Required	SUBSCRIPTION_PERIOD_START
cotermingPossibility	Enum	Not Required	RESTRICTED
isExpDateAlignedWithEndOfMonth	Boolean	Not Required
isExpDateAlignedWithSubscr	Boolean	Not Required

ProductItem

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
identifier	ItemIdentifier	Not Required
costBillingPeriod	CostBillingPeriod	Not Required
cost	Expense	Not Required
price	Expense	Not Required
msrp	Expense	Not Required
feeType	Enum	Not Required
effectiveDate	String	Not Required
application	String	Not Required
product	String	Not Required
productId	String	Not Required
manufacturerName	String	Not Required
uom	String	Not Required
margin	Number	Not Required
resellerMargin	Number	Not Required
minimum	Number	Not Required
maximum	Number	Not Required
stats	ItemStats	Not Required
dependsOn	Array of String	Not Required
technicalInfo	ItemTechnicalInfo	Not Required
resourcesInfo	Array of ResourceInfo	Not Required

CostHistoryContext

ProductInventoryContext

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
provider	Boolean	Not Required
costsSupported	Boolean	Not Required
msrpSupported	Boolean	Not Required
marginProtectionEnabled	Boolean	Not Required
baseCurrency	String	Not Required
timezoneId	String	Not Required

ProductItemWithoutPeriod

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
identifier	ItemIdentifier	Not Required
planIds	Array of Integer	Not Required
withRatePeriod	Boolean	Not Required

ProductItemOverridings

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
effectiveDate	Array of String	Not Required
currency	Array of String	Not Required

PriceListState

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
status	Enum	Required
errorMessage	String	Not Required
missingProducts	Array of String	Not Required
itemsWithoutPeriod	Array of ProductItemWithoutPeriod	Not Required
priceListStructure	Array of String	Not Required
pricingModel	String	Not Required
feeType	String	Not Required
vendorId	String	Not Required
dataId	Integer	Not Required
overridings	ProductItemOverridings	Not Required

ProductDiff

PriceImportWizardSettings

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
exportCosts	Boolean	Not Required
exportPrices	Boolean	Not Required
exportMSRP	Boolean	Not Required
effectiveDate	String	Not Required
priceModel	Enum	Not Required
feeType	Enum	Not Required
vendorId	String	Not Required
fileName	String	Not Required

Vendor

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
id	String	Not Required
name	String	Not Required

CurrencyPlan

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
planId	Integer	Not Required
planName	String	Not Required
accountId	Integer	Not Required
billingPeriod	Period	Not Required
planCurrency	String	Not Required
vendor	String	Not Required
serviceTemplateName	String	Not Required

SetCurrencyStatus

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
status	Enum	Required
failedPlans	Array of Integer	Not Required

ImportOperationUser

ImportOperation

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
operationId	Integer	Not Required
user	ImportOperationUser	Not Required
operationType	Enum	Not Required
status	Enum	Not Required
date	String	Not Required
effectiveDate	String	Not Required

Examples

Please find general description of create-read-update-delete (CRUD) operations with resources, properties, and structures respectively at:

• Provisioning Resources

• Getting a Resource List

• Resource Configuration

• Unprovisioning Resources

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← ProductCatalogReportingService

SKUManagement →