Obtaining the List of Products and Price information (GET /v1.0/allproducts)
Obtain the list of products and price information (service name, category name, product name, unit, unit price) from the user product catalogue.
Request Headers
X-Auth-Token
Specify the authentication token ID.
Data Type | Cardinality |
---|---|
String | 1..1 |
Request Parameter
Locale
Specify the language of the product information in the product catalogue (Language which is specified in "Service in" will be used).
In case of Japanese, English, German, as shown below.
- ja:
- Japanese
- en:
- English
- de:
- German
Data Type | Cardinality |
---|---|
String | 1..1 |
ResellerId
Specify the Reseller ID.
The Reseller ID which belongs to the user will be considered if it is not specified.
Data Type | Cardinality |
---|---|
String | 0..1 |
ServiceProviderId
Specify the Service provider ID.
The entire Service provider ID will be considered if it is not specified.
Data Type | Cardinality |
---|---|
String | 0..1 |
RegionId
Specify the Region ID
The entire Region ID will be considered if it is not specified.
Data Type | Cardinality |
---|---|
String | 0..1 |
ServiceId
Specify the Service ID
The entire Service ID will be considered if it is not specified.
Service ID's which exists are as follows.
- compute:
- Compute
- network:
- Network
- image:
- Image
- software:
- Software
- blockstorage:
- Blockstorage
- objectstorage:
- Objectstorage
- database:
- Database
- loadbalancing:
- Loadbalancer
- dns:
- DNS
- telemetry:
- Monitoring
- queue:
- Message Queue
- mail:
- Mail Delivery
- vpnaas:
- VPN
- deploy:
- Application Deployment
- support:
- Support
Data Type | Cardinality |
---|---|
String | 0..1 |
Basedate
Specify the reference date.
Specify the reference date in accordance with the following ISO8601 compliance.
YYYY-MM-DD
However, the above mentioned reference date cannot be specified as a future date (current and past dates only). If specified it will cause an error.
System Date will be used in case if it is not specified.
Data Type | Cardinality |
---|---|
String | 0..1 |
Response Headers
Content-Type
"Application/xml" will be specified.
Data Type | Cardinality |
---|---|
String | 1..1 |
Response Elements
CatalogList
Displays the entire product and price information (root element).
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | Catalog |
Catalog
Displays the product and price information that are attached to 1 reseller.
* Conditions when tags are not displayed are as follows.
When there is no product information (product ID) in catalog or if it is disabled completely.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | CatalogList | ResellerId Region |
ResellerId
Reseller ID
* If Catalog tag is not displayed, then this tag also will not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | Catalog | None |
Region
Displays the product and price information attached to 1 region.
* Conditions when tags are not displayed are as follows.
When there is no region information (RegionID) in catalog or if it is disabled completely.
* If Catalog tag is not displayed, then this tag also will not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..n | Catalog | RegionId ServiceProvider |
RegionId
Region ID
* If Catalog and Region tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | Region | None |
ServiceProvider
Displays the product and price information attached to 1 service provider.
* If Catalog and Region tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..n | Region | ServiceProviderId Service |
ServiceProviderId
Service Provider ID
* If Catalog and Region tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | ServiceProvider | None |
Service
Displays the product and price information attached to 1 service.
* Conditions when tags are not displayed are as follows.
When there is no service information (ServiceName) in catalog or if it is disabled completely.
* If Catalog and Region tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..n | ServiceProvider | ServiceName Category |
ServiceName
Service Name
- xml:lang:
- Locale
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | Service | None |
Category
Displays the product and price information attached to 1 category.
* Conditions when tags are not displayed are as follows.
When there is no category information (CategoryName) in catalog or if it is disabled completely.
* If Catalog, Region and Service tag does not display, then this tag also will not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..n | Service | CategoryName Product |
CategoryName
Category Name
- xml:lang:
- Locale
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | Category | None |
Product
Displays the products and price information that is attached to 1 product.
* Conditions when tags are not displayed are as follows.
If neither the product information (Product Name), nor the unit information (unit information) exists in Product, or if it is disabled completely.
* If Catalog, Region, Service and Category tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..n | Category | ProductId ProductName UnitName InitialCharge MonthlyChargeInfo |
ProductId
Product ID
* If Catalog, Region, Service, Category and Product tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | Product | None |
ProductName
Product ID
- xml:lang:
- Locale
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | String | 1..1 |
UnitName
Unit name
- xml:lang:
- Locale
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | Product | None |
InitialCharge
Displays the initial price information.
* If Catalog, Region, Service, Category and Product tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | Product | UnitPrice |
UnitPrice
Product unit cost (initial cost)
- currencyid:
- Currency ID to be applied to the product unit price (currency code of ISO 4217)
Therefore, the upper limit of the number of occurrences (n) of element will become the number of registered currency ID.
If the unit price for the currency ID is not specified, only the tag containing the attribute (without value) is returned.
* If Catalog, Region, Service, Category and Product tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..n | InitialCharge | None |
MonthlyChargeInfo
[If the accounting system is either fixed billing or usage-based billing]
Displays the monthly price information
- order:
- Registration sequence
Fixed value ("1").
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | Product | UnitPrice |
[If the billing system is variable usage billing]
Shows the monthly price information that includes the information about the variations.
- order:
- Registration sequence
The number registered by the user will be assigned in a specified order.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..n | Product | Description UnitPrice |
Description
[If the accounting system is either fixed billing or usage-based billing]
Since the value does not change, this information is not used (Not returned for both Tag and value)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..0 | - | - |
[If the billing system is variable usage billing]
Description regarding the price fluctuation.
- xml:lang:
- Locale
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | MonthlyChargeInfo | None |
UnitPrice
Product unit price (monthly fee)
- currencyid:
- Currency ID to be applied to the product unit price (currency code of ISO 4217)
Therefore, the upper limit of the number of occurrences (n) of element will become the number of registered currency ID.
If the unit price for the currency ID is not specified, only the tag containing the attribute (without value) is returned.
* If Catalog, Region, Service, Category and Product tags are not displayed, then this tag will also not be displayed.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..n | MonthlyChargeInfo | None |
Example of Request
GET
/v1.0/allproducts?Locale=en&Basedate=2014-08-31
X-Auth-Token:MIIZuwYJKoZIhvcNAQc…(Authentication Token ID is not mentioned).
Example of Response
[If Billing method is Fixed billing, Usage based Billing and Unit price is specified]
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
<Catalog>
<ResellerId>jp.fujitsu.com</ResellerId>
<Region>
<RegionId>jp-east-1</RegionId>
<ServiceProvider>
<ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
<Service>
<ServiceName xml:lang="en">compute</ServiceName>
<Category>
<CategoryName xml:lang="en">VM Service</CategoryName>
<Product>
<ProductId>VM00001</ProductId>
<ProductName xml:lang="en">VM Service S-1Type</ProductName>
<UnitName xml:lang="en">hours</UnitName>
<InitialCharge>
<UnitPrice currencyid="JPY">0</UnitPrice>
<UnitPrice currencyid="AUD">0</UnitPrice>
…(* Multiple UnitPrice responses also possible)
</InitialCharge>
<MonthlyChargeInfo order="1">
<UnitPrice currencyid="JPY">10</UnitPrice>
<UnitPrice currencyid="AUD">0.01</UnitPrice>
…(* Multiple UnitPrice responses also possible)
</MonthlyChargeInfo>
</Product>
…(* Multiple Product responses also possible)
<Category>
…(* Multiple category responses also possible)
</Service>
…(* Multiple Service responses also possible)
</ServiceProvider>
…(* Multiple Service Provider responses also possible)
</Region>
…(* Multiple Region responses also possible)
</Catalog>
</CatalogList>
[If the billing method is variable usage based billing, specify unit price in currency (JPY) and if currency is not specified in (AUD)].
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
<Catalog>
<ResellerId>jp.fujitsu.com</ResellerId>
<Region>
<RegionId>jp-east-1</RegionId>
<ServiceProvider>
<ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
<Service>
<ServiceName xml:lang="en">mail</ServiceName>
<Category>
<CategoryName xml:lang="en">Mail Send Service</CategoryName>
<Product>
<ProductId>ML00001</ProductId>
<ProductName xml:lang="en">Mail Send Service Mail Count</ProductName>
<UnitName xml:lang="en">none</UnitName>
<InitialCharge>
<UnitPrice currencyid="JPY">0</UnitPrice>
<UnitPrice currencyid="AUD"></UnitPrice>
…(* Multiple UnitPrice responses also possible)
</InitialCharge>
<MonthlyChargeInfo order="1">
<Description xml:lang="en">0[messages/month]</Description>
<UnitPrice currencyid="JPY">0</UnitPrice>
<UnitPrice currencyid="AUD"></UnitPrice>
…(* Multiple UnitPrice responses also possible)
</MonthlyChargeInfo>
<MonthlyChargeInfo order="2">
<Description xml:lang="en">under 10,000[messages/month]</Description>
<UnitPrice currencyid="JPY">3500</UnitPrice>
<UnitPrice currencyid="AUD"></UnitPrice>
…(* Multiple UnitPrice responses also possible)
</MonthlyChargeInfo>
…(* Multiple MonthlyChargeInfo responses also possible)
</Product>
…(* Multiple Product responses also possible)
</Category>
…(* Multiple Category responses also possible)
</Service>
…(* Multiple Service responses also possible)
</ServiceProvider>
…(* Multiple ServiceProvider responses also possible)
</Region>
…(* Multiple Region responses also possible)
</Catalog>
</CatalogList>
[When there is no product information (ProductID) in catalog or if it is disabled completely]
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<CatalogList/>
[When there is no region information (RegionD) in catalog or if it is disabled completely]
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
<Catalog>
<ResellerId>jp.fujitsu.com</ResellerId>
</Catalog>
</CatalogList>
[When there is no service information (ServiceName) in catalog or if it is disabled completely]
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
<Catalog>
<ResellerId>jp.fujitsu.com</ResellerId>
<Region>
<RegionId>jp-east-1</RegionId>
<ServiceProvider>
<ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
</ServiceProvider>
…(* Multiple ServiceProvider responses also possible)
</Region>
…(* Multiple Region responses also possible)
</Catalog>
</CatalogList>
[When there is no category information (CategoryName) in catalog or if it is disabled completely]
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
<Catalog>
<ResellerId>jp.fujitsu.com</ResellerId>
<Region>
<RegionId>jp-east-1</RegionId>
<ServiceProvider>
<ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
<Service>
<ServiceName xml:lang="en">compute</ServiceName>
</Service>
…(* Multiple Service responses also possible)
</ServiceProvider>
…(* Multiple ServiceProvider responses also possible)
</Region>
…(* Multiple Region responses also possible)
</Catalog>
</CatalogList>
[If neither product information (ProductName), nor the unit information (UnitName) exists or if it is disabled completely (End of Application)]
HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
<Catalog>
<ResellerId>jp.fujitsu.com</ResellerId>
<Region>
<RegionId>jp-east-1</RegionId>
<ServiceProvider>
<ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
<Service>
<ServiceName xml:lang="en">compute</ServiceName>
<Category>
<CategoryName xml:lang="en">VM Service</CategoryName>
<Category>
…(* Multiple Category responses also possible)
</Service>
…(* Multiple Service responses also possible)
</ServiceProvider>
…(* Multiple ServiceProvider responses also possible)
</Region>
…(* Multiple Region responses also possible)
</Catalog>
</CatalogList>