Application Packaging Standard

Last updated 18-Mar-2019

SKUManagement

Synthetic resource for operations with SKU

Schema

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

{
  "name": "SKUManagement",
  "id": "http://www.odin.com/oa/billing/sku/dispatcher/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "operations": {
    "ratesList": {
      "path": "/vendor/{vendorUuid}/rates",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "SKU"
        }
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "vendorUuid": {
          "kind": "path",
          "type": "string"
        },
        "appId": {
          "kind": "query",
          "type": "string"
        },
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "updateRates": {
      "path": "/vendor/{vendorUuid}/rates",
      "verb": "PUT",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "vendorUuid": {
          "kind": "path",
          "type": "string"
        },
        "skuList": {
          "kind": "body",
          "type": "array",
          "required": true
        }
      }
    },
    "synchronize": {
      "path": "/vendor/{vendorUuid}/synchronize",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "vendorUuid": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  },
  "structures": {
    "Currency": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string"
        },
        "code": {
          "type": "string"
        }
      }
    },
    "SKU": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "feeTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "price": {
          "type": "Currency"
        },
        "msrp": {
          "type": "Currency"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "http://aps-standard.org/types/core/i18n/1.0#MLString"
        },
        "plans": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "resources": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

Enums

NAME VALUES DESCRIPTION
FeeType
  • RECURRING
  • SETUP
  • OVERUSE
  • RENEWAL
  • TRANSFER
  • CANCELLATION
Fee types for SKU

Custom Operations

OPERATION VERB PATH RETURNS Description
ratesList GET /vendor/{vendorUuid}/rates List of SKUs for specified vendor. Get SKU Rates by Application.
synchronize POST /vendor/{vendorUuid}/synchronize   Asynchronous call on synchronization of service templates to all sub-resellers.
updateRates PUT /vendor/{vendorUuid}/rates   Update SKU Rates

ratesList

HTTP Request

GET /aps/2/resources/{aps-id}/vendor/{vendorUuid}/rates

Description

Get SKU Rates by Application.

Parameters

PARAMETER TYPE DESCRIPTION
appId String (optional) Identifier of APS application (URI string see Application ID)
planApsId String (Optional) UUID of specified Service Plan for filtering result
vendorId String Specified ID of vendor account

Returns

List of SKUs for specified vendor.

synchronize

HTTP Request

POST /aps/2/resources/{aps-id}/vendor/{vendorUuid}/synchronize

Description

Asynchronous call on synchronization of service templates to all sub-resellers.

Parameters

PARAMETER TYPE DESCRIPTION
vendorId String Specified ID of vendor account

Returns

updateRates

HTTP Request

PUT /aps/2/resources/{aps-id}/vendor/{vendorUuid}/rates

Description

Update SKU Rates

Parameters

PARAMETER TYPE DESCRIPTION
skuList SKU SKUs that should be updated
vendorId String Specified ID of vendor account

Returns

Structures

Currency

Basic currency structure.

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

SKU

SKU Rates structure

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
description Multi-Language String Not Required   SKU description
feeTypes enum FeeType array Not Required   List of fee types, that SKU created for
id Integer Not Required   Identifier of SKU
msrp Currency Not Required   Manufacturer’s Suggested Retail Price of SKU
name String Not Required   SKU name
plans String array Not Required   List of plans identifiers which include this SKU
price Currency Not Required   Price of SKU
resources String array Not Required   List of BSS resources that participates in this SKU

Examples

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