Introduction
The StreamOne® Ion API Collection provides an extensive array of endpoints to seamlessly interact with the StreamOne® Ion platform, facilitating streamlined integration and administration of cloud services.
Leveraging these APIs, you can initiate orders, establish and oversee subscriptions, and effectively handle customer data. This comprehensive collection empowers you to design custom user interfaces or frontends, simplifying the provisioning process for a diverse selection of cloud products offered by prominent providers like Google, IBM, Microsoft, and more.
API Versions
The following versions of APIs are available.
- V1 API Endpoint Collection: The V1 APIs are designed to manage all billing-related requirements, providing straightforward and efficient methods for managing billing tasks.
- V3 API Endpoint Collection: The V3 APIs provide a comprehensive set of features, including customer, product, order, and lifecycle management. This version is more robust and includes advanced capabilities for developers.
You can use both the API versions simultaneously to meet your development requirements and access the required endpoints. However, each version uses distinct URLs and authentication methods that are explained in subsequent sections. Both V1 and V3 support a limited range of common queries such as Customer Management.
Hostname
Use the following hostname and path while sending the API request:
| Type | Hostname/Path | Supported API versions |
|---|---|---|
| API Calls | https://ion.tdsynnex.com/api/{api-version} | V1, V3 |
| oAuth | https://ion.tdsynnex.com/oauth/token | V3 |
Authentication
The Access API streamlines token refreshing and provides a secure and seamless authentication experience. Using the /oauth/validateAccess\ API you can verify the validity of both access and refresh tokens.
The StreamOne® Ion API v3 uses OAuth 2.0 Authentication. This authentication includes the following steps:
Step 1: Acquiring the Refresh Token
Log in to the StreamOne ION portal.
Click the Settings icon on the top right corner.
Click Users.
Select the user for whom you want to obtain
refresh_tokenand click Edit.
In Oauth credentials click Request New Credentials.
After the new set of credentials are created copy the Refresh Token.
Step 2: Acquiring the Access Token
To acquire the access token run the OAuth endpoint.
oAuth endpoint
oAuth endpoint: POST https://ion.tdsynnex.com/oauth/token
Request Type: form-data
| Key | Value |
|---|---|
| grant_type | refresh_token |
| redirect_url | http://localhost/ |
| refresh_token | {{refresh_token}} |
Sample response
curl --location'https://ion.tdsynnex.com/oauth/token'\--form'grant_type="refresh_token"'\--form'redirect_uri="http://localhost/"'\--form'refresh_token="XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX"'
The above command returns JSON structured like this
{ "access_token":"XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX","expires_in":7200,"refresh_token": "XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX","token_type": "Bearer"}
Response parameters:
| Element | Type | Description | Example |
|---|---|---|---|
| access_token | String | Use the access token in the Authentication header for any subsequent calls. | XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX |
| expires_in | Integer | The access_token expiration time in seconds. For acccess tokens the expiration time is 7200 seconds or 2 hours. | 7200 |
| refresh_token | String | New refresh token | XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX |
Notes on refresh_token:
- Note that the initial refresh token expires when a new refresh token is generated.
refresh_tokencan only be used once. After therefresh_tokenis generated, it is valid for 32 days.- Save the newly generated
refresh_tokenin a secure storage vault that is accessible by your application for future use. - If the
refresh_tokenexpires due to inactivity or usage, generate a new token. - It is recommended to cache the
access_tokenin memory and reuse it until it expires (2 hours). To obtain a new access token, use therefresh_token.
For subsequent calls use the following header:
Authentication: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX
Microsoft Testing Instructions
Using sandbox, you can securely test endpoints such as Product, Customer, and so on, without impacting actual data. The sandbox testing instructions are specific to Microsoft.
Microsoft Sandbox Limitations
The following table includes the maximum number of requests allowed in Microsoft sandbox:
| Parameter | Maximum Allowed Value |
|---|---|
| Customers | 5 customers per sandbox |
| Products | 5 products per customer |
End Customer
The End Customer endpoints of StreamOne® Ion API allow you to:
- List customer details
- Get customer details
- Create a new customer
- Update an existing customer
- Get customer cloud profiles
- Get customer cloud profiles (deprecated)
List Customers
The List Customers endpoint provides a list of all the customers associated with the specified user or account. It is displayed in ascending order according to the customer’s creation date.
You can filter the response by name, email, status, and so on.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/
Sample Request:
curl
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/2767/customers?pageSize=1' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
filter.customerEmail |
String | Email address of the primary contact for the customer account. | resellercust1@sample.com | No |
filter.languageCode |
String | The customer's preferred language, which has to be provided as 2 digit code. | EN | No |
filter.customerStatus |
String | The status of the customer. Such as,
|
CUSTOMER_STATUS_UNSPECIFIED | No |
filter.customerName |
String | Primary contact name. The name should be combination of first and last name. | John Doe | No |
pageSize |
Integer | Page size of the response. | 1 | Yes |
pageToken |
String | A token identifying the page to return. If empty, the first page (default) is returned. | MTox | No |
Sample Response
{
"customers": [
{
"name": "accounts/1234/customers/56789",
"customerOrganization": "US NCE Customer",
"customerAddress": {
"street": "12345 Street Address",
"city": "Hampton",
"state": "VA",
"zip": "12345",
"country": "US"
},
"customerName": "John Doe",
"customerEmail": "resellercust1@acme.com",
"customerPhone": "1234567890",
"createTime": "2021-03-09T17:09:29Z",
"updateTime": "2024-02-27T09:49:43Z",
"languageCode": "EN",
"uid": "Uxkjy1ABCK2def",
"customerStatus": "ACTIVE"
}
],
"nextPageToken": "MTox"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
customers |
Array | Array list that specifies the customer details. | The elements in the customers array list. |
Elements in the customers array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the customer. | accounts/{account_id}/customers/{customer_id} |
customerOrganization |
String | Name of the customer organization. | Organization Name |
customerAddress |
Array | Array list that specifies the customer address details. | The elements in the customersAddress array list. |
Elements in the customerAddress array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
street |
String | Customer address street details. | 12345 Street Address |
city |
String | The name of the city where customer is located. | Hampton |
state |
String | The state code that represents customer's location. | VA |
zip |
String | The zip code for the customer’s location. | 12345 |
country |
String | The country code. | US |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
customerName |
String | Customer name. | John Doe |
customerEmail |
String | Customer email. | resellercust1@sample.com |
customerPhone |
String | Customer phone number. | 1234567890 |
createTime |
String | The time when the customer was created in YYYY-MM-DD HH:Min format. | 2021-03-09T17:09:29Z |
updateTime |
String | The time when the customer was updated in YYYY-MM-DD HH:Min format. | 2024-02-27T09:49:43Z |
languageCode |
String | Customer’s preferred language for communication. We follow ISO 639-1 standard. | en |
uid |
String | The unique user ID. | Uxkjy1ABCK2def |
customerStatus |
String | The status of the customer. Such as,
|
ACTIVE |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
nextPageToken |
String | Token to display results on the next page. | MTox |
Sample Response - Error 400
{
"error": "INVALID_REQUEST",
"message": "At least one of page_size and page_token must be present",
"code": 400,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 400 - Invalid Request
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INVALID_REQUEST |
message |
String | Error description. | At least one of page_size and page_token must be present. |
code |
String | Error code. | 400 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Get Customer
The Get Customer endpoint retrieves details of a specific customer according to the associated account ID and customer ID.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}
Sample Request:
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/1234/customers/56789' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX' \
--data ''
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
customerId |
String | The unique customer ID. | 56789 | Yes |
Sample Response:
{
"name": "accounts/{account_id}/customers/{customer_id}",
"customerOrganization": "US NCE Customer",
"customerAddress": {
"street": "123 Main St",
"suite": "Apt 4B",
"city": "Plainfield",
"state": "NJ",
"zip": "07060",
"country": "US"
},
"customerName": "John Doe",
"customerEmail": "resellercust1@acme.com",
"customerPhone": "1234567890",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"alternateEmail": "resellercust2@acme.com",
"customerDomain": "string",
"primaryContactFirstName": "John",
"primaryContactLastName": "Doe",
"languageCode": "EN",
"uid": "Uxkjy1ABCK2def",
"customerStatus": "CUSTOMER_STATUS_UNSPECIFIED",
"customerCustomFields": {
"key": "ContactID",
"value": "1234"
}
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL of the customer. | accounts/{account_id}/customers/{customer_id} |
customerOrganization |
String | Name of the customer organization. | Organization Name |
customerAddress |
Array | Array list that specifies the customer address details. | The elements in the customersAddress array list. |
Elements in the customerAddress array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
street |
String | Customer address street details. | 12345 Street Address |
suite |
String | Customer suite number within the building complex. | D8 |
city |
String | The name of the city where customer is located. | Hampton |
state |
String | The state code that represents customer's location. | VA |
zip |
String | The zip code for the customer’s location. | 12345 |
country |
String | Country code. | US |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
customerName |
String | customer name. | John Doe |
customerEmail |
String | Customer email. | resellercust1@sample.com |
customerPhone |
String | Customer phone number. | 1234567890 |
createTime |
String | The time when the customer was created in YYYY-MM-DD HH:Min format. | 2021-03-09T17:09:29Z |
updateTime |
String | The time when the customer was updated in YYYY-MM-DD HH:Min format. | 2024-02-27T09:49:43Z |
alternateEmail |
String | Alternate email for the customer account. | resellercust2@sample.com |
customerDomain |
String | Internet domain registered, owned or controlled by the customer. | www.resellercustomer.com |
primaryContantFirstName |
String | First name of the primary contact. | John |
primaryContantLastName |
String | Last name of the primary contact. | Doe |
languageCode |
String | Customer’s preferred language for communication. We follow ISO 639-1 standard. | en |
uid |
String | The unique user ID. | Uxkjy1ABCK2def |
customerStatus |
String | The status of the customer, such as,
|
ACTIVE |
customerCustomFields |
Array | Array list that specifies the customer address details. | The elements in the customerCustomFields array list. |
Elements in the customerCustomfields array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
key |
String | User defined key name. | ContactId |
value |
String | User defined value of the above key. | 1234 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 404
{
"error": "NOT_FOUND",
"message": "resource 'accounts/12345/customers/45678' not found",
"code": 404,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 404 - Not Found
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | NOT_FOUND |
message |
String | Error description. | resource accounts/12345/customers/45678 not found |
code |
String | Error code. | 404 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - InternalServerError
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Create Customer
The Create Customer API allows you to add a new customer to the platform.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers
Sample Request:
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/1234/customers'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX' \
--data-raw '{
"customerOrganization": "US NCE Customer",
"customerAddress": {
"street": "123 Main St",
"city": "Plainfield",
"state": "NJ",
"zip": "07060",
"country": "US"
},
"customerName": "John Doe",
"customerEmail": "resellercust1@sample.com",
"customerPhone": "1234567890",
"alternateEmail": "resellercust2@sample.com",
"primaryContactFirstName": "John",
"primaryContactLastName": "Doe",
"languageCode": "EN",
"customerStatus": "ACTIVE"
}'
Request Parameter Description:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
customerOrganization |
String | Name of the customer organization. | Organization Name | Yes |
customerAddress |
Array | Array list that specifies the customer address details. | The elements in the customersAddress array list. |
Yes |
Elements in the customerAddress array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
street |
String | Customer address street details. | 12345 Street Address | Yes |
suite |
String | Customer suite number within the building complex. | D8 | No |
city |
String | The name of the city where customer is located. | Hampton | Yes |
state |
String | The state code that represents customer's location. | VA | Yes |
zip |
String | The zip code for the customer's location. | 12345 | Yes |
country |
String | Country code. | US | Yes |
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerName |
String | Customer name. | John Doe | Yes |
customerEmail |
String | Customer email. | resellercust1@sample.com | Yes |
customerPhone |
String | Customer phone number. | 1234567890 | No |
alternateEmail |
String | Alternate email for the customer account. | resellercust2@sample.com | No |
customerDomain |
String | Internet domain registered, owned or controlled by the customer. | www.resellercustomer.com | No |
primaryContantFirstName |
String | First name of the primary contact. | John | No |
primaryContantLastName |
String | Last name of the primary contact. | Doe | No |
languageCode |
String | Customer's preferred language for communication. We follow ISO 639-1 standard. | en | Yes |
uid |
String | The unique user ID. | Uxkjy1ABCK2def | No |
customerStatus |
String | The status of the customer, such as,
|
ACTIVE | No |
customerCustomFields |
Array | Array list that specifies the customer address details. | The elements in the customerCustomFields array list. |
No |
Elements in the customerCustomfields array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
key |
String | User defined key name. | ContactId | No |
value |
String | User defined value of the key. | 1234 | No |
Sample Response:
{
"name": "John Doe",
"customerOrganization": "US NCE Customer",
"customerAddress": {
"street": "123 Main St",
"suite": "Apt 4B",
"city": "Plainfield",
"state": "NJ",
"zip": "07060",
"country": "US"
},
"customerName": "John Doe",
"customerEmail": "resellercust1@sample.com",
"customerPhone": "1234567890",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"alternateEmail": "resellercust2@sample.com",
"customerDomain": "string",
"primaryContactFirstName": "John",
"primaryContactLastName": "Doe",
"languageCode": "EN",
"uid": "Uxkjy1ABCK2def",
"customerStatus": "CUSTOMER_STATUS_UNSPECIFIED",
"user": {
"name": "string",
"userName": "SMPReseller",
"email": "string",
"userStatus": "USER_STATUS_UNSPECIFIED",
"password": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z"
},
"customerCustomFields": {
"key": "ContactID",
"value": "1234"
}
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL of the customer. | accounts/{account_id}/customers/{customer_id} |
customerOrganization |
String | Name of the customer organization. | Organization Name |
customerAddress |
Array | Array list that specifies the customer address details. | The elements in the customersAddress array list. |
Elements in the customerAddress array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
street |
String | Customer address street details. | 12345 Street Address |
suite |
String | Customer suite number within the building complex. | D8 |
city |
String | The name of the city where customer is located. | Hampton |
state |
String | The state code that represents customer's location. | VA |
zip |
String | The zip code for the customer's location. | 12345 |
country |
String | Country code. | US |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
customerName |
String | customer name. | John Doe |
customerEmail |
String | Customer email. | resellercust1@sample.com |
customerPhone |
String | Customer phone number. | 1234567890 |
createTime |
String | The time when the customer was created in YYYY-MM-DD HH:Min format. | 2021-03-09T17:09:29Z |
updateTime |
String | The time when the customer was updated in YYYY-MM-DD HH:Min format. | 2024-02-27T09:49:43Z |
alternateEmail |
String | Alternate email for the customer account. | resellercust2@sample.com |
customerDomain |
String | Internet domain registered, owned or controlled by the customer. | www.resellercustomer.com |
primaryContantFirstName |
String | First name of the primary contact. | John |
primaryContantLastName |
String | Last name of the primary contact. | Doe |
languageCode |
String | Customer's preferred language for communication. We follow ISO 639-1 standard. | en |
uid |
String | The unique user ID. | Uxkjy1ABCK2def |
customerStatus |
String | The status of the customer, such as,
|
ACTIVE |
user |
Array | Array list that specifies the customer address details. | The elements in the user array list. |
Elements in the user array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
Name |
String | The resource name of the user in customer account. | accounts/{account_id}/customers/{customer_account_id}/users/{user_id} |
userName |
String | The name of the customer. | John Doe |
email |
String | Email adress of the primary contact. | resellercust1@sample.com |
userStatus |
String | Status of the user, such as,
|
USER_STATUS_UNSPECIFIED |
password |
String | Password of the user. | password |
createTime |
String | The time when the customer was created in YYYY-MM-DD HH:Min format. | 2021-03-09T17:09:29Z |
updateTime |
String | The time when the customer was updated in YYYY-MM-DD HH:Min format. | 2024-02-27T09:49:43Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
customerCustomFields |
Array | Array list that specifies the customer address details. | The elements in the customerCustomFields array list. |
Elements in the customerCustomfields array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
key |
String | User defined key name. | ContactId |
value |
String | User defined value of the key. | 1234 |
Sample Response - Error 400
{
"error": "INVALID_REQUEST",
"message": "At least one of page_size and page_token must be present",
"code": 400,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 400 - Invalid Request
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INVALID_REQUEST |
message |
String | Error description. | At least one of page_size and page_token must be present. |
code |
String | Error code. | 400 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 412:PrimaryContactEmailExists
{
"error": "FAILED_PRECONDITION",
"message": "The provided primaryContactEmail is already in use, please provide a different email.",
"code": 412,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048",
"reference_entity": "primaryContactEmail",
"code": "CUS-CR-001",
"detail": "The provided primaryContactEmail is already in use, please provide a different email."
}
]
}
Response Parameters: Error 412 - Primary Contact Email Exists
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | FAILED_PRECONDITION |
message |
String | Error description. | The provided primaryContactEmail is already in use, please provide a different email. |
code |
String | Error code. | 412 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
referenceEntity |
String | Name of the entity that caused the error. | primaryContactEmail |
code |
String | Specific error code. | CUS-CR-001 |
detail |
String | Additional details of the error | The provided primaryContactEmail is already in use, please provide a different email. |
Sample Response - Error 412:LanguageCodeInvalidError
{
"error": "FAILED_PRECONDITION",
"message": "The provided language code is not valid",
"code": 412,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048",
"reference_entity": "languageCode",
"code": "CUS-CR-002",
"detail": "The provided language code is not valid"
}
]
}
Response Parameters: Error 412 - Language Code Invalid Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | FAILED_PRECONDITION |
message |
String | Error description. | The provided language code is not valid |
code |
String | Error code. | 412 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
referenceEntity |
String | Name of the entity that caused the error. | languageCode |
code |
String | Specific error code. | CUS-CR-002 |
detail |
String | Additional details of the error | The provided language code is not valid. |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Update Customer
The Update Customer API allows you to modify and update customer information such as customer name, address, and so on.
HTTP Endpoint URL: PUT https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/
Sample Request:
curl --location --request PUT 'https://ion.tdsynnex.com/api/v3/accounts/1234/customers/56789' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
{
"customerOrganization": "US NCE Customer",
"customerAddress": {
"street": "123 Main St",
"suite": "D8",
"city": "Plainfield",
"state": "NJ",
"zip": "07060",
"country": "US"
},
"customerName": "John Doe",
"customerEmail": "resellercust1@acme.com",
"customerPhone": "1234567890",
"alternateEmail": "resellercust2@acme.com",
"customerDomain": "string",
"primaryContactFirstName": "John",
"primaryContactLastName": "Doe",
"languageCode": "EN",
"customerCustomFields": {
"key": "ContactID",
"value": "1234"
}
}
Request Parameter Description:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
customerId |
String | The unique customer ID. | 56789 | Yes |
customerOrganization |
String | Name of the customer organization | Organization Name | Yes |
customerAddress |
Array | Array list that specifies the customer address details. | The elements in the customersAddress array list. |
Yes |
Elements in the customerAddress array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
street |
String | Customer address street details | 12345 Street Address | Yes |
suite |
String | Customer suite number within the building complex. | D8 | No |
city |
String | The name of the city where customer is located. | Hampton | Yes |
state |
String | The state code representing the customer's location. | VA | Yes |
zip |
String | The zip code for the customer's location. | 12345 | Yes |
country |
String | Country code | US | Yes |
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerName |
String | customer name. | John Doe | Yes |
customerEmail |
String | Customer email. | resellercust1@sample.com | Yes |
customerPhone |
String | Customer phone number. | 1234567890 | No |
alternateEmail |
String | Alternate email for the customer account. | resellercust2@sample.com | No |
customerDomain |
String | Internet domain registered, owned or controlled by the customer. | www.resellercustomer.com | No |
primaryContantFirstName |
String | First name of the primary contact. | John | No |
primaryContantLastName |
String | Last name of the primary contact. | Doe | No |
languageCode |
String | Customer's preferred language for communication. We follow ISO 639-1 standard. | en | Yes |
uid |
String | The unique user ID. | Uxkjy1ABCK2def | No |
customerStatus |
String | The status of the customer, such as,
|
ACTIVE | No |
customerCustomFields |
Array | Array list that specifies the customer address details. | The elements in the customerCustomFields array list. |
No |
Elements in the customerCustomfields array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
key |
String | User defined key name | ContactId | No |
value |
String | User defined value of the above key | 1234 | No |
Sample Response:
{
"name": "John Doe",
"customerOrganization": "US NCE Customer",
"customerAddress": {
"street": "123 Main St",
"suite": "Apt 4B",
"city": "Plainfield",
"state": "NJ",
"zip": "07060",
"country": "US"
},
"customerName": "John Doe",
"customerEmail": "resellercust1@acme.com",
"customerPhone": "1234567890",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"alternateEmail": "resellercust2@acme.com",
"customerDomain": "string",
"primaryContactFirstName": "John",
"primaryContactLastName": "Doe",
"languageCode": "EN",
"uid": "Uxkjy1ABCK2def",
"customerStatus": "CUSTOMER_STATUS_UNSPECIFIED",
"user": {
"name": "string",
"userName": "SMPReseller",
"email": "string",
"userStatus": "USER_STATUS_UNSPECIFIED",
"password": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z"
},
"customerCustomFields": {
"key": "ContactID",
"value": "1234"
}
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL of the customer. | accounts/{account_id}/customers/{customer_id} |
customerOrganization |
String | Name of the customer organization | Organization Name |
customerAddress |
Array | Array list that specifies the customer address details. | The elements in the customersAddress array list. |
Elements in the customerAddress array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
street |
String | Customer address street details | 12345 Street Address |
suite |
String | Customer suite number within the building complex. | D8 |
city |
String | The name of the city where customer is located. | Hampton |
state |
String | The state code representing the customer's location. | VA |
zip |
String | The zip code for the customer's location. | 12345 |
country |
String | Country code | US |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
customerName |
String | Customer name. | John Doe |
customerEmail |
String | Customer email. | resellercust1@sample.com |
customerPhone |
String | Customer phone number. | 1234567890 |
createTime |
String | The time when the customer was created in YYYY-MM-DD HH:Min format. | 2021-03-09T17:09:29Z |
updateTime |
String | The time when the customer was updated in YYYY-MM-DD HH:Min format. | 2024-02-27T09:49:43Z |
alternateEmail |
String | Alternate email for the customer account. | resellercust2@sample.com |
customerDomain |
String | Internet domain registered, owned or controlled by the customer. | www.resellercustomer.com |
primaryContantFirstName |
String | First name of the primary contact. | John |
primaryContantLastName |
String | Last name of the primary contact. | Doe |
languageCode |
String | Customer's preferred language for communication. We follow ISO 639-1 standard. | en |
uid |
String | The unique user ID. | Uxkjy1ABCK2def |
customerStatus |
String | The status of the customer, such as,
|
ACTIVE |
user |
Array | Array list that specifies the customer address details. | The elements in the user array list. |
Elements in the user array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
Name |
String | The resource name of the user in customer account. | accounts/{account_id}/customers/{customer_account_id}/users/{user_id} |
userName |
String | The name of the customer. | John Doe |
email |
String | Email adress of the primary contact. | resellercust1@sample.com |
userStatus |
String | Status of the user, such as,
|
USER_STATUS_UNSPECIFIED |
password |
String | Password of the user. | password |
createTime |
String | The time when the customer was created in YYYY-MM-DD HH:Min format. | 2021-03-09T17:09:29Z |
updateTime |
String | The time when the customer was updated in YYYY-MM-DD HH:Min format. | 2024-02-27T09:49:43Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
customerCustomFields |
Array | Array list that specifies the customer address details. | The elements in the customerCustomFields array list. |
Elements in the customerCustomfields array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
key |
String | User defined key name. | ContactId |
value |
String | User defined value of the key. | 1234 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 404
{
"error": "NOT_FOUND",
"message": "resource 'accounts/12345/customers/45678' not found",
"code": 404,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 404 - Not Found
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | NOT_FOUND |
message |
String | Error description. | resource 'accounts/12345/customers/45678' not found |
code |
String | Error code. | 404 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 412:PrimaryContactEmailExists
{
"error": "FAILED_PRECONDITION",
"message": "The provided primaryContactEmail is already in use, please provide a different email.",
"code": 412,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048",
"reference_entity": "primaryContactEmail",
"code": "CUS-CR-001",
"detail": "The provided primaryContactEmail is already in use, please provide a different email."
}
]
}
Response Parameters: Error 412 - Primary Contact Email Exists
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | FAILED_PRECONDITION |
message |
String | Error description. | The provided primaryContactEmail is already in use, please provide a different email. |
code |
String | Error code. | 412 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
referenceEntity |
String | Name of the entity that caused the error. | primaryContactEmail |
code |
String | Specific error code. | CUS-CR-001 |
detail |
String | Additional details of the error | The provided primaryContactEmail is already in use, please provide a different email. |
Sample Response - Error 412:LanguageCodeInvalidError
{
"error": "FAILED_PRECONDITION",
"message": "The provided language code is not valid",
"code": 412,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048",
"reference_entity": "languageCode",
"code": "CUS-CR-002",
"detail": "The provided language code is not valid"
}
]
}
Response Parameters: Error 412 - Language Code Invalid Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | FAILED_PRECONDITION |
message |
String | Error description. | The provided language code is not valid |
code |
String | Error code. | 412 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
referenceEntity |
String | Name of the entity that caused the error. | languageCode |
code |
String | Specific error code. | CUS-CR-002 |
detail |
String | Additional details of the error | The provided language code is not valid. |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Get Customer Cloud Profiles
The Get Customer Cloud Profiles endpoint is used to retrieve details about a customer’s linked cloud providers and accounts such as Microsoft CSP, Google Workspace, Azure and so on.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/cloudProfiles
Sample Request:
curl
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/accountId/customers/customerId/cloudProfiles?providerId=SOME_STRING_VALUE&enabledOnly=SOME_BOOLEAN_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
Integer | Unique account ID. | 1234 | Yes |
customerId |
Integer | Unique customer ID. | 56789 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
providerId |
String | Cloud provider ID in CCP. | 1234 | Yes |
enabledOnly |
Boolean | Provides the customer's active cloud profiles when set as True. | True | No |
Sample Response
{
"customerId": "703705",
"customerOrganization": "cust 8 aug 25",
"customerCloudProfiles": [
{
"providerId": "3",
"displayName": "Legacy Azure",
"shortName": "Legacy Azure",
"enabled": true,
"customerTenantId": "92xxxxf2-xxxx-xxxx-xxxx-4dxxxxxxxx1c",
"customerDomain": "santaclaus8825.onmicrosoft.com",
"allowDelegatedAccess": false,
"gdapStatus": "lockForApproval",
"gdapLevel": "M",
"gdapRoles": [
"158c047a-c907-4556-b7ef-446551a6b5f7",
"3a2c62db-5318-420d-8d74-23affee5d9d5",
"4d6ac14f-3453-41d0-bef9-a3e0c569773a",
"5d6b6bb7-de71-4623-b4af-96380a352509",
"729827e3-9c14-49f7-bb1b-9608f156bbb8",
"7be44c8a-adaf-4e2a-84d6-ab2649e08a13",
"88d8e3e3-8f55-4a1e-953a-9b9898b8876b",
"966707d0-3269-4727-9be2-8c3a10f19b9d",
"b0f54661-2d74-4c50-afa3-1ec803f12efe",
"f023fd81-a637-4b56-95fd-791ac0226033",
"f2ef992c-3afb-46b9-b7cf-a126ee74c451",
"fe930be7-5e62-47db-91af-98c3a49a38b1"
],
"agreementStatus": "Complete"
},
{
"providerId": "28",
"displayName": "Microsoft Modern Workplace",
"shortName": "Modern Workplace",
"enabled": false
},
{
"providerId": "30",
"displayName": "Microsoft CSP",
"shortName": "MS-CSP",
"enabled": false
}
]
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
customerId |
String | Unique customer ID. | 1234. |
customerOrganization |
String | Name of the Customer's Organization in CCP. | ABC Corp. |
customerCloudProfiles |
Array | Array list that specifies the customer details that are used in creating a tenant account with the provider. | The elements in the customerCloudProfiles array list. |
Elements in the customerCloudProfiles array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
providerId |
String | Unique identifier for the cloud providers. | 30 |
displayName |
String | The name of the cloud provider that the customer purchased. | Legacy Azure |
shortName |
String | The short name of the cloud provider that the customer purchased. | Legacy Azure |
enabled |
Boolean | Specifies whether the customer can fetch the Cloud Profile Details. | True |
customerTenantId |
String | Unique identifier that connects the customer and the provider. | Some string value |
customerDomain |
String | Specifies the provisioned customer domain value. This is specific to Azure and Google. | santaclaus8825.onmicrosoft.com |
allowDelegatedAccess |
Boolean | Specifies whether the reseller has delegated admin access to the customer's account. It is available only for Azure. | True. |
gdapStatus |
String | Specifies the status of GDAP (Granular Delegated Administrative Privilege). It is available only for Azure. | lockForApproval |
gdapLevel |
String | Specifies the level of access granted under GDAP. It is available only for Azure. | M |
gdapRoles |
Array | Specifies the list of roles. It is available only for Azure. | The elements in the gdapRoles array list. |
agreementStatus |
String | Specifies the status of customer's agreement. It is available only for Azure. | Complete |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - InternalServerError
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Get Customer Cloud Profiles (Deprecated)
The Get Customer Cloud Profiles endpoint is used to retrieve details about a customer’s linked cloud providers and accounts such as Azure.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/cloudProfiles
Sample Request:
curl
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/accountId/customers/customerId/cloudProfiles?providerId=SOME_STRING_VALUE&enabledOnly=SOME_BOOLEAN_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
Integer | Unique account ID. | 1234 | Yes |
customerId |
Integer | Unique customer ID. | 56789 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
providerId |
String | Cloud provider ID in CCP. | 1234 | Yes |
refresh |
Boolean | Provides the customer's active cloud profiles when set as True. | True | No |
Sample Response
{
"id": "92bxxxx2-xxxx-xxxx-xxxx-4dxxxxxxxx1c",
"companyProfile": {
"tenantId": "92xxxxx2-xxxx-xxxx-xxxx-4dxxxxxxxx1c",
"domain": "santaclaus8825.onmicrosoft.com",
"companyName": "cust 8 aug 25"
},
"billingProfile": {
"id": "M22H-xxxx-xxx-xxxx-SGB",
"email": "test21@belcenter.com",
"culture": "en-US",
"language": "en",
"companyName": "cust 8 aug 25",
"defaultAddress": {
"country": "NO",
"region": "Innlandet",
"city": "Rogne",
"state": "Innlandet",
"addressLine1": "Nerrevatn 14",
"postalCode": "2943",
"firstName": "Santa",
"lastName": "Claus",
"phoneNumber": "01234567898"
}
},
"agreementStatus": "Complete",
"agreements": [
{
"firstName": "Santa",
"lastName": "Claus",
"email": "test21@belcenter.com",
"phoneNumber": "01234567898",
"templateId": "11xxxxb0-xxxx-xxxx-xxxx-c6xxxxxxxxf9",
"dateAgreed": "2025-08-07T00:00:00Z",
"type": "MicrosoftCustomerAgreement",
"agreementLink": "https://aka.ms/customeragreement"
}
]
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Unique customer ID. | 1234. |
companyProfile |
Object | Name of the customer's organization. | The elements in companyProfile object. |
billingProfile |
Object | Specifies the customer's billing profile. | The elements in the billingProfiles object. |
agreementStatus |
String | The status of the agreement. | ABC Corp. |
agreements |
Array | Specifies detailed information about the agreement. | The elements in agreements array. |
Elements in the companyProfile object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
tenantId |
String | Unique identifier for the customer provided by vendor. | 30 |
domain |
String | The name of the domain from where the customer purchased products. | Legacy Azure |
companyName |
String | Name of the customer's organization. | Legacy Azure |
Elements in billingProfile object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Unique identifier for the cloud providers. | 30 |
email |
String | The email address of the customer used for billing. | Legacy Azure |
culture |
String | Specifies the language and regional settings. | en-US |
language |
String | The language used for billing. | 30 |
companyName |
String | Name of the customer's organization. | Legacy Azure |
defaultAddress |
Object | The address details of the customer used for billing. | Legacy Azure |
Elements in defaultAdress object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
country |
String | The country of the customer. | 30 |
region |
String | The region of the customer. | Legacy Azure |
city |
String | The city of the customer. | Legacy Azure |
state |
String | The state of the customer. | 30 |
adressLine1 |
String | The detailed address. | Legacy Azure |
postalCode |
String | The postal code of the city. | Legacy Azure |
firstName |
String | First name of the customer. | 30 |
lastName |
String | Last name of the customer. | Legacy Azure |
phoneNumber |
String | The contact details of the customer. | Legacy Azure |
Elemennts in agreements array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
firstName |
String | First name of the customer in the agreement. | 30 |
lastName |
String | Last name of the customer in the agreement. | Legacy Azure |
email |
String | The email address of the customer used in the agreement. | Legacy Azure |
phoneNumber |
String | The contact details of the customer specified in the agreement. | 30 |
templateId |
String | The template ID. | Legacy Azure |
dateAgreed |
String | The date when the customer signed the agreement. | Legacy Azure |
type |
String | The type of the agreement. | 30 |
agreementLink |
String | Link to the agreement. | Legacy Azure |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - InternalServerError
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Product
The Product endpoints of StreamOne® Ion API allow you to:
List Products
Using the List Products endpoint, you can retrieve the list of products available for a specific account.
HTTP Endpoint URL: https://ion.tdsynnex.com/api/v3/accounts/{accountId}/products
Sample Request:
curl --request GET \
--url 'https://ion.tdsynnex.com/api/v3/accounts/%7BaccountId%7D/products?pageSize=SOME_INTEGER_VALUE&pageToken=SOME_STRING_VALUE&language=SOME_STRING_VALUE&filter.name=SOME_STRING_VALUE&filter.skuExternalId=SOME_STRING_VALUE&filter.addonExternalId=SOME_STRING_VALUE&filter.skuId=SOME_STRING_VALUE&filter.addonId=SOME_STRING_VALUE&filter.skuDisplayName=SOME_STRING_VALUE&filter.addonDisplayName=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Path Parameters
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
Integer | Reseller ID in CCP. | 1234 | Yes |
Query Parameters
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
language |
String | Specifies the language associated with the product. | en | No |
priceBookCustomerId |
Integer | The customer ID that is associated with pricebook. | 12345 | No |
productVersion |
Boolean | The version of the product. | NCE | No |
excludeCategories |
Boolean | The category of the product. When set as true, the product categories are excluded from the response. | Values such as True or False |
No |
excludeVerticals |
Boolean | The verticals of the product. When set as true, the product verticals are excluded from the response. | Values such as True or False |
No |
excludeCharges |
Boolean | The charges of the product. When set as true, the product charges are excluded from the response. | Values such as True or False |
No |
filter.skuExternalId |
String | The external ID assigned to SKUs. | 1 | No |
filter.addonExternalId |
String | The external ID assigned to addons. | 1 | No |
filter.addonName |
String | The name of the addon. | 1 | No |
filter.sku_id |
String | The ID of the SKU. | Office-365-E3-n0 | No |
filter.name |
String | The product name. | Microsoft NCE | No |
pageSize |
Integer | Requested page size. The server may return fewer results than requested. If this parameter is not specified, the server selects a default size. | 10 | Yes |
Sample Response
{
"products": [
{
"name": "accounts/{account_id}/products/AcronisCyberProtection-smp",
"type": "SUBSCRIPTION_PRODUCT",
"categories": [
"accounts/{account_id}/categories/Acronis"
],
"hasPublishedVersions": true,
"marketing": {
"description": "Protects more than 20 platforms and incorporates the backup industry’s most advanced anti-ransomware\ntechnology, safeguarding data and systems in any environment – physical or virtualized, on-premises, or in the cloud.",
"displayName": "Acronis Cyber Protect Cloud",
"caption": "Acronis Cyber Protect & Cyber Infrastructure",
"defaultImage": {
"title": "Logo",
"content": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-184042-aa611bfe/Acronis_Cyber_protect.png",
"type": "MEDIA_TYPE_IMAGE"
}
},
"definition": {
"supportedCurrencies": [
"USD"
],
"billingMode": "POSTPAY",
"features": [
{
"id": "Web-and-mobile-versions-of-Offic",
"displayName": "Web and mobile versions of Office apps"
},
{
"id": "Email-and-calendaring",
"displayName": "Email and calendaring"
}
],
"skus": [
{
"id": "Acronis-Cyber-Protect-and-Cyber-",
"displayName": "Create Acronis Cyber Protect Cloud Account",
"description": "Create Acronis Cyber Protect Cloud Account",
"cancelTiming": "END_OF_TERM",
"features": [
{
"feature": "Web-and-mobile-versions-of-Offic",
"displayValue": "False"
},
{
"feature": "Email-and-calendaring",
"displayValue": "True"
}
],
"plans": [
{
"id": "Commitment-Tier-Zero",
"displayName": "Commitment Tier 0 - USD 0",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier0",
"supportPlan": {},
"mpnId": "ACRN:xxxx0:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Two",
"displayName": "Commitment Tier 2 - USD 250",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 250
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-fb613b64/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Two_icon.png",
"productId": "US,CAA,Tier2",
"supportPlan": {},
"mpnId": "ACRN:xxxx2:xx:M",
"minQuantity": "1",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN",
"requestForEligibilityText": "REQUEST_FOR_QUOTE"
},
{
"id": "Commitment-Tier-Three",
"displayName": "Commitment Tier 3 - USD 500",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-47a36df7/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Three_icon.png",
"productId": "US,CAA,Tier3",
"supportPlan": {},
"mpnId": "ACRN:xxxx3:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Four",
"displayName": "Commitment Tier 4 - USD 1000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-cb53beb0/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Four_icon.png",
"productId": "US,CAA,Tier4",
"supportPlan": {},
"mpnId": "ACRN:xxxx4:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Five",
"displayName": "Commitment Tier 5 - USD 2000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-0ebee8aa/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Five_icon.png",
"productId": "US,CAA,Tier5",
"supportPlan": {},
"mpnId": "ACRN:xxxx5:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Six",
"displayName": "Commitment Tier 6 - USD 4000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-d2ebfab8/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Six_icon.png",
"productId": "US,CAA,Tier6",
"supportPlan": {},
"mpnId": "ACRN:xxxx6:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Seven",
"displayName": "Commitment Tier 7 - USD 7000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier7",
"supportPlan": {},
"mpnId": "ACRN:xxxx7:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Eight",
"displayName": "Commitment Tier 8 - USD 10000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier8",
"supportPlan": {},
"mpnId": "ACRN:xxxx8:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Nine",
"displayName": "Commitment Tier 9 - USD 15000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier9",
"supportPlan": {},
"mpnId": "ACRN:xxxx9:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
}
],
"productId": "CAA",
"productCloudProviderName": "accounts/{account_id}/cloudProviders/14",
"supportPlanAsProductPlan": {
"details": {}
}
},
{
"id": "Create-Acronis-Cyber-Protect-Clo",
"displayName": "Create Acronis Cyber Protect Cloud Account",
"description": "Create Acronis Cyber Protect Cloud Account ",
"cancelTiming": "END_OF_TERM",
"plans": [
{
"id": "Commitment-Tier-One",
"displayName": "Commitment Tier 1 - USD 99",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier1",
"supportPlan": {},
"mpnId": "ACRN:xxxx1:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-8---USD",
"displayName": "Commitment Tier 8 - USD 25000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier8",
"supportPlan": {},
"mpnId": "ACRN:xxxx8:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
}
],
"productId": "CAA1",
"productCloudProviderName": "accounts/{account_id}/cloudProviders/14",
"disabled": true,
"supportPlanAsProductPlan": {
"details": {}
}
}
],
"customFields": [
{
"name": "ProvisioningCategory",
"content": "Acronis",
"type": "STRING"
},
{
"name": "skip-price-book",
"content": "true",
"type": "STRING"
}
]
},
"isSharedProduct": true,
"importStatus": "NOT_IMPORTABLE",
"attachedPrograms": [
{
"name": "accounts/{account_id}/programs/56",
"displayName": "Acronis Reseller Program"
}
],
"etag": "MTc1Mzg3MzgzNw==",
"createTime": "2024-04-25T18:44:33Z",
"updateTime": "2025-07-30T11:10:37Z"
},
{
"name": "accounts/{account_id}/products/addon10yrauditlogret",
"type": "SUBSCRIPTION_PRODUCT",
"categories": [
"accounts/{account_id}/categories/NCE"
],
"hasPublishedVersions": true,
"marketing": {
"description": "To help meet more rigorous regulatory and internal compliance obligations or support longer running investigations, organizations can now add 10-year audit log retention to Advanced Audit. Once enabled, you can access the logs in the Microsoft 365 Compliance Center or through the Office 365 Management Activity API. ",
"displayName": "10-Year Audit Log Retention Add On",
"caption": "10-year audit log retention add on",
"defaultImage": {
"title": "Logo",
"content": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/addon10yrauditlogret/images/20220330-165033-22a987b2/10-year_audit_log_retention_add_on.jpeg",
"type": "MEDIA_TYPE_IMAGE"
}
},
"definition": {
"supportedCurrencies": [
"USD"
],
"billingMode": "POSTPAY",
"skus": [
{
"id": "USCFQ7TTC0HL8Z0001",
"displayName": "10-Year Audit Log Retention Add On",
"description": "To help meet more rigorous regulatory and internal compliance obligations or support longer running investigations, organizations can now add 10-year audit log retention to Advanced Audit. Once enabled, you can access the logs in the Microsoft 365 Compliance Center or through the Office 365 Management Activity API.",
"cancelTiming": "END_OF_TERM",
"plans": [
{
"id": "Monthly-Plan",
"displayName": "10-Year Audit Log Retention Add On",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "MONTH",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 10
}
}
],
"productId": "US,CFQ7TTC0HL8Z,0001,One-Month commitment for monthly billing",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx1:xxM:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Monthly---Annual-Commit",
"displayName": "10-Year Audit Log Retention Add On",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 9
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/addon10yrauditlogret/images/20220330-180046-abf36503/10-year_audit_log_retention_add_on.jpeg",
"productId": "US,CFQ7TTC0HL8Z,0001,One-Year commitment for monthly/yearly billing",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx1:xxY:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Annual-Plan",
"displayName": "10-Year Audit Log Retention Add On",
"billingPeriod": "ANNUAL",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 9
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/addon10yrauditlogret/images/20220330-175943-130f2116/10-year_audit_log_retention_add_on.jpeg",
"productId": "US,CFQ7TTC0HL8Z,0001,One-year term duration",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx1:xxY:Y",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
}
],
"productId": "US,CFQ7TTC0HL8Z,0001",
"productCloudProviderName": "accounts/{account_id}/cloudProviders/30",
"verticals": [
"accounts/{account_id}/verticals/Commercial"
],
"supportPlanAsProductPlan": {
"details": {}
}
},
{
"id": "USCFQ7TTC0HL8Z0004",
"displayName": "10-Year Audit Log Retention Add On (Education Pricing)",
"description": "10-Year Audit Log Retention Add On (Education Pricing)",
"cancelTiming": "END_OF_TERM",
"plans": [
{
"id": "monthly3",
"displayName": "10-Year Audit Log Retention Add On (Education Pricing)",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 9
}
}
],
"productId": "US,CFQ7TTC0HL8Z,0004,One-Year commitment for monthly/yearly billing",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx4:xxY:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "monthly1",
"displayName": "10-Year Audit Log Retention Add On (Education Pricing)",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "MONTH",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 10
}
}
],
"productId": "US,CFQ7TTC0HL8Z,0004,One-Month commitment for monthly billing",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx4:xxM:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "monthly2",
"displayName": "10-Year Audit Log Retention Add On (Education Pricing)",
"billingPeriod": "ANNUAL",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 9
}
}
],
"productId": "US,CFQ7TTC0HL8Z,0004,One-year term duration",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx4:xxY:Y",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
}
],
"productId": "US,CFQ7TTC0HL8Z,0004",
"productCloudProviderName": "accounts/{account_id}/cloudProviders/30",
"verticals": [
"accounts/{account_id}/verticals/Education"
],
"supportPlanAsProductPlan": {
"details": {}
}
},
{
"id": "sku-10-Year-Audit-Log-Retenti-n1",
"displayName": "10-Year Audit Log Retention Add On for FLW",
"description": "To help meet more rigorous regulatory and internal compliance obligations or support longer running investigations, organizations can now add 10-year audit log retention to Advanced Audit. Once enabled, you can access the logs in the Microsoft 365 Compliance Center or through the Office 365 Management Activity API.",
"cancelTiming": "END_OF_TERM",
"plans": [
{
"id": "plan-10-Year-Audit-Log-Retent-n0",
"displayName": "10-Year Audit Log Retention Add On for FLW",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 1
}
}
],
"productId": "US,CFQ7TTC0HL8Z,0005,One-Year commitment for monthly/yearly billing",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx5:xxY:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "plan-10-Year-Audit-Log-Retent-n1",
"displayName": "10-Year Audit Log Retention Add On for FLW",
"billingPeriod": "ANNUAL",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 12
}
}
],
"productId": "US,CFQ7TTC0HL8Z,0005,One-year term duration",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx5:xxY:Y",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "plan-10-Year-Audit-Log-Retent-n2",
"displayName": "10-Year Audit Log Retention Add On for FLW",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "MONTH",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 12
}
}
],
"productId": "US,CFQ7TTC0HL8Z,0005,One-Month commitment for monthly billing",
"supportPlan": {},
"mpnId": "CFxxxxxxxxxx:xxx5:xxM:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
}
],
"productId": "US,CFQ7TTC0HL8Z,0005",
"productCloudProviderName": "accounts/{account_id}/cloudProviders/30",
"verticals": [
"accounts/{account_id}/verticals/Commercial"
],
"supportPlanAsProductPlan": {
"details": {}
}
}
],
"customFields": [
{
"name": "ProvisioningCategory",
"content": "NCE",
"type": "STRING"
}
]
},
"isSharedProduct": true,
"importStatus": "NOT_IMPORTABLE",
"attachedPrograms": [
{
"name": "accounts/{account_id}/programs/32",
"displayName": "Microsoft CSP"
}
],
"etag": "MTc1MjI0NzY1MA==",
"tagsValues": [
{
"name": "accounts/{account_id}/product/tags/3/value/90",
"displayName": "Collaboration and communication",
"tagDisplayName": "Harmony Mobile",
"tagName": "accounts/{account_id}/product/tags/3"
},
{
"name": "accounts/{account_id}/product/tags/3/value/91",
"displayName": "Business apps",
"tagDisplayName": "Harmony Mobile",
"tagName": "accounts/{account_id}/product/tags/3"
},
{
"name": "accounts/{account_id}/product/tags/3/value/92",
"displayName": "Accounts and security",
"tagDisplayName": "Harmony Mobile",
"tagName": "accounts/{account_id}/product/tags/3"
},
{
"name": "accounts/{account_id}/product/tags/3/value/93",
"displayName": "Security and identity",
"tagDisplayName": "Harmony Mobile",
"tagName": "accounts/{account_id}/product/tags/3"
}
],
"createTime": "2022-03-30T18:01:02Z",
"updateTime": "2025-07-11T15:27:30Z"
}
],
"nextPageToken": "MTA6MTA="
}
Response Parameters
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The resource name of the products | accounts/{account_id}/products/{product_name} |
type |
String | Specifies the product type such as:
|
SUBSCRIPTION_PRODUCT |
categories |
Array | Resource names of the categories that the product is associated with. | accounts/{account_id}/categories/Acronis |
hasPublishedVersions |
Boolean | Specifies whether the product has published versions. | Values such as
|
marketing |
Object | Includes marketing information. | The elements in the marketing object |
definition |
Object | Specifies the pricing structure and corresponding metadata. | The elements in the definition object |
isSharedProduct |
Boolean | Specifies whether the product is shared or owned (Output-only). | Values such as True or False |
importStatus |
String | Specifies the import status. | NOT_IMPORTABLE |
attachedPrograms |
Array | Specifies the information about programs associated with he product. | The elements in attachedPrograms array |
eTag |
String | A unique identifier to differentiate between various versions of the products. Noe:While updating a product, you must include the latest eTag value that is obtained from Get Product response. If the eTag is different from the value at the backend (server), the update request is rejected. It is not populated in List API, output-only for Create Product endpoint and required for Update Product endpoint. |
Some string value generated by system. |
tagsValues |
Array | List of tag values name that are associated with product. | The elements in tagsValues array |
createTime |
String | The time when the product is created, in YYYY-MM-DD HH:Min format. It is Output-only field. | 2024-04-25T18:44:33Z |
updateTime |
String | The time when the product is updated, in YYYY-MM-DD HH:Min format. It is Output-only field. | 2025-07-30T11:10:37Z |
Elements in marketing object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
description |
String | Detailed description of the product. | Protects more than 20 platforms and incorporates the backup industry’s most advanced anti-ransomware\ntechnology, safeguarding data and systems in any environment – physical or virtualized, on-premises, or in the cloud |
displayName |
String | Display name of the product provided by client. | Acronis Cyber Protect Cloud |
caption |
String | Short description of the product. | Acronis Cyber Protect & Cyber Infrastructure |
defaultImage |
Object | Specifies marketing media such as image or video. | The elements in defaultImage object |
Elements in defaultImage object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
title |
String | Title of the media. UTF plain-text. | Logo |
content |
String | Includes videos or images. For videos, the field must include an embeddable iframe code or a direct link to the video. For images, it must include the URL of the uploaded image. To add or update an image, generate a new Blob using the blob service and upload the image to the provided URL. After the upload is completed, include the resulting upload signature in this field, and then run the create or update API. |
Address of the stored media |
type |
String | Indicates the type of media. |
|
Elements in definition object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
supportedCurrencies |
Array | List of supported currency codes. Each plan must explicitly specify the price for every currency code in this list. | USD |
billingMode |
String | Specifies when the payment should be made. | Values such as
|
features |
Array | Specifies a list of all features used in this product. | The elements in the features array |
skus |
Array | List of product SKUs. | The elements in the skus array |
customFields |
Array | Allows you to add business specific information. Each field includes a name-value pair, providing more detailed information. | The elements in customeFields array |
Elements in features array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Unique identifier of the feature that is provided by client. | Web-and-mobile-versions-of-Office |
displayName |
String | Display name of the feature. | Web and mobile versions of Office apps |
Elements in skus array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Unique identifier of SKU that is provided by client. | Acronis-Cyber-Protect-and-Cyber- |
displayName |
String | Display name of the SKU. | Create Acronis Cyber Protect Cloud Account |
description |
String | Description of the SKU. | Create Acronis Cyber Protect Cloud Account |
cancelTiming |
String | Specifies when the change happens during upgrade/downgrade/cancel. | Values such as
|
features |
Array | List of features supported by this SKU. | The elements in the features array |
plans |
Array | All the plans for this SKU. | The elements in the plans array |
productId |
String | Field used to identify a SKU. | CAA |
productCloudProviderName |
String | Field used to identify the cloud provider of a SKU. | 14 |
supportPlanAsProductPlan |
Object | Specifies information about the programs associated with the product. | The elements in the supportPlanAsProductPlan object |
Elements in features array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
feature |
String | The feature ID. | Email-and-calendaring |
displayValue |
String | Display value of the feature. | True |
Elements in plans array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Unique identifier of plan that is provided by client. | Commitment-Tier-Zero |
displayName |
String | Display name of the plan. | Commitment Tier 0 - USD 0 |
billingPeriod |
String | Invoice generation interval. | Monthly |
phases |
Array | Specifies the phases of the plan. The phases must be ordered in the following sequence:
Out of these phases, trial and discount are optional. However, either a fixed or an unlimited phase must always be specified. |
The elements in the phases array |
icon |
String | The product icon. | The address where the icon image is stored |
productId |
String | The product ID. | US, CAA, Tier0 |
supportPlan |
Object | Information about the support plans related to the product. | The elements in the supportPlan object |
mpnId |
String | Specifies the manufacturing part number. | Some string value |
priceDisplay |
String | Specifies the price the product. | PRICE_DISPLAY_SHOW_PLAN |
minQuantity |
String | Specifies the minimum quantity of the product that can be purchased. | 1 |
requestForEligibilityText |
String | Specifies the text or option that appears when the Request for Quote Eligible toggle is enabled in the UI. | The toggle specifies the type of special request associated with the product and includes the following options:
|
Elements in phases array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
duration |
Object | The duration of the phase. | The elements in the duration object |
type |
String | Specifies the type of the phase selected. | FIXED_PHASE |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in the recurringPrice object |
Elements in duration object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
unit |
String | Specifies the duration of the phase. | YEAR |
count |
String | Specifies the value of unit field. | 1 |
Elements in customFields array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the custom field. | ProvisioningCategory |
content |
String | For the string data type, the parameter includes string data. For binary data types, this parameter specifies a GCS resource path. | Acronis |
type |
String | Specifies the type of values in the content field. |
Values such as
|
Elements in attachedPrograms array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Name of the program associated with the product. | accounts/{account_id}/programs/{programs_id} |
displayName |
String | Display name of the program associated with the product. | Acronis Reseller Program |
Elements in tagsValues array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The resource name of the tag. | accounts/{account_id}/product/tags/{tags_value}/value/90 |
displayName |
String | The display name of the tag. | Collaboration and communication |
tagDisplayName |
String | The display name of value contained in the tagName field. |
Harmony Mobile |
tagName |
String | The type of the tag | accounts/{account_id}/product/tags/3 |
Sample Response - Error 400
{
"error": "INVALID_REQUEST",
"message": "At least one of page_size and page_token must be present",
"code": 400,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 400 - Invalid Request
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INVALID_REQUEST |
message |
String | Error description. | At least one of page_size and page_token must be present. |
code |
String | Error code. | 400 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Get Product
The Get Product endpoint allows you to access detailed and real-time information about the products in the catalog.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/products/{productId}
Sample Request
curl --request GET \
--url 'https://ion.tdsynnex.com/api/v3/accounts/%7BaccountId%7D/products/%7BproductId%7D?language=SOME_STRING_VALUE&priceBookCustomerId=SOME_INTEGER_VALUE&productVersion=SOME_STRING_VALUE&excludeFilter.excludePricing=SOME_BOOLEAN_VALUE&excludeFilter.excludeMarketing=SOME_BOOLEAN_VALUE&excludeFilter.excludeDefinition=SOME_BOOLEAN_VALUE&excludeFilter.excludeVersionHistory=SOME_BOOLEAN_VALUE&excludeFilter.excludeDeployment=SOME_BOOLEAN_VALUE&clientRole=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Path Parameters
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
Integer | Reseller ID in CCP. | 1234 | Yes |
Query Parameters
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
language |
String | Specifies the language associated with the product. | en | No |
priceBookCustomerId |
Integer | The customer ID that is associated with pricebook. | 12345 | No |
productVersion |
Boolean | The version of the product. | NCE | No |
excludeCategories |
Boolean | The category of the product. When set as True, the product categories are excluded from the response. | Values such as True or False |
No |
excludeVerticals |
Boolean | The verticals of the product. When set as True, the product verticals are excluded from the response. | Values such as True or False |
No |
excludeProducts |
Boolean | Specifies whether to exclude the selected product. | Values such as True or False |
No |
excludeCharges |
Boolean | The charges of the product. When set as True, the product charges are excluded from the response. | Values such as True or False |
No |
filter.skuExternalId |
String | The external ID assigned to SKUs. | 1 | No |
filter.addonExternalId |
String | The external ID assigned to addons. | 1 | No |
filter.skuId |
String | The SKU ID. | Office-365-E3-n0 | No |
filter.addonId |
String | The addon ID. | Office-365-E3-n0 | No |
filter.skuDisplayName |
String | The display name of the SKU. | Microsoft NCE | No |
filter.addonDisplayName |
String | The display name of the addon. | Microsoft NCE | No |
pageSize |
Integer | Requested page size. The server may return fewer results than requested. If this parameter is not specified, the server selects a default size. | 10 | Yes |
Sample Response
{
"name": "accounts/{account_id}/products/AcronisCyberProtection-smp",
"type": "SUBSCRIPTION_PRODUCT",
"categories": [
"accounts/{account_id}/categories/Acronis"
],
"hasPublishedVersions": true,
"marketing": {
"description": "Protects more than 20 platforms and incorporates the backup industry’s most advanced anti-ransomware\ntechnology, safeguarding data and systems in any environment – physical or virtualized, on-premises, or in the cloud.",
"displayName": "Acronis Cyber Protect Cloud",
"caption": "Acronis Cyber Protect & Cyber Infrastructure",
"defaultImage": {
"title": "Logo",
"content": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-184042-aa611bfe/Acronis_Cyber_protect.png",
"type": "MEDIA_TYPE_IMAGE"
},
"banner": {
"content": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-81ea2319/banner.png",
"type": "BANNER_TYPE_IMAGE"
},
"capabilities": [
{
"title": "AI-powered integration of data protection, cybersecurity, and management into a single solution",
"content": "Protects more than 20 platforms and incorporates the backup industry’s most advanced anti-ransomware\ntechnology, safeguarding data and systems in any environment – physical or virtualized, on-premises, or in the cloud.",
"features": [
{
"name": "Universal Restore",
"displayName": "Acronis Universal Restore",
"description": "Reduce time spent on recovery tasks. Acronis Universal Restore makes dissimilar hardware recovery\ndramatically faster by detecting the machine type and auto-installing appropriate drivers for the hardware.\n",
"logo": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-7e9579a2/capability_0_features_0_logo.png"
},
{
"name": "Instant Restore",
"displayName": "Acronis Instant Restore",
"description": "Achieve best-in-industry RTOs by starting any Windows or Linux system (physical or virtual) directly from the\nbackup storage on your existing Microsoft Hyper-V or VMware vSphere ESXi host – without moving data.\n",
"logo": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-d7d5f54b/capability_0_features_1_logo.png"
},
{
"name": "Web-based backup and recovery console",
"displayName": "Web-based backup and recovery console",
"description": "Perform all data protections tasks with a multi-tenant backup and recovery console – with no connection to\nthe on-premises servers required over RDP.\n",
"logo": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-a8e79a96/capability_0_features_2_logo.png"
},
{
"name": "Easy scalable management",
"displayName": "Easy scalable management",
"description": "Enjoy using the web-based multi-tenant management console — a single spot for accounts provisioning, user\nand reseller management, reporting, monitoring, and other tasks.",
"logo": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-87ecb584/capability_0_features_3_logo.png"
},
{
"name": "Integration with PSA and RMM systems",
"displayName": "Integrate with PSA and RMM systems",
"description": "Deliver services instantly using the native integration with Autotask, ConnectWise Automate, ConnectWise\nManage, cPanel, Flexiant, HostBill, Kaseya, CloudBlue, Plesk, and WHMCS. ",
"logo": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-f0c1278a/capability_0_features_4_logo.png"
},
{
"name": "Access self-service recovery web console",
"displayName": "Access self-service recovery web console",
"description": "Provide your customers’ employees with a web-based, touch-friendly console to access backups and search for and restore files wherever and whenever it’s needed. There will be no need to contact MSPs or corporate\nadmins to execute basic tasks.",
"logo": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-01203b22/capability_0_features_5_logo.png"
}
]
}
],
"media": [
{
"title": "acronis.png",
"content": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-cfed3f60/acronis.png",
"type": "MEDIA_TYPE_IMAGE"
},
{
"title": "Dashboard (1).png",
"content": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-b0f7e695/Dashboard__1_.png",
"type": "MEDIA_TYPE_IMAGE"
},
{
"title": "https://youtu.be/m-lXNenPmJ0",
"content": "m-lXNenPmJ0",
"type": "MEDIA_TYPE_VIDEO"
}
],
"productOverviews": [
{
"name": "Flexible backup storage options",
"displayName": "Flexible backup storage options",
"description": "Comply with business requirements given flexible storage options: ready-to-use Google Cloud Storage, Microsoft Azure storage, and Acronis Cyber Cloud\nStorage, Acronis Backup Gateway software component to store backups on third-party off-site storage, local networked storage and Acronis Cyber Infrastructure, a\nscalable, on-premises storage and compute solution.",
"url": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-fc6678d7/overview_0_logo.png"
},
{
"name": "Multiple backup types",
"displayName": "Multiple backup types",
"description": "Back up disks/volumes (with all information required for the operating system to boot), individual files or folders, system state (for Microsoft Windows systems),\nor ESXi configuration.",
"url": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-c101e77b/overview_1_logo.png"
},
{
"name": "Customizable backup scheduling",
"displayName": "Customizable backup scheduling",
"description": "Perform manual or automatic backups according to the desired schedule and frequency – monthly, weekly, daily, hourly, or even every ten minutes.",
"url": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-23cd03ab/overview_2_logo.png"
},
{
"name": "Encryption with password protection",
"displayName": "Encryption with password protection",
"description": "Maintain regulatory compliance by protecting your backups with AES-256 data encryption in transit and at rest, so only you can access the data.",
"url": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-96ca39dc/overview_3_logo.png"
},
{
"name": "Complete Microsoft Office 365 protection",
"displayName": "Complete Microsoft Office 365 protection",
"description": "Protect data in Microsoft Exchange Online, OneDrive for Business, and SharePoint Online with comprehensive cloud-to-cloud backup.",
"url": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-a3565db5/overview_4_logo.png"
},
{
"name": "Physical data shipping service",
"displayName": "Physical data shipping service",
"description": "Perform initial seeding faster by saving the initial full backup to a hard drive on customer premises and shipping it to an Acronis data center. There the initial\nseeding backup will be uploaded to cloud storage. ",
"url": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240425-183842-8df7d7c5/overview_5_logo.png"
}
]
},
"definition": {
"supportedCurrencies": [
"USD"
],
"billingMode": "POSTPAY",
"features": [
{
"id": "Web-and-mobile-versions-of-Offic",
"displayName": "Web and mobile versions of Office apps"
},
{
"id": "Email-and-calendaring",
"displayName": "Email and calendaring"
}
],
"skus": [
{
"id": "Acronis-Cyber-Protect-and-Cyber-",
"displayName": "Create Acronis Cyber Protect Cloud Account",
"description": "Create Acronis Cyber Protect Cloud Account",
"cancelTiming": "END_OF_TERM",
"features": [
{
"feature": "Web-and-mobile-versions-of-Offic",
"displayValue": "False"
},
{
"feature": "Email-and-calendaring",
"displayValue": "True"
}
],
"plans": [
{
"id": "Commitment-Tier-Zero",
"displayName": "Commitment Tier 0 - USD 0",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier0",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx0:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Two",
"displayName": "Commitment Tier 2 - USD 250",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 250
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-fb613b64/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Two_icon.png",
"productId": "US,CAA,Tier2",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx2:xx:M",
"minQuantity": "1",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN",
"requestForEligibilityText": "REQUEST_FOR_QUOTE"
},
{
"id": "Commitment-Tier-Three",
"displayName": "Commitment Tier 3 - USD 500",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-47a36df7/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Three_icon.png",
"productId": "US,CAA,Tier3",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx3:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Four",
"displayName": "Commitment Tier 4 - USD 1000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-cb53beb0/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Four_icon.png",
"productId": "US,CAA,Tier4",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx4:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Five",
"displayName": "Commitment Tier 5 - USD 2000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/2768/products_v2/AcronisCyberProtection-smp/images/20240625-182852-0ebee8aa/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Five_icon.png",
"productId": "US,CAA,Tier5",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx5:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Six",
"displayName": "Commitment Tier 6 - USD 4000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"icon": "https://storage.googleapis.com/techdata-shadow-data-public-new/data/accounts/{account_id}/products_v2/AcronisCyberProtection-smp/images/20240625-182852-d2ebfab8/sku_Acronis-Cyber-Protect-and-Cyber-_plan_Commitment-Tier-Six_icon.png",
"productId": "US,CAA,Tier6",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx6:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Seven",
"displayName": "Commitment Tier 7 - USD 7000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier7",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx7:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Eight",
"displayName": "Commitment Tier 8 - USD 10000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier8",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx8:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-Nine",
"displayName": "Commitment Tier 9 - USD 15000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier9",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:Tier9:PU:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
}
],
"productId": "CAA",
"productCloudProviderName": "accounts/{account_id}/cloudProviders/14",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlanAsProductPlan": {
"details": {}
}
},
{
"id": "Create-Acronis-Cyber-Protect-Clo",
"displayName": "Create Acronis Cyber Protect Cloud Account",
"description": "Create Acronis Cyber Protect Cloud Account ",
"cancelTiming": "END_OF_TERM",
"plans": [
{
"id": "Commitment-Tier-One",
"displayName": "Commitment Tier 1 - USD 99",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier1",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx1:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
},
{
"id": "Commitment-Tier-8---USD",
"displayName": "Commitment Tier 8 - USD 25000",
"billingPeriod": "MONTHLY",
"phases": [
{
"duration": {
"unit": "YEAR",
"count": 1
},
"type": "FIXED_PHASE",
"recurringPrice": {
"USD": 0
}
}
],
"productId": "US,CAA,Tier8",
"pricebookCurrency": "USD",
"productAvailability": true,
"supportPlan": {},
"mpnId": "ACRN:xxxx8:xx:M",
"priceDisplay": "PRICE_DISPLAY_SHOW_PLAN"
}
],
"productId": "CAA1",
"productCloudProviderName": "accounts/{account_id}/cloudProviders/14",
"pricebookCurrency": "USD",
"productAvailability": true,
"disabled": true,
"supportPlanAsProductPlan": {
"details": {}
}
}
],
"paymentMethods": [
"offline"
],
"customFields": [
{
"name": "ProvisioningCategory",
"content": "Acronis",
"type": "STRING"
},
{
"name": "skip-price-book",
"content": "true",
"type": "STRING"
}
]
},
"versionHistory": [
{
"name": "1",
"effectiveDate": "2024-04-25T18:44:33Z"
},
{
"name": "2",
"effectiveDate": "2024-04-25T18:53:47Z"
},
{
"name": "3",
"effectiveDate": "2024-04-25T21:29:15Z"
},
{
"name": "4",
"effectiveDate": "2024-04-26T13:09:54Z"
},
{
"name": "5",
"effectiveDate": "2024-04-26T15:00:46Z"
},
{
"name": "6",
"effectiveDate": "2024-04-26T15:09:27Z"
},
{
"name": "7",
"effectiveDate": "2024-04-29T17:52:41Z"
},
{
"name": "8",
"effectiveDate": "2024-04-30T19:53:16Z"
},
{
"name": "9",
"effectiveDate": "2024-05-07T01:38:01Z"
},
{
"name": "10",
"effectiveDate": "2024-05-16T07:38:03Z"
},
{
"name": "11",
"effectiveDate": "2024-06-06T19:35:20Z"
},
{
"name": "12",
"effectiveDate": "2024-06-23T02:14:03Z"
},
{
"name": "13",
"effectiveDate": "2024-06-23T02:15:26Z"
},
{
"name": "14",
"effectiveDate": "2024-06-25T13:07:02Z"
},
{
"name": "15",
"effectiveDate": "2024-06-25T13:31:19Z"
},
{
"name": "16",
"effectiveDate": "2024-06-25T18:28:59Z"
},
{
"name": "17",
"effectiveDate": "2024-06-26T10:55:59Z"
},
{
"name": "18",
"effectiveDate": "2024-06-28T02:46:23Z"
},
{
"name": "19",
"effectiveDate": "2024-06-28T02:46:36Z"
},
{
"name": "20",
"effectiveDate": "2024-07-01T21:19:39Z"
},
{
"name": "21",
"effectiveDate": "2024-07-10T14:22:24Z"
},
{
"name": "22",
"effectiveDate": "2024-07-19T14:07:55Z"
},
{
"name": "23",
"effectiveDate": "2024-09-30T07:59:03Z"
},
{
"name": "24",
"effectiveDate": "2024-09-30T08:02:22Z"
},
{
"name": "25",
"effectiveDate": "2024-10-14T14:16:29Z"
},
{
"name": "26",
"effectiveDate": "2024-10-14T14:17:15Z"
},
{
"name": "27",
"effectiveDate": "2024-10-14T14:55:27Z"
},
{
"name": "28",
"effectiveDate": "2024-10-14T14:55:54Z"
},
{
"name": "29",
"effectiveDate": "2024-11-26T09:38:34Z"
},
{
"name": "30",
"effectiveDate": "2024-11-26T09:42:54Z"
},
{
"name": "31",
"effectiveDate": "2025-02-07T09:16:30Z"
},
{
"name": "32",
"effectiveDate": "2025-02-07T09:17:22Z"
},
{
"name": "33",
"effectiveDate": "2025-02-07T09:25:03Z"
},
{
"name": "34",
"effectiveDate": "2025-02-07T09:25:24Z"
},
{
"name": "35",
"effectiveDate": "2025-05-30T11:51:58Z"
},
{
"name": "36",
"effectiveDate": "2025-07-10T13:07:56Z"
},
{
"name": "37",
"effectiveDate": "2025-07-10T13:09:34Z"
},
{
"name": "38",
"effectiveDate": "2025-07-11T07:21:55Z"
},
{
"name": "39",
"effectiveDate": "2025-07-11T10:57:27Z"
},
{
"name": "40",
"effectiveDate": "2025-07-18T03:52:29Z"
},
{
"name": "41",
"effectiveDate": "2025-07-29T16:02:43Z"
},
{
"name": "42",
"effectiveDate": "2025-07-30T08:40:28Z"
},
{
"name": "43",
"effectiveDate": "2025-07-30T08:42:30Z"
},
{
"name": "44",
"effectiveDate": "2025-07-30T10:42:52Z"
},
{
"name": "45",
"effectiveDate": "2025-07-30T11:10:37Z"
}
],
"deployment": {
"deployments": [
{
"event": "DEPLOYMENT",
"actions": [
{
"name": "accounts/{account_id}/products/AcronisCyberProtection-smp/deployments/action/mqx0flf",
"type": "BONITOR",
"bonitor": {
"provisioningName": "Acronis_Config",
"provisioningType": "Config",
"provisioningCategory": "Acronis",
"parameters": [
{
"key": "credentials",
"value": "accounts/{account_id}/providerCredentials/307"
},
{
"key": "internalToken",
"value": "yes"
},
{
"key": "providerId",
"value": "14"
},
{
"key": "providerCode",
"value": "acronis"
}
]
},
"description": "Acronis_Config",
"createTime": "2023-12-21T21:16:51Z",
"updateTime": "2023-12-21T21:16:51Z"
}
],
"configuration": {
"form": {
"schema": {
"type": "JSON_SCHEMA_TYPE_OBJECT"
}
}
}
},
{
"event": "SUBSCRIPTION_START",
"actions": [
{
"name": "accounts/{account_id}/products/AcronisCyberProtection-smp/deployments/action/vknj8yq",
"type": "BONITOR",
"bonitor": {
"provisioningName": "Acronis_Update_Order_V3_Process",
"provisioningType": "Resource",
"provisioningCategory": "Acronis",
"parameters": [
{
"key": "credentials",
"value": "accounts/{account_id}/providerCredentials/307"
},
{
"key": "internalToken",
"value": "yes"
}
]
},
"description": "Update Commitment Tier",
"createTime": "2024-03-15T18:45:09Z",
"updateTime": "2024-03-15T18:45:09Z"
},
{
"name": "accounts/{account_id}/products/AcronisCyberProtection-smp/deployments/action/fzdbm32",
"type": "BONITOR",
"bonitor": {
"provisioningName": "Acronis_Cancel_Tenant_V3_Process",
"provisioningType": "Resource",
"provisioningCategory": "Acronis",
"parameters": [
{
"key": "credentials",
"value": "accounts/{account_id}/providerCredentials/307"
},
{
"key": "internalToken",
"value": "yes"
}
]
},
"description": "Cancel Account",
"createTime": "2025-07-11T10:56:48Z",
"updateTime": "2025-07-11T10:56:48Z"
}
],
"configuration": {
"form": {
"schema": {
"type": "JSON_SCHEMA_TYPE_OBJECT"
}
}
}
}
]
},
"idsInUse": [
"Acronis-Cyber-Protect-and-Cyber-",
"AcronisCyberProtection-smp",
"Commitment-Tier-0---USD",
"Commitment-Tier-0--USD",
"Commitment-Tier-1---USD",
"Commitment-Tier-1---USD-n0",
"Commitment-Tier-1-USD",
"Commitment-Tier-2-USD",
"Commitment-Tier-3-USD",
"Commitment-Tier-4-USD",
"Commitment-Tier-5-USD",
"Commitment-Tier-6---USD",
"Commitment-Tier-7---USD",
"Commitment-Tier-8---USD",
"Commitment-Tier-8---USD-n0",
"Commitment-Tier-9---USD",
"Commitment-Tier-Eight",
"Commitment-Tier-Five",
"Commitment-Tier-Four",
"Commitment-Tier-Nine",
"Commitment-Tier-One",
"Commitment-Tier-Seven",
"Commitment-Tier-Six",
"Commitment-Tier-Three",
"Commitment-Tier-Two",
"Commitment-Tier-Zero",
"Create-Acronis-Cyber-Protect-Clo",
"Email-and-calendaring",
"Web-and-mobile-versions-of-Offic"
],
"termUid": "17xxxxdfxxxx13xxxxf5",
"isSharedProduct": true,
"importStatus": "NOT_IMPORTABLE",
"etag": "MTc1Mzg3MzgzNw==",
"createTime": "2024-04-25T18:44:33Z",
"updateTime": "2025-07-30T11:10:37Z",
"legacyProductId": "7363"
}
Response Parameters
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The resource name of the products | accounts/{account_id}/products/{product_name} |
type |
String | Specifies the product type such as:
|
SUBSCRIPTION_PRODUCT |
categories |
Array | Resource names of the categories that the product is associated with. | accounts/{account_id}/categories/Acronis |
hasPublishedVersions |
Boolean | Specifies whether the product has published versions. | Values such as
|
marketing |
Object | Includes marketing information. | The elements in the marketing object |
definition |
Object | Specifies the pricing structure and the corresponding metadata. | The elements in the definition object |
versionHistory |
Array | Includes the list of all published versions of the product components/schemas in chronological order (newest being the last). Note: The version is not populated for List API. (Output-only). | The elements in the versionHistory array |
deployment |
Object | Includes the deployment information. | The elements in the deployment object |
idsInUse |
Array | Includes a list of all identifiers used by all published versions of the product. It is used by clients to avoid reusing old published plans/SKUs. | The elements in the idsInUse array |
termUid |
String | A unique identifier of the term from the terms v2 service that this product uses. | Some string value |
isSharedProduct |
Boolean | Specifies whether the product is shared or owned (Output-only). | Values such as True or False |
importStatus |
String | Specifies the import status. | NOT_IMPORTABLE |
eTag |
String | A unique identifier to differentiate between various versions of the products. Note:While updating a product, you must include the latest eTag value that is obtained from Get Product response. If the eTag is different from the value at the backend (server), the update request is rejected. |
|
| It is not populated in the List API, output-only for Create Product endpoint and required for Update Product endpoint. | Some string value generated by system. | ||
createTime |
String | The time when the product is created, in YYYY-MM-DD HH:Min format. It is Output-only field. | 2024-04-25T18:44:33Z |
updateTime |
String | The time when the product is updated, in YYYY-MM-DD HH:Min format. It is Output-only field. | 2025-07-30T11:10:37Z |
legacyProductId |
String | The legacy product ID. | 1234 |
Elements in marketing object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
description |
String | Detailed description of the product. | Protects more than 20 platforms and incorporates the backup industry’s most advanced anti-ransomware\ntechnology, safeguarding data and systems in any environment – physical or virtualized, on-premises, or in the cloud |
displayName |
String | Display name of the product provided by client. | Acronis Cyber Protect Cloud |
caption |
String | Short description of the product. | Acronis Cyber Protect & Cyber Infrastructure |
defaultImage |
Object | Specifies marketing media such as image or video. | The elements in defaultImage object |
banner |
Object | Specifies the product banner such as solid color or an image. | The elements in banner object |
capabilities |
Array | Specifies the product capabilities. | The elements in capabilities array |
media |
Array | Specifies a list of marketing media for a product. | The elements in media array |
productOverviews |
Array | Specifies a list of product overviwes. | The elements in productOverviews array |
Elements in defaultImage object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
title |
String | Title of the media. UTF plain-text. | Logo |
content |
String | Includes videos or images. For videos, this field must include an embeddable iframe code or a direct link to the video. For images, it must include the URL of the uploaded image. To add or update an image, generate a new Blob using the blob service, and upload the image to the provided URL. After the upload is completed, include the resulting upload signature in this field, and then run the create or update API. |
Address of the stored media |
type |
String | Indicates the type of media. |
|
Elements in banner object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
content |
String | Address of the stored media. |
|
type |
String | Specifies the type of banner. |
|
Elements in capabilities array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
title |
String | Title of the product capability. | AI-powered integration of data protection, cybersecurity, and management into a single solution |
content |
String | Includes the content of the product capability. It is specified as a paragraph in the product details page in marketplace. UTF plain-text. | Protects more than 20 platforms and incorporates the backup industry’s most advanced anti-ransomware\ntechnology, safeguarding data and systems in any environment – physical or virtualized, on-premises, or in the cloud. |
features |
Array | Specifies the capability of the product. | The elements in features array |
Elements in features array (capabilities)
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Title of the feature/attribute. | Universal Restore |
displayName |
String | Displayname of the feature or attribute. | Acronis Universal Restore |
decription |
String | Description of the feature or attribute. | Reduce time spent on recovery tasks. Acronis Universal Restore makes dissimilar hardware recovery\ndramatically faster by detecting the machine type and auto-installing appropriate drivers for the hardware. |
logo |
String | Includes the address of the logo image. | Address where the image is stored |
Elements in media array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
title |
String | Title of the media. UTF plain-text. | acronis.png |
content |
String | Includes videos or images.
|
Address of the stored media |
type |
String | Indicates the type of media. |
|
Elements in productOverviews array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the product overview. | Flexible backup storage options |
displayName |
String | Display name of the product overview. | Flexible backup storage options |
decription |
String | Description of the product overview. | Comply with business requirements given flexible storage options: ready-to-use Google Cloud Storage, Microsoft Azure storage, and Acronis Cyber Cloud\nStorage, Acronis Backup Gateway software component to store backups on third-party off-site storage, local networked storage and Acronis Cyber Infrastructure, a\nscalable, on-premises storage and compute solution |
url |
String | Includes the address of the product overview. | Address of the overview |
Elements in definition object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
supportedCurrencies |
Array | List of supported currency codes. Each plan must explicitly specify the price for every currency code in this list. | USD |
billingMode |
String | Specifies when the payment should be made. | Values such as
|
features |
Array | Specifies the list of all features used in this product. | The elements in the features array |
skus |
Array | List of product SKUs. | The elements in the skus array |
paymentMethods |
Array | Specifies the supported payment methods for the product. | offline |
customFields |
Array | Allows to add business specific information. Each field includes a name-value pair, providing more detailed information. | The elements in customeFields array |
Elements in features array (definition)
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Unique identifier of the feature that is provided by client. | Web-and-mobile-versions-of-Office |
displayName |
String | Display name of the feature. | Web and mobile versions of Office apps |
Elements in skus array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Unique identifier of SKU that is provided by client. | Acronis-Cyber-Protect-and-Cyber- |
displayName |
String | Display name of the SKU. | Create Acronis Cyber Protect Cloud Account |
description |
String | Description of the SKU. | Create Acronis Cyber Protect Cloud Account |
cancelTiming |
String | Specifies when the change happens during upgrade/downgrade/cancel. | Values such as
|
features |
Array | List of features supported by this SKU. | The elements in the features array |
plans |
Array | All the plans for this SKU. | The elements in the plans array |
productId |
String | Field used to identify a SKU. | CAA |
productCloudProviderName |
String | Field used to identify the cloud provider of a SKU. | 14 |
pricebookCurrency |
String | Specifies the pricebook currency. | USD |
productAvailability |
Boolean | Specifies the availability of the product. | Values such as
|
supportPlanAsProductPlan |
Object | Specifies the information about the programs associated with the product. | The elements in the supportPlanAsProductPlan object |
Elements in features array (SKUs)
| Parameter | Data Type | Description | Example |
|---|---|---|---|
feature |
String | The feature ID. | Email-and-calendaring |
displayValue |
String | Display value of the feature. | True |
Elements in plans array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Unique identifier of plan that is provided by client. | Commitment-Tier-Zero |
displayName |
String | Display name of the plan. | Commitment Tier 0 - USD 0 |
billingPeriod |
String | Invoice generation interval. |
|
phases |
Array | Specifies the phases of the plan. Phases must be ordered in the following sequence:
Out of these phases, trial and discount are optional. However, either a fixed or an unlimited phase must always be specified. |
The elements in the phases array |
icon |
String | The product icon. | The address where the icon image is stored |
productId |
String | The product ID. | US, CAA, Tier0 |
pricebookCurrency |
String | Specifies the pricebook currency. | USD |
productAvailability |
Boolean | Specifies the availability of the product. It is false if productId exists but is not present in the pricebook. | Values such as
|
supportPlan |
Object | The support plans related to the product. | The elements in the supportPlan object |
mpnId |
String | Specifies the manufacturing part number. | Some string value |
priceDisplay |
String | Specifies the price of the product. | PRICE_DISPLAY_SHOW_PLAN |
minQuantity |
String | Specifies the minimum quantity of the product that can be purchased. | 1 |
requestForEligibilityText |
String | Specifies the text or option that appears when the Request for Quote Eligible toggle is enabled in the UI. | The toggle specifies the type of special request associated with the product and includes the following options:
|
Elements in phases array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
duration |
Object | The duration of the phase. | The elements in the duration object |
type |
String | Specifies the type of the phase selected. | FIXED_PHASE |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in the recurringPrice object |
Elements in duration object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
unit |
String | Specifies the duration of the phase. | YEAR |
count |
String | Specifies the count of the value contained in unit field. |
1 |
Elements in customFields array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the custom field. | ProvisioningCategory |
content |
String | For the string data type, the parameter includes string data. For binary data types, this parameter specifies a GCS resource path. | Acronis |
type |
String | Specifies the type of value in the content field. |
Values such as
|
Elements in versionHistory array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Unique name to identify the product version. This is an output-only field. | 1 |
effectiveDate |
String | The date from when this version is available for new subscriptions. This is an output-only field. | 2024-04-25T18:44:33Z |
Elements in deployment object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
deployments |
Array | Includes the event, actions and user input configuration for a product. | The elements in deployments array |
Elements in deployments array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
event |
String | Specifies the lifecycle event in which a deployment should occur. |
|
actions |
Array | Specifies the actions associated with the deployment. | The elements in actions array |
configuration |
Object | Describes the deployment-specific input details, such as the form that must be rendered at deployment-time. | The elements in configuration object |
Elements in actions array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the action. | accounts/2768/products/AcronisCyberProtection-smp/deployments/action/mqx0flf |
type |
Array | The type of the action performed during deployment. |
|
bonitor |
Object | Specifies how the action is executed. | The elements in bonitor object |
description |
String | Description of the deployment action. | Acronis_Config |
createTime |
String | The time when the action is created, in YYYY-MM-DD HH:Min format. It is Output-only field. | 2023-12-21T21:16:51Z |
updateTime |
String | The time when the action is updated, in YYYY-MM-DD HH:Min format. It is Output-only field. | 2023-12-21T21:16:51Z |
Elements in bonitor object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
provisioningName |
String | The name of the provisioning task. | Acronis_Config |
provisioningType |
String | The type of the provisioning task. | Config |
provisioningCategory |
String | The category of the provisioning task. | Acronis |
parameters |
Array | The key-value pairs to execute the provisioning task. | The elements in parameters array |
Elements in parameters array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
key |
String | The name of the parameter. | providerId |
value |
String | The value of the parameter. | 14 |
Elements in configuration object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
form |
Object | Describes a schema for arranging UI components in an HTML form. It includes a JSON Schema and a list of Form Widgets. | The elements in form object |
Elements in form object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
schema |
Object | Specifies the data source for the form. The data and rules defined here are used to populate and validate the form. | The elements in schema object |
Elements in schema object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
Object | Describes the data type of the schema. This parameter only supports the object data type. |
JSON_SCHEMA_TYPE_OBJECT |
Sample Response - Error 400
{
"error": "INVALID_REQUEST",
"message": "At least one of page_size and page_token must be present",
"code": 400,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 400 - Invalid Request
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INVALID_REQUEST |
message |
String | Error description. | At least one of page_size and page_token must be present. |
code |
String | Error code. | 400 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Request
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/10259/products?page_size=50' \
--header 'accept-language: en-GB,en;q=0.8' \
--header 'Authorization: Bearer ZDAWMDRIZJETN2RJYY0ZNMU4LTHIZWMTMWM5YZQ0MZQZMZI4'
Sample Request
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/10259/products/GCPAccountCreate-smpfr' \
--header 'accept: application/json, text/plain, */*' \
--header 'Authorization: Bearer ZDAWMDRIZJETN2RJYY0ZNMU4LTHIZWMTMWM5YZQ0MZQZMZI4'
List Verticals
Using the List Verticals endpoint, you can retrieve the list of verticals available for a specific account. Verticals include industry segments such as commercial, corporate, education, charity, and so on.
Verticals are used to customize the products, pricing, and align the products according to the customers’ requirements, for various segments.
HTTP Endpoint URL: https://ion.tdsynnex.com/api/v3/accounts/{accountId}/products/verticals
Sample Request:
curl --request GET \
--url https://ion.tdsynnex.com/api/v3/accounts/%7BaccountId%7D/products/verticals \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
Integer | Reseller Id in CCP. | 1234 | Yes |
Sample Response
{
"verticals": [
{
"name": "accounts/<accountID>/verticals/Corporate",
"displayName": "Corporate",
"description": "Enterprise Products"
}
]
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Resource name of the vertical. | Commercial |
displayName |
String | Display name of the vertical. | Commercial |
description |
String | Information about the vertical. | Enterprise Products. |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Request
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/2767/products/verticals' \
--header 'Authorization: Bearer ZDAWMDRIZJETN2RJYY0ZNMU4LTHIZWMTMWM5YZQ0MZQZMZI4'
List Categories
Using the List Categories endpoint, you can retrieve a list of product categories associated to a specific account. Categories are used to classify the products within the catalog. For example, product categories such as technology, cloud computing, and so on.
HTTP Endpoint URL: https://ion.tdsynnex.com/api/v3/accounts/{accountId}/products/categories
Sample Request:
curl --request GET \
--url https://ion.tdsynnex.com/api/v3/accounts/%7BaccountId%7D/products/categories \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
Integer | Reseller Id in CCP. | 1234 | Yes |
Sample Response
{
"categories": [
{
"name": "accounts/<accountID>/categories/technology",
"displayName": "technology",
"count": 120,
"description": "All things related to tech including software and innovations.",
"icon": [
"https://example.com/icons/tech-icon.png"
],
"banner": [
"https://example.com/banners/tech-banner.jpg"
],
"logos": [
"https://example.com/logos/tech-logo.svg"
],
"features": [
{
"name": "cloud-computing",
"displayName": "Cloud Computing",
"description": "Covers services and platforms that run over the internet, such as storage, servers, and databases."
}
],
"externalLink": "https://example.com/categories/technology",
"parent": "science",
"children": [
"software",
"networking"
]
}
]
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
categories |
String | Product category. | Values such as Technology, Cloud computing, and so on. |
Elements in categories array list:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Name of the category. | Technology |
displayName |
String | Display name of the category. | Tech |
count |
Integer | Number of products in the category. | 120 |
description |
String | Information about the category. | All things related to tech including software and innovations. |
icon |
Array | The product icon. | https://example.com/icons/tech-icon.png. |
banner |
Array | The product banner. | https://example.com/banners/tech-banner.jpg. |
logos |
Array | The product logo. | https://example.com/logos/tech-logo.svg. |
features |
Array | Information about the product features. | Array elements. |
externalLink |
String | The web address that directs to an external web page displaying the category information and associated products. | https://example.com/categories/technology. |
parent |
String | The parent category. | Enterprise Products. |
children |
Array | The subcategory. | Enterprise Products. |
Elements in features array list:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Name of the feature. | Cloud computing. |
displayName |
String | Display name of the feature. | Cloud computing. |
description |
String | Information about the feature. | Covers services and platforms that run over the internet, such as storage, servers, and databases. |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Order
The Order endpoints of StreamOne® Ion API allow you to:
- List account orders
- List customer orders
- Get order details
- Place an order
- Create Order|new tenant with new customer scenario
- Create Order|existing tenant with existing customer scenario
- Create Order|new tenant with existing customer scenario
- Create Order|existing tenant with new customer scenario
- Update an order
- Update Order - License Count
- Update Order - License Count During Renewals
- Update Order - Auto Renew On/Off
- Update Order - Delete/Suspend/Reactivate Subscription
- Update Order - Reactivate Subscription
- Update Order - Upgrade Subscription from Lower Tier to Higher Tier
- Update Order - Delete Subscription
- Cancel an order
List Account Orders
This endpoint retrieves a reseller's order history to track their past purchases, and access order details.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/orders
Sample Request:
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/1234/orders?pageSize=100' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
pageSize |
Integer | Page size of the response | 1 | Yes |
pageToken |
String | A token identifying the page to return. If empty, the first page (default) is returned. | MTox | No |
status |
String | The status of the order. Such as,
|
NEW | No |
Sample Response:
{
"orders": [
{
"name": "accounts/1234/customers/56789/orders/123456",
"referenceId": "customers/70589/carts/171323",
"displayName": "Cart - 1725418904306",
"userId": "44020",
"userName": "user1234",
"userEmail": "reseller@sample.com",
"status": "COMPLETED",
"currencyCode": "USD",
"total": 4,
"cartId": "123456",
"orderItems": [
{
"name": "accounts/2767/customers/70589/orders/287143/orderItems/184990",
"referenceId": "customers/70589/cartItems/195222",
"action": "CREATE",
"purchaseIntention": "New Purchase",
"resourceId": "bu5e81725419101290",
"productId": "IBMMAAS360WATSON-smp",
"skuId": "Essentials-device",
"mfgPartNumber": "D1P3GLL:DK-MS-EMM-ESS-V2:P36M:M:0",
"planId": "IBM-MaaS360-w-Watson-Essentials-",
"quantity": 1,
"providerName": "IBM",
"price": 4,
"cost": 3.4,
"msrp": 4,
"cartItemId": "123456",
"status": "COMPLETED",
"provisioningInfo": {
"processId": "a91a0875-a4e3-4acf-9e89-a70a0125e03c",
"processName": "IBM_Create_Order_V3_Process"
},
"createTime": "2024-09-04T03:02:18Z",
"updateTime": "2024-09-04T03:05:12Z",
"pricingInfo": "Pricebook price"
}
],
"provisioningInfo": {
"processId": "2e0e013f-49e3-4e28-81af-c9c391cde292",
"processName": "Order_V3"
},
"createTime": "2024-09-04T03:02:18Z",
"updateTime": "2024-09-04T03:05:12Z",
"scheduledAt": "2024-09-04T03:02:18Z"
}
],
"nextPageToken": "MTox",
"totalCount": 7920
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
orders |
Array | Array list that specifies the details of the order items. | The elements in the orders array list |
Elements in the orders array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Resource URL of the order. | accounts/{accountId}/customers/{customerId}/orders/{orderId} |
referenceId |
String | The unique reference ID defined in the request. | NCE-Order-Test |
displayName |
String | The user-defined display name. | Office-365-NCE |
userId |
Integer | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order, such as,
|
COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Integer | The total price of the order. | 100 |
cartId |
Integer | A unique cart ID. | 123456 |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Resource name for the order item. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
referenceId |
String | The unique reference ID of the order defined in the request. | Microsoft create order |
action |
String | The executed action of the API. | CREATE |
resourceId |
StringSpecifies the subscription 10 that was created at the external vendor's side, after the order is completed. | Alphanumeric | |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit(SKU) ID. | Office-365-E1-n1 |
planId |
String | The plan ID. | Monthly-n23 |
quantity |
Integer | The SKU quantity. | 3 |
providerName |
String | The name of the provider. | AZURE |
status |
String | The status of the order, such as,
|
NEW |
price |
Number | The price that the reseller sets for the end customer. | Numeric |
cost |
Number | The amount that the provider charges to the partner. | Numeric |
createTime |
String | The time when the order item was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order item was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to execute in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
nextPageToken |
String | Token to display results on the next page. | MTox |
Sample Response - Error 400
{
"error": "INVALID_REQUEST",
"message": "At least one of page_size and page_token must be present",
"code": 400,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 400 - Invalid Request
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INVALID_REQUEST |
message |
String | Error description. | Either page_size or page_token must be provided |
code |
String | Error code. | 400 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
List Customer Orders
This endpoint retrieves a specific customer’s order history to track their past purchases, and access order details.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders
Sample Request:
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/2767/customers/18502/orders?pageSize=100' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
customerId |
String | The unique customer ID. | 56789 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
pageSize |
Integer | Page size of the response | 1 | Yes |
pageToken |
String | A token identifying the page to return. If empty, the first page (default) is returned. | MTox | No |
status |
String | The status of the order. Such as,
|
NEW | No |
Sample Response
{
"orders": [
{
"name": "accounts/1234/customers/56789/orders/123456",
"referenceId": "customers/12345/carts/123456",
"displayName": "Cart - 1234520304954",
"userId": "12345",
"userName": "Reseller sample",
"userEmail": "reseller@sample.com",
"status": "IN_PROGRESS",
"currencyCode": "USD",
"cartId": "123456",
"orderItems": [
{
"name": "accounts/1234/customers/12345/orders/123456/orderItems/234567",
"referenceId": "customers/12345/cartItems/123456",
"action": "CREATE",
"productId": "ScaleSAFeforAzureDev",
"skuId": "Scale---SAFe-for-Azure-DevOps-Az",
"planId": "Scale---SAFe-for-Azure-DevOps-n0",
"quantity": 1,
"providerName": "UNSPECIFIED",
"status": "NEW",
"additionalInformation": "legacy",
"createTime": "2023-08-30T18:31:45Z",
"updateTime": "2023-08-30T18:31:49Z"
}
],
"createTime": "2023-08-30T18:31:45Z",
"updateTime": "2024-02-02T18:19:45Z",
"scheduledAt": "2023-08-30T18:31:50Z"
}
],
"nextPageToken": "MTox",
"totalCount": 14
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
orders |
Array | Array list that specifies the details of the order items. | The elements in the orders array list |
Elements in the orders array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Resource name of the order. | accounts/{accountId}/customers/{customerId}/orders/{orderId} |
referenceId |
String | The unique reference ID defined in the request. | NCE-Order-Test |
displayName |
String | The user-defined display name. | Office-365-NCE |
userId |
Integer | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order, such as,
|
COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Integer | The total price of the order. | 100 |
cartId |
Integer | A unique cart ID. | 123456 |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Resource name for the order item. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
referenceId |
String | The unique reference ID of the order defined in the request. | Microsoft create order |
action |
String | The executed action of the API. | CREATE |
resourceId |
String | Specifies the subscription 10 that was created at the external vendor's side, after the order is completed. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit(SKU) ID. | Office-365-E1-n1 |
planId |
String | The plan ID. | Monthly-n23 |
quantity |
Integer | The SKU quantity. | 3 |
providerName |
String | The name of the provider. | AZURE |
status |
String | The status of the order item, such as,
|
NEW |
price |
Number | The price that the reseller sets for the end customer. | Numeric |
cost |
Number | The amount that the provider charges to the partner. | Numeric |
createTime |
String | The time when the order item was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order item was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to execute in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
nextPageToken |
String | Token to display results on the next page. | MTox |
Sample Response - Error 400
{
"error": "INVALID_REQUEST",
"message": "At least one of page_size and page_token must be present",
"code": 400,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 400 - Invalid Request
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INVALID_REQUEST |
message |
String | Error description | Either page_size or page_token must be provided |
code |
String | Error code | 400 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Get Order
This endpoint retrieves the details of a specific order by providing the account ID, customer ID, and order ID as path parameters. The response includes information such as the order status, currency code, total amount, order items, and provisioning information.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
customerId |
String | The unique customer ID. | 56789 | Yes |
orderId |
String | The unique order ID. | 123456 | Yes |
Sample Response:
{
"name": "accounts/1234/customers/56789/orders/123456",
"referenceId": "customers/123456/carts/567890",
"displayName": "Cart - 1234567890123",
"userId": "12345",
"userName": "Reseller1234",
"userEmail": "reseller@sample.com",
"status": "COMPLETED",
"currencyCode": "USD",
"total": 4,
"cartId": "123456",
"orderItems": [
{
"name": "accounts/1234/customers/56789/orders/123456/orderItems/567890",
"referenceId": "customers/12345/cartItems/123456",
"action": "CREATE",
"purchaseIntention": "New Purchase",
"resourceId": "bu5e81725419101290",
"productId": "IBMMAAS360WATSON-smp",
"skuId": "Essentials-device",
"mfgPartNumber": "D1P3GLL:DK-MS-EMM-ESS-V2:P36M:M:0",
"planId": "IBM-MaaS360-w-Watson-Essentials-",
"quantity": 1,
"providerName": "IBM",
"price": 4,
"cost": 3.4,
"cartItemId": "123456",
"status": "COMPLETED",
"provisioningInfo": {
"processId": "a91a0875-a4e3-4acf-9e89-a70a0125e03c",
"processName": "IBM_Create_Order_V3_Process"
},
"createTime": "2024-09-04T03:02:18Z",
"updateTime": "2024-09-04T03:05:12Z",
}
],
"provisioningInfo": {
"processId": "2e0e013f-49e3-4e28-81af-c9c391cde292",
"processName": "Order_V3"
},
"createTime": "2024-09-04T03:02:18Z",
"updateTime": "2024-09-04T03:05:12Z",
"scheduledAt": "2024-09-04T03:02:18Z"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Resource name of the order. | accounts/{accountId}/customers/{customerId}/orders/{orderId} |
referenceId |
String | The unique reference ID defined in the request. | NCE-Order-Test |
displayName |
String | The user-defined display name. | Office-365-NCE |
userId |
Integer | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order, such as,
|
COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Integer | The total price of the order. | 100 |
cartId |
Integer | A unique cart ID. | 123456 |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Resource name for the order item. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
referenceId |
String | The unique reference ID of the order defined in the request. | Microsoft create order |
action |
String | The executed action of the API. | CREATE |
resourceId |
String | Specifies the subscription 10 that was created at the external vendor's side, after the order is completed. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit(SKU) ID. | Office-365-E1-n1 |
planId |
String | The plan ID. | Monthly-n23 |
quantity |
Integer | The SKU quantity. | 3 |
providerName |
String | The name of the provider. | AZURE |
price |
Number | The price that the reseller sets for the end customer. | Numeric |
cost |
Number | The amount that the provider charges to the partner. | Numeric |
status |
String | The status of the order item, such as,
|
NEW |
price |
Number | The price that the reseller charges the end customer. | Numeric |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
provisioningInfo |
Array | This array provides provisioning information about the order items. | The elements in the provisioningInfo array list. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric |
processName |
String | The name of the process. This parameter in the orderitems array provides information about the vendor, action, and the endpoint. |
Microsoft_Create_Order_V3_Provision_Process |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to execute in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestI
d": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 404
{
"error": "NOT_FOUND",
"message": "resource 'accounts/12345/customers/56789/orders/1234' not found",
"code": 404,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 404 - Not Found
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | NOT_FOUND |
message |
String | Error description. | resource accounts/12345/customers/56789/orders/1234 not found |
code |
String | Error code. | 404 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Create Order
This endpoint allows you to purchase and create an order.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders
Sample Request
curl
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/<account_id>/customers/<customer_id>/orders'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX' \
--data-raw '{
"referenceId": "NCE Order Test",
"displayName": "Office 365 NCE",
"orderItems": [
{
"referenceId": "reseller.system.id",
"productId": "OFFICE365NCE--smpnce",
"skuId": "Office-365-E1-n1",
"planId": "Monthly-n23",
"action": "CREATE",
"quantity": 3,
"providerName": "AZURE",
"attributes": [
{
"name": "domainName",
"value": "ABCDEFG12FEB24FR"
},
{
"name": "agreementDateAgreed",
"value": "2024-01-01"
},
{
"name": "agreementUserId",
"value": "1234"
},
{
"name": "agreementEmail",
"value": "testemail@test.com"
},
{
"name": "agreementFirstName",
"value": "Test"
},
{
"name": "agreementLastName",
"value": "Customer"
},
{
"name": "agreementPhoneNumber",
"value": "1234567890"
},
{
"name": "customTermEndDate", //calender term end date
"value" : "2024-02-29"
}
]
}
]
}'
Request Parameters:
The following table describes JSON request elements for the Create Order endpoint.
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
referenceId |
String | User defined reference ID to identify the order. | NCE Order Test | Yes |
displayName |
String | The display name for the order | Office 365 NCE | Yes |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
referenceId |
String | The unique reference ID of the order. | reseller.system.id | Yes |
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The SKU (Stock Keeping Unit) ID. | Office-365-E1-n1 | Yes |
planId |
String | The plan ID. | Monthly-n23 | Yes |
action |
String | Specifies the CREATE action. | CREATE | Yes |
quantity |
Integer | The SKU quantity. | 3 | Yes |
providerName |
String | The name of the provider. | AZURE | Yes |
attributes |
Array | Array list that specifies additional details of the reseller. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field. |
Yes |
Request Parameters:
| Attribute | Data Type | Description | Example | Required |
|---|---|---|---|---|
domainName |
String | The unique domain name. | Alphanumeric | Yes |
agreementDateAgreed |
String | The agreement date in YYYY-MM-DD format. | 2024-01-01 | Yes |
agreementUserId |
String | The agreement user ID. | Alphanumeric | Yes |
agreementEmail |
String | The email ID associated with the agreement. | testemail@test.com | Yes |
agreementFirstName |
String | The first name associated with the agreement. | Test | Yes |
agreementLastName |
String | The last name associated with the agreement. | Customer | Yes |
agreementPhoneNumber |
String | The phone number associated with the agreement. | Numeric Value | Yes |
customTermEndDate |
String | The custom date when the agreement will end in YYYY-MM-DD format. | 2024-02-29 | No |
Sample Response
{
"name": "Test Customer",
"referenceId": "my-MSFT-order",
"displayName": "Office-365-F3",
"userId": "1234567",
"userName": "sample username",
"userEmail": "testemail@test.com",
"status": "COMPLETE",
"currencyCode": "EUR",
"total": 132.87,
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}", //URL Path
"referenceId": "reseller.system.id",
"action": "CREATE",
"resourceId": "e182b4e8-098b-123a-a1bc-e30e8f2ea8eb",
"productId": "OFFICE365NCE--smpnce",
"skuId": "Office-365-E1-n1",
"planId": "Monthly-n23",
"quantity": 3,
"providerName": "AZURE",
"price": 132.87, //Price charged by reseller to the end customer
"cost": 119.97, //The cost that the provider is charging the partner
"currencyCode": "EUR",
"subTotal": 132.87,
"endCustomerPO": "10",
"resellerPO": "20",
"attributes": [
{
"name": "userName",
"value": "johnd@SIEQAYP20FEB24FR.onmicrosoft.com"
},
{
"name": "password",
"value": "password"
}
],
"status": "COMPLETE",
"provisioningInfo": {
"processId": "e8118b72-c3d4-1ab2-a1b2-a48fe57e2c95",
"processName": "Microsoft_Create_Order_V3_Provision_Process"
},
"createTime": "2024-02-20T07:51:16Z",
"updateTime": "2024-02-20T07:51:16Z"
}
],
"provisioningInfo": {
"processId": "ab123c45-de6e-4031-9e3c-b18018188f22",
"processName": "Order_V3"
},
"createTime": "2024-02-20T07:51:15Z",
"updateTime": "2024-02-20T07:51:15Z",
"scheduledAt": "2024-02-20T07:51:15Z"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
referenceId |
String | The unique reference ID defined in the request. | NCE-Order-Test |
displayName |
String | The user-defined display name. | Office-365-NCE |
userId |
Numeric | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Number | The total price of the successful order. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | TThe URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
referenceId |
String | The unique reference ID of the order defined in the request. | Microsoft create order |
action |
String | The executed action of the API. | CREATE |
resourceId |
String | Specifies the subscription ID that was created at the external vendor’s side, after the order is completed. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit(SKU) ID. | Office-365-E1-n1 |
planId |
String | The plan ID. | Monthly-n23 |
quantity |
Integer | The SKU quantity. | 3 |
providerName |
String | The name of the provider. | AZURE |
price |
Number | The price that the reseller charges the end customer. | Numeric |
cost |
Number | The cost that the provider charges the partner. | Numeric |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Number | The total price of the ordererd items. | Numeric |
endCustomerPO |
Integer | The end customer's purchase order. | Numeric |
resellerPO |
Integer | The reseller's purchase order. | Numeric |
attributes |
Array | Array list that specifies additional details of the reseller. | The elements in the attributes array list. |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
status |
String | The status of the order. | COMPLETE |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
provisioningInfo |
Array | This array provides provisioning information about the order items. | The elements in the provisioningInfo array list. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric |
processName |
String | The name of the process. This parameter in the orderitems array provides information about the vendor, action, and the endpoint. |
Microsoft_Create_Order_V3_Provision_Process |
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
provisioningInfo |
Array | This array provides provisioning information about the created order. | The elements in the provisioningInfo array list. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric |
processName |
String | The name of the process. This parameter provides information about action and API endpoint. | Order_V3 |
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
Response Attributes
| Attribute | Data Type | Description | Example |
|---|---|---|---|
username |
String | Microsoft tenant username. | testusername |
password |
String | Microsoft tenant password. | testpassword |
Order Placement:
A complete order placement scenario includes multiple API calls.
Sequence Diagram:
Steps:
- Obtain
customerIdin one of the following ways:- Retrieve
customerIdfrom Create a customer if the customer does not exist already - Retrieve
customerIdfrom List Customers if customer exists
- Retrieve
- Obtain the following Product Details:
productId,planId,skuId
- Obtaim the vendor specific
Create Orderpayload from Provisioning template endpoint. - Use the details acquired in the steps above to Create an order.
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Create Order| new tenant with new customer scenario
In this scenario, a reseller or user places an order for a new customer. After placing an order, a tenant ID is created that is used to identify the customer.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders
Sample Request
curl
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/<account_id>/customers/<customer_id>/orders'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX' \
--data-raw '{
"referenceId": "my-MSFT-order",
"displayName": "msft order",
"orderItems": [
{
"referenceId": "Microsoft create order",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"planId": "Monthly-n18",
"action": "CREATE",
"quantity": "2",
"endCustomerPO": "17072",
"resellerPO": "150645",
"attributes": [
{
"name": "domainName",
"value": "dcjuly1872025"
},
{
"name": "agreementDateAgreed",
"value": "2025-07-18"
},
{
"name": "agreementUserId",
"value": "john.doe@tdsynnex.com"
},
{
"name": "agreementEmail",
"value": "john.doe@tdsynnex.com"
},
{
"name": "agreementFirstName",
"value": "John"
},
{
"name": "agreementLastName",
"value": "Doe"
},
{
"name": "agreementPhoneNumber",
"value": "5643454321"
},
{
"name": "companyRegistrationId",
"value": "1A2558DSD34"
}
]
}
]
}'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
referenceId |
String | User defined reference ID to identify the order. | NCE Order Test | Yes |
displayName |
String | The display name for the order | Office 365 NCE | Yes |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}",
"referenceId": "my-MSFT-order",
"displayName": "msft order",
"userId": "1370623",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "ON_HOLD",
"currencyCode": "NOK",
"total": 301.85421752929688,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"referenceId": "Microsoft create order",
"action": "CREATE",
"purchaseIntention": "New Purchase",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"mfgPartNumber": "CFxxxxxxxxxx:0001:P1M:M",
"planId": "Monthly-n18",
"quantity": 2,
"providerName": "AZURE",
"price": 150.92710876464844,
"cost": 150.92710876464844,
"msrp": 150.92710876464844,
"currencyCode": "NOK",
"subTotal": 301.85421752929688,
"endCustomerPO": "17072",
"resellerPO": "150645",
"attributes": [
{
"name": "domainName",
"value": "dcjuly1872025"
},
{
"name": "agreementDateAgreed",
"value": "2025-07-18"
},
{
"name": "agreementUserId",
"value": "john.doe@tdsynnex.com"
},
{
"name": "agreementEmail",
"value": "john.doe@tdsynnex.com"
},
{
"name": "agreementFirstName",
"value": "John"
},
{
"name": "agreementLastName",
"value": "Doe"
},
{
"name": "agreementPhoneNumber",
"value": "5643454321"
},
{
"name": "companyRegistrationId",
"value": "1A2558DSD34"
}
],
"catalogAttributes": [
{
"name": "productCategories",
"value": "NCE"
},
{
"name": "productCloudProviderName",
"value": "accounts/{account_id}/cloudProviders/{cloudProviders_id}"
},
{
"name": "sku.Name",
"value": "USxxxxxxxxxxxxxx01"
},
{
"name": "sku.DisplayName",
"value": "M365 Business Std"
},
{
"name": "sku.ExternalId",
"value": "NL,CFQ7TTC0LDPB,0001"
},
{
"name": "sku.Verticals",
"value": "accounts/{account_id}/verticals/Commercial"
},
{
"name": "plan.Name",
"value": "Monthly-n18"
},
{
"name": "plan.DisplayName",
"value": "M365 Business Std"
},
{
"name": "plan.ExternalId",
"value": "NL,CFQ7TTC0LDPB,0001,One-Month commitment for monthly billing"
},
{
"name": "plan.BillingPeriod",
"value": "monthly"
},
{
"name": "plan.ApprovalRequired",
"value": "false"
},
{
"name": "plan.MinQuantity",
"value": "0"
},
{
"name": "plan.MaxQuantity",
"value": "0"
},
{
"name": "plan.DurationUnit",
"value": "month"
},
{
"name": "plan.DurationCount",
"value": "1"
},
{
"name": "plan.DurationType",
"value": "fixed"
},
{
"name": "customField.ProvisioningCategory",
"value": "NCE"
},
{
"name": "customField.promo",
"value": "true"
},
{
"name": "product.ownerAccountId",
"value": "15718"
},
{
"name": "credentialsName",
"value": "accounts/{account_id}/providerCredentials/{providerCredentials value}"
}
],
"status": "ON_HOLD",
"createTime": "2025-07-18T08:04:02Z",
"updateTime": "2025-07-18T08:04:02Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Microsoft 365 NCE",
"skuName": "M365 Business Std",
"planName": "M365 Business Std",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "5b91cb35-07e9-4f04-9c74-fba1e4126fd7",
"processName": "Order_V3"
},
"createTime": "2025-07-18T08:04:02Z",
"updateTime": "2025-07-18T08:04:02Z",
"scheduledAt": "2025-07-18T08:04:02Z"
}
The parameters of the Create order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
purchaseIntention |
String | Specifies the reason or the category of the purchase. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
endCustomerPO |
String | Customer's purchase order number. | 17072 |
resellerPO |
String | Reseller's purchase order number. | 150645 |
attributes |
Array | Array list that specifies the product-specific attributes such as domainName, agreementUserId, agreementEmail, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
catalogAttributes |
Array | Array list that specifies the product-specific attributes such as product category, cloud provider name, plan name and so on that are provided as Name - Value pair. | The elements in the catalogAttributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the catalogAttributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | productCategories,productCloudProviderName |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Create Order| existing tenant with existing customer scenario
In this scenario, a reseller or a user places an order for an existing customer. In this case, the customer already has a tenant ID. A reseller or user is provisioning additional products or services for the corresponding customer.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders
Sample Request
curl
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/<account_id>/customers/<customer_id>/orders'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX' \
--data-raw '{
{
"referenceId": "add-subscription-order",
"displayName": "Add new subscription to existing tenant",
"orderItems": [
{
"referenceId": "add-subscription-item",
"productId": "ExchangeOnline-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"planId": "Monthly",
"action": "CREATE",
"quantity": 5,
"endCustomerPO": "PO4556",
"resellerPO": "Res7859",
"attributes": [
{
"name": "operations",
"value": "addSubscription"
},
{
"name": "friendlyName",
"value": "DC Group of Company"
}
]
}
]
}'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
referenceId |
String | User defined reference ID to identify the order. | NCE Order Test | Yes |
displayName |
String | The display name for the order | Office 365 NCE | Yes |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}",
"referenceId": "add-subscription-order",
"displayName": "Add new subscription to existing tenant",
"userId": "1370623",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "ON_HOLD",
"currencyCode": "NOK",
"total": 238.64542007446289,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"referenceId": "add-subscription-item",
"action": "CREATE",
"purchaseIntention": "New Purchase",
"productId": "ExchangeOnline-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"mfgPartNumber": "CFxxxxxxxxxx:0001:P1M:M",
"planId": "Monthly",
"quantity": 5,
"providerName": "AZURE",
"price": 47.729084014892578,
"cost": 47.729084014892578,
"msrp": 47.729084014892578,
"currencyCode": "NOK",
"subTotal": 238.64542007446289,
"endCustomerPO": "PO4556",
"resellerPO": "Res7859",
"attributes": [
{
"name": "operations",
"value": "addSubscription"
},
{
"name": "friendlyName",
"value": "DC Group of Company"
},
{
"name": "customerTenantId",
"value": "0dxxxx2b-xxxx-xxxx-xxxx-bbxxxxxxx765"
},
{
"name": "domainName",
"value": "dcjuly1872025.onmicrosoft.com"
},
{
"name": "agreementDateAgreed",
"value": "2025-07-18"
},
{
"name": "agreementUserId",
"value": "1370623"
},
{
"name": "agreementEmail",
"value": "john.doe@tdsynnex.com"
},
{
"name": "agreementFirstName",
"value": "John"
},
{
"name": "agreementLastName",
"value": "Doe"
},
{
"name": "agreementPhoneNumber",
"value": "5643454321"
}
],
"catalogAttributes": [
{
"name": "productCategories",
"value": "NCE"
},
{
"name": "productCloudProviderName",
"value": "accounts/{account_id}/cloudProviders/{cloudProvider_id}"
},
{
"name": "sku.Name",
"value": "USCFQ7TTC0LH160001"
},
{
"name": "sku.DisplayName",
"value": "Exchange Online (Plan 1)"
},
{
"name": "sku.ExternalId",
"value": "NL,CFQ7TTC0LH16,0001"
},
{
"name": "sku.Verticals",
"value": "accounts/{account_id}/verticals/Commercial"
},
{
"name": "plan.Name",
"value": "Monthly"
},
{
"name": "plan.DisplayName",
"value": "Exchange Online (Plan 1)"
},
{
"name": "plan.ExternalId",
"value": "NL,CFQ7TTC0LH16,0001,One-Month commitment for monthly billing"
},
{
"name": "plan.BillingPeriod",
"value": "monthly"
},
{
"name": "plan.ApprovalRequired",
"value": "false"
},
{
"name": "plan.MinQuantity",
"value": "0"
},
{
"name": "plan.MaxQuantity",
"value": "0"
},
{
"name": "plan.DurationUnit",
"value": "month"
},
{
"name": "plan.DurationCount",
"value": "1"
},
{
"name": "plan.DurationType",
"value": "fixed"
},
{
"name": "customField.ProvisioningCategory",
"value": "NCE"
},
{
"name": "product.ownerAccountId",
"value": "15718"
},
{
"name": "credentialsName",
"value": "accounts/{account_id}/providerCredentials/{providerCredentials value}"
}
],
"status": "ON_HOLD",
"createTime": "2025-07-18T10:09:49Z",
"updateTime": "2025-07-18T10:09:49Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Exchange Online NCE",
"skuName": "Exchange Online (Plan 1)",
"planName": "Exchange Online (Plan 1)",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "c4xxxx0d-xxxx-xxxx-xxxx-b7xxxxxxxx5a",
"processName": "Order_V3"
},
"createTime": "2025-07-18T10:09:48Z",
"updateTime": "2025-07-18T10:09:48Z",
"scheduledAt": "2025-07-18T10:09:48Z"
}
The parameters of the Create order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
purchaseIntention |
String | Specifies the reason or the category of the purchase. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
endCustomerPO |
String | Customer's purchase order number. | 17072 |
resellerPO |
String | Reseller's purchase order number. | 150645 |
attributes |
Array | Array list that specifies the product-specific attributes such as domainName, agreementUserId, agreementEmail, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
catalogAttributes |
Array | Array list that specifies the product-specific attributes such as product category, cloud provider name, plan name and so on that are provided as Name - Value pair. | The elements in the catalogAttributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the catalogAttributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | productCategories,productCloudProviderName |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Create Order| new tenant with existing customer scenario
In this scenario, a reseller or a user places an order for an existing customer. If the customer wants to place an order for a new business unit, a new tenant is created for that customer.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders
Sample Request
curl
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/<account_id>/customers/<customer_id>/orders'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX' \
--data-raw
{
"referenceId": "GW-Order-123",
"displayName": "Google Workspace Order",
"orderItems": [
{
"referenceId": "GW-Create-Order",
"productId": "GCPAccountCreate-smp",
"skuId": "Account-Creation",
"planId": "Usage",
"action": "CREATE",
"quantity": 10,
"vendor": "google",
"providerName": "productivity",
"endCustomerPO": "ECPO-456",
"resellerPO": "RPO-789",
"attributes": [
{
"name": "alternateEmail",
"value": "admin@abcinc.com"
},
{
"name": "customerDomain",
"value": "abc-division2"
},
{
"name": "userName",
"value": "admin"
},
{
"name": "billingEmail",
"value": "abc@test.com"
},
{
"name": "billingName",
"value": "Name"
},
{
"name": "projectName",
"value": "ABC"
}
]
}
]
}
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
referenceId |
String | User defined reference ID to identify the order. | NCE Order Test | Yes |
displayName |
String | The display name for the order | Office 365 NCE | Yes |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
referenceId |
String | User defined reference ID to identify the order. | OFFICE365NCE--smpnce | Yes |
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
vendor |
Integer | The product vendor name. | 3 | Yes |
providerNamer |
String | The name of the provider. | 3 | Yes |
endCustomerPO |
String | Customer's purchase order number. | 3 | Yes |
resellerPO |
String | Reseller's purchase order number. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/2767/customers/70441/orders/359068",
"referenceId": "GW-Order-123",
"displayName": "Google Workspace Order",
"userId": "191485",
"userName": "API User",
"userEmail": "apitest@mail.com",
"status": "ON_HOLD",
"currencyCode": "USD",
"portal": "v3",
"orderItems": [
{
"name": "accounts/2767/customers/70441/orders/359068/orderItems/250345",
"referenceId": "GW-Create-Order",
"action": "CREATE",
"purchaseIntention": "New Purchase",
"productId": "GCPAccountCreate-smp",
"skuId": "Account-Creation",
"mfgPartNumber": "GCP:PU:M",
"planId": "Usage",
"quantity": 10,
"providerName": "GCP",
"currencyCode": "USD",
"endCustomerPO": "ECPO-456",
"resellerPO": "RPO-789",
"attributes": [
{
"name": "alternateEmail",
"value": "admin@abcinc.com"
},
{
"name": "customerDomain",
"value": "abc-division2"
},
{
"name": "userName",
"value": "admin"
},
{
"name": "billingEmail",
"value": "abc@test.com"
},
{
"name": "billingName",
"value": "Name"
},
{
"name": "projectName",
"value": "ABC"
}
],
"catalogAttributes": [
{
"name": "productCategories",
"value": "Google,Google,Infrastructure-Modernization"
},
{
"name": "productCloudProviderName",
"value": "accounts/2768/cloudProviders/2"
},
{
"name": "sku.Name",
"value": "Account-Creation"
},
{
"name": "sku.DisplayName",
"value": "Google Cloud Platform"
},
{
"name": "sku.ExternalId",
"value": "accountcreation"
},
{
"name": "sku.Verticals",
"value": "accounts/2768/verticals/General"
},
{
"name": "plan.Name",
"value": "Usage"
},
{
"name": "plan.DisplayName",
"value": "Valid - Google Cloud Platform"
},
{
"name": "plan.ExternalId",
"value": "Sk3C85jKbGYhFb"
},
{
"name": "plan.BillingPeriod",
"value": "monthly"
},
{
"name": "plan.ApprovalRequired",
"value": "false"
},
{
"name": "plan.MinQuantity",
"value": "0"
},
{
"name": "plan.MaxQuantity",
"value": "0"
},
{
"name": "plan.DurationType",
"value": "unlimited"
},
{
"name": "customField.offerId",
"value": "Sk3C85jKbGYhFb"
},
{
"name": "customField.organization",
"value": "goog-test.gsuite.dist.techdata.com"
},
{
"name": "customField.productType",
"value": "usage-based"
},
{
"name": "customField.ProvisioningCategory",
"value": "Google"
},
{
"name": "customField.skip-price-book",
"value": "True"
},
{
"name": "product.ownerAccountId",
"value": "2768"
},
{
"name": "credentialsName",
"value": "accounts/2768/providerCredentials/186"
}
],
"status": "ON_HOLD",
"createTime": "2025-08-25T11:49:20Z",
"updateTime": "2025-08-25T11:49:20Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Google Cloud Platform",
"skuName": "Google Cloud Platform",
"planName": "Valid - Google Cloud Platform",
"productOwnerCountryCode": "US",
"providerId": "2"
}
],
"provisioningInfo": {
"processId": "2cd59d52-ceed-4dbe-b217-a5fc479aeb5f",
"processName": "Order_V3"
},
"createTime": "2025-08-25T11:49:19Z",
"updateTime": "2025-08-25T11:49:19Z",
"scheduledAt": "2025-08-25T11:49:19Z"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
referenceId |
String | User defined reference ID to identify the order. | GW-Create-Order |
displayName |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
referenceId |
String | User defined reference ID to identify the order. | CREATE |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
purchaseIntention |
String | Specifies the reason or the category of the purchase. | CREATE |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the provider. | AZURE |
currencyCode |
String | The currency code. | USD, EUR |
endCustomerPO |
String | Customer's purchase order number. | 17072 |
resellerPO |
String | Reseller's purchase order number. | 150645 |
attributes |
Array | Array list that specifies the product-specific attributes such as domainName, agreementUserId, agreementEmail, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
catalogAttributes |
Array | Array list that specifies the product-specific attributes such as product category, cloud provider name, plan name and so on that are provided as Name - Value pair. | The elements in the catalogAttributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
providerId |
String | The unique identifier for the provider. | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the catalogAttributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | productCategories,productCloudProviderName |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Create Order| existing tenant with new customer scenario
This scenario is not supported.
Update Order
This endpoint allows you to modify and renew existing orders.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}
Sample Request
curl
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/<account_id>/customers/<customer_id>/orders'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer MWQ4MGE5YTCTYJLMZS0ZMDNILTG4OWITYWI4MDG1YTRLMJJI' \
--data-raw '{
"referenceId": "NCE Order Test",
"displayName": "Office 365 NCE",
"orderItems": [
{
"referenceId": "reseller.system.id",
"productId": "OFFICE365NCE--smpnce",
"skuId": "Office-365-E1-n1",
"planId": "Monthly-n23",
"action": "CREATE",
"quantity": 3,
"providerName": "AZURE",
"attributes": [
{
"name": "domainName",
"value": "ABCDEFG12FEB24FR"
},
{
"name": "agreementDateAgreed",
"value": "2024-01-01"
},
{
"name": "agreementUserId",
"value": "1234"
},
{
"name": "agreementEmail",
"value": "testemail@test.com"
},
{
"name": "agreementFirstName",
"value": "Test"
},
{
"name": "agreementLastName",
"value": "Customer"
},
{
"name": "agreementPhoneNumber",
"value": "1234567890"
},
{
"name": "customTermEndDate", //calender term end date
"value" : "2024-02-29"
}
]
}
]
}'
Request Parameters:
The following table describes JSON request elements for the Create Order endpoint.
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
referenceId |
String | User defined reference ID to identify the order. | NCE Order Test | Yes |
displayName |
String | The display name for the order | Office 365 NCE | Yes |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
referenceId |
String | The unique reference ID of the order. | reseller.system.id | Yes |
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The SKU (Stock Keeping Unit) ID. | Office-365-E1-n1 | Yes |
planId |
String | The plan ID. | Monthly-n23 | Yes |
action |
String | Specifies the CREATE action. | CREATE | Yes |
quantity |
Integer | The SKU quantity. | 3 | Yes |
providerName |
String | The name of the provider. | AZURE | Yes |
attributes |
Array | Array list that specifies additional details of the reseller. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field. |
Yes |
Request Parameters:
| Attribute | Data Type | Description | Example | Required |
|---|---|---|---|---|
domainName |
String | The unique domain name. | Alphanumeric | Yes |
agreementDateAgreed |
String | The agreement date in YYYY-MM-DD format. | 2024-01-01 | Yes |
agreementUserId |
String | The agreement user ID. | Alphanumeric | Yes |
agreementEmail |
String | The email ID associated with the agreement. | testemail@test.com | Yes |
agreementFirstName |
String | The first name associated with the agreement. | Test | Yes |
agreementLastName |
String | The last name associated with the agreement. | Customer | Yes |
agreementPhoneNumber |
String | The phone number associated with the agreement. | Numeric Value | Yes |
customTermEndDate |
String | The custom date when the agreement will end in YYYY-MM-DD format. | 2024-02-29 | No |
Sample Response
{
"name": "Test Customer",
"referenceId": "my-MSFT-order",
"displayName": "Office-365-F3",
"userId": "1234567",
"userName": "sample username",
"userEmail": "testemail@test.com",
"status": "COMPLETE",
"currencyCode": "EUR",
"total": 132.87,
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}", //URL Path
"referenceId": "reseller.system.id",
"action": "CREATE",
"resourceId": "e182b4e8-098b-123a-a1bc-e30e8f2ea8eb",
"productId": "OFFICE365NCE--smpnce",
"skuId": "Office-365-E1-n1",
"planId": "Monthly-n23",
"quantity": 3,
"providerName": "AZURE",
"price": 132.87, //Price charged by reseller to the end customer
"cost": 119.97, //The cost that the provider is charging the partner
"currencyCode": "EUR",
"subTotal": 132.87,
"endCustomerPO": "10",
"resellerPO": "20",
"attributes": [
{
"name": "userName",
"value": "johnd@SIEQAYP20FEB24FR.onmicrosoft.com"
},
{
"name": "password",
"value": "password"
}
],
"status": "COMPLETE",
"provisioningInfo": {
"processId": "e8118b72-c3d4-1ab2-a1b2-a48fe57e2c95",
"processName": "Microsoft_Create_Order_V3_Provision_Process"
},
"createTime": "2024-02-20T07:51:16Z",
"updateTime": "2024-02-20T07:51:16Z"
}
],
"provisioningInfo": {
"processId": "ab123c45-de6e-4031-9e3c-b18018188f22",
"processName": "Order_V3"
},
"createTime": "2024-02-20T07:51:15Z",
"updateTime": "2024-02-20T07:51:15Z",
"scheduledAt": "2024-02-20T07:51:15Z"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
referenceId |
String | The unique reference ID defined in the request. | NCE-Order-Test |
displayName |
String | The user-defined display name. | Office-365-NCE |
userId |
Numeric | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Number | The total price of the successful order. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | TThe URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
referenceId |
String | The unique reference ID of the order defined in the request. | Microsoft create order |
action |
String | The executed action of the API. | CREATE |
resourceId |
String | Specifies the subscription ID that was created at the external vendor’s side, upon completion of the order. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit(SKU) ID. | Office-365-E1-n1 |
planId |
String | The plan ID. | Monthly-n23 |
quantity |
Integer | The SKU quantity. | 3 |
providerName |
String | The name of the provider. | AZURE |
price |
Number | The price that the reseller charges the end customer. | Numeric |
cost |
Number | The cost that the provider charges the partner. | Numeric |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Number | The total price of the ordererd items. | Numeric |
endCustomerPO |
Integer | The end customer's purchase order. | Numeric |
resellerPO |
Integer | The reseller's purchase order. | Numeric |
attributes |
Array | Array list that specifies additional details of the reseller. | The elements in the attributes array list. |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
status |
String | The status of the order. | COMPLETE |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
provisioningInfo |
Array | This array provides provisioning information about the order items. | The elements in the provisioningInfo array list. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric |
processName |
String | The name of the process. This parameter provides information about the vendor, action, and the endpoint. | Microsoft_Create_Order_V3_Provision_Process |
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
provisioningInfo |
Array | This array provides provisioning information about the created order. | The elements in the provisioningInfo array list. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric |
processName |
String | The name of the process. This parameter provides information about action and API endpoint. | Order_V3 |
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
Response Parameters:
| Attribute | Data Type | Description | Example |
|---|---|---|---|
username |
String | Microsoft tenant username. | testusername |
password |
String | Microsoft tenant password. | testpassword |
Update Order Sequence:
A complete order update scenario includes multiple API calls.
Sequence Diagram:
Steps:
- Obtain
orderIdfrom either the following:- Obtain
orderIdfrom List Customer Orders. - Obtain
customerIdfrom List Account orders.
- Obtain
- Use the
accountIdto update the order.
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Update Order - License Count
This endpoint allows you to update the license count for existing subscriptions. You can increase or decrease the number of licenses based on the vendor's terms and conditions.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders
Sample Request
{
"orderItems": [
{
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USCxxxxxxxxxxxxx01",
"planId": "Monthly-n18",
"action": "UPDATE",
"quantity": 4,
"resourceId": "1fxxxxxx-exxx-xxxx-xxxx-0xxxxxxxxxx4",
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
]
}
]
}
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/26829/customers/683797/orders/1404498",
"userId": "1370623",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "IN_PROGRESS",
"currencyCode": "NOK",
"total": 621.927001953125,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"action": "UPDATE",
"resourceId": "1fxxxa16-xxx-xxxx-xxxx-xxxxx7554",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxxxx",
"mfgPartNumber": "CFxxxxxxxxxx:0001:P1M:M",
"planId": "Monthly-n18",
"quantity": 4,
"providerName": "AZURE",
"price": 155.48175048828125,
"cost": 155.48175048828125,
"msrp": 155.48175048828125,
"currencyCode": "NOK",
"subTotal": 621.927001953125,
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
}
],
"status": "IN_PROGRESS",
"createTime": "2025-05-23T04:47:56Z",
"updateTime": "2025-05-23T04:47:56Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Microsoft 365 NCE",
"skuName": "M365 Business Std",
"planName": "M365 Business Std",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "61xxxxxx-xxxx-4888-xxxx-xxxxxxxxxxxx",
"processName": "Order_V3"
},
"createTime": "2025-05-23T04:47:56Z",
"updateTime": "2025-05-23T04:47:56Z",
"scheduledAt": "2025-05-23T04:47:56Z"
}
The parameters of the update order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Update Order - License Count During Renewals
This endpoint allows you to update the license count during the renewal period of a subscription. You can adjust the number of licenses according to the renewal policies and vendor terms.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}
Sample Request
{
"orderItems": [
{
"productId": "ExchangeOnline-demonce",
"skuId": "Exchange-Online-Plan",
"planId": "Monthly",
"action": "UPDATE",
"quantity": 2,
"resourceId": "0dxxxxx0-xxxx-xxxx-xxxx-4xxxxxxxxf17",
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "renewalSetting",
"value": "auto-on|auto-off"
}
]
}
]
}
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/26xxx/customers/68xxxx/orders/140xxxx",
"userId": "13xxxxx",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "IN_PROGRESS",
"currencyCode": "NOK",
"total": 621.927001953125,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"action": "UPDATE",
"resourceId": "1f2xxxxx-xxxx-xxxx-xxxx-0xxxxxxxxx54",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxx0001",
"mfgPartNumber": "CFxxxxxxxxxx:0001:P1M:M",
"planId": "Monthly-n18",
"quantity": 4,
"providerName": "AZURE",
"price": 155.48175048828125,
"cost": 155.48175048828125,
"msrp": 155.48175048828125,
"currencyCode": "NOK",
"subTotal": 621.927001953125,
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
}
],
"status": "IN_PROGRESS",
"createTime": "2025-05-23T04:47:56Z",
"updateTime": "2025-05-23T04:47:56Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Microsoft 365 NCE",
"skuName": "M365 Business Std",
"planName": "M365 Business Std",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "61xxxxxx-xxxx-xxxx-xxxx-5fxxxxxxx0b0",
"processName": "Order_V3"
},
"createTime": "2025-05-23T04:47:56Z",
"updateTime": "2025-05-23T04:47:56Z",
"scheduledAt": "2025-05-23T04:47:56Z"
}
The parameters of the update order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Update Order - Auto Renew On/Off
Using this endpoint, you can set the auto-renewal status of a subscription. Setting the value as On allows you to renew the subscription automatically at the end of its term.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}
Sample Request
{
"orderItems": [
{
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxx001",
"planId": "Monthly-n18",
"action": "UPDATE",
"quantity": 4,
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx554",
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "renewalSetting",
"value": "auto-on"
}
]
}
]
}
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"userId": "13xxxxx",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "IN_PROGRESS",
"currencyCode": "NOK",
"total": 621.927001953125,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"action": "UPDATE",
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-0axxxxxxxx54",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"mfgPartNumber": "CxxxxxxxxxPB:0001:P1M:M",
"planId": "Monthly-n18",
"quantity": 4,
"providerName": "AZURE",
"price": 155.48175048828125,
"cost": 155.48175048828125,
"msrp": 155.48175048828125,
"currencyCode": "NOK",
"subTotal": 621.927001953125,
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "renewalSetting",
"value": "auto-on"
}
],
"status": "IN_PROGRESS",
"createTime": "2025-05-23T04:54:49Z",
"updateTime": "2025-05-23T04:54:49Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Microsoft 365 NCE",
"skuName": "M365 Business Std",
"planName": "M365 Business Std",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "06xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx32b",
"processName": "Order_V3"
},
"createTime": "2025-05-23T04:54:49Z",
"updateTime": "2025-05-23T04:54:49Z",
"scheduledAt": "2025-05-23T04:54:49Z"
}
The parameters of the update order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the order update should take effect. If not provided, the order is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Update Order - Delete/Suspend/Reactivate Subscription
This endpoint allows you to delete, suspend, or reactivate a subscription. You can set these actions according to the vendor's terms and conditions.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}
Sample Request
{
"orderItems": [
{
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"planId": "Monthly-n18",
"action": "UPDATE",
"quantity": 4,
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-0axxxxxxxx54",
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "statusUpdate",
"value": "suspended"
}
]
}
]
}
'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"userId": "13xxxxx",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "IN_PROGRESS",
"currencyCode": "NOK",
"total": 621.927001953125,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"action": "UPDATE",
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-0axxxxxxxx54",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"mfgPartNumber": "CFxxxxxxxxPB:0001:P1M:M",
"planId": "Monthly-n18",
"quantity": 4,
"providerName": "AZURE",
"price": 155.48175048828125,
"cost": 155.48175048828125,
"msrp": 155.48175048828125,
"currencyCode": "NOK",
"subTotal": 621.927001953125,
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "statusUpdate",
"value": "suspended"
}
],
"status": "IN_PROGRESS",
"createTime": "2025-05-23T04:59:41Z",
"updateTime": "2025-05-23T04:59:41Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Microsoft 365 NCE",
"skuName": "M365 Business Std",
"planName": "M365 Business Std",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "e3xxxxxx-xxxx-xxxx-xxxx-b2xxxxxxxx73",
"processName": "Order_V3"
},
"createTime": "2025-05-23T04:59:40Z",
"updateTime": "2025-05-23T04:59:40Z",
"scheduledAt": "2025-05-23T04:59:40Z"
}
The parameters of the update order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Update Order - Reactivate Subscription
This endpoint is used to reactivate a subscription that was previously suspended. It makes the subscription active again and restores access to the related services.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}
Sample Request
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/<account_id>/customers/<customer_id>/orders'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer MWQ4MGE5YTCTYJLMZS0ZMDNILTG4OWITYWI4MDG1YTRLMJJI' \
--data-raw '{
"orderItems": [
{
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"planId": "Monthly-n18",
"action": "UPDATE",
"quantity": 4,
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-0axxxxxxxx54",
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "statusUpdate",
"value": "active"
}
]
}
]
}'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"userId": "1370623",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "IN_PROGRESS",
"currencyCode": "NOK",
"total": 621.927001953125,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"action": "UPDATE",
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-0axxxxxxxx54",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx01",
"mfgPartNumber": "CFxxxxxxxxxx:0001:P1M:M",
"planId": "Monthly-n18",
"quantity": 4,
"providerName": "AZURE",
"price": 155.48175048828125,
"cost": 155.48175048828125,
"msrp": 155.48175048828125,
"currencyCode": "NOK",
"subTotal": 621.927001953125,
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "statusUpdate",
"value": "active"
}
],
"status": "IN_PROGRESS",
"createTime": "2025-05-23T05:04:10Z",
"updateTime": "2025-05-23T05:04:10Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Microsoft 365 NCE",
"skuName": "M365 Business Std",
"planName": "M365 Business Std",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "e0xxxxxx-xxxx-xxxx-xxxx-29xxxxxxxx0b",
"processName": "Order_V3"
},
"createTime": "2025-05-23T05:04:09Z",
"updateTime": "2025-05-23T05:04:09Z",
"scheduledAt": "2025-05-23T05:04:09Z"
}
The parameters of the update order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Update Order - Upgrade Subscription from Lower Tier to Higher Tier
This endpoint allows you to upgrade a subscription from a lower-tier to a higher-tier plan. The upgrade includes access to enhanced features of a product.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}
Sample Request
curl
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/<account_id>/customers/<customer_id>/orders/<order_id>'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer MWQ4MGE5YTCTYJLMZS0ZMDNILTG4OWITYWI4MDG1YTRLMJJI' \
--data-raw '
{
"orderItems": [
{
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx02",
"planId": "Annual-n155",
"action": "UPDATE",
"quantity": 4,
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-0axxxxxxxx54",
"attributes": [
{
"name": "operations",
"value": "changeSubscription"
}
]
}
]
}'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}",
"userId": "1370623",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "IN_PROGRESS",
"currencyCode": "NOK",
"total": 10950.16796875,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"action": "UPDATE",
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-0axxxxxxxx54",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxxx02",
"mfgPartNumber": "CFxxxxxxxxxx:0002:P1Y:Y",
"planId": "Annual-n155",
"quantity": 4,
"providerName": "AZURE",
"price": 2737.5419921875,
"cost": 2737.5419921875,
"msrp": 2737.5419921875,
"currencyCode": "NOK",
"subTotal": 10950.16796875,
"attributes": [
{
"name": "operations",
"value": "changeSubscription"
}
],
"status": "IN_PROGRESS",
"createTime": "2025-05-23T05:17:55Z",
"updateTime": "2025-05-23T05:17:55Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Microsoft 365 NCE",
"skuName": "M365 Business Premium",
"planName": "M365 Business Premium",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "e4xxxxxx-xxxx-xxxx-xxxx-a2xxxxxxxx7d",
"processName": "Order_V3"
},
"createTime": "2025-05-23T05:17:55Z",
"updateTime": "2025-05-23T05:17:55Z",
"scheduledAt": "2025-05-23T05:17:55Z"
}
The parameters of the update order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Update Order - Delete Subscription
This endpoint allows you to permanently delete an existing subscription.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}
Sample Request
curl --location '
https://ion.tdsynnex.com/api/v3/accounts/<account_id>/customers/<customer_id>/orders/{order_id}'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer MWQ4MGE5YTCTYJLMZS0ZMDNILTG4OWITYWI4MDG1YTRLMJJI' \
--data-raw '
{
"orderItems": [
{
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USCFQ7TTC0LDPB0001",
"planId": "Monthly-n18",
"action": "UPDATE",
"quantity": 4,
"resourceId": "1f29aa16-ef83-4614-cb6e-0ad2e1057554",
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "statusUpdate",
"value": "deleted"
}
]
}
]
}'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Yes |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce | Yes |
skuId |
String | The unique identifier for product SKU (Stock Keeping Unit). | Office-365-E1-n1 | Yes |
planId |
String | The unique identifier for subscription plan to be updated. | Monthly-n23 | Yes |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE | Yes |
quantity |
Integer | The product quantity to be updated. | 3 | Yes |
resourceId |
String | The product subscription ID, that is provided by the vendor. | 3 | Yes |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
Yes |
Elements in the attributes array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
Yes |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field, such as updateSubscription. |
Yes |
Sample Response
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}",
"userId": "1370623",
"userName": "John Doe",
"userEmail": "john.doe@tdsynnex.com",
"status": "IN_PROGRESS",
"currencyCode": "NOK",
"total": 621.927001953125,
"portal": "v3",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItems_id}",
"action": "UPDATE",
"resourceId": "1fxxxxxx-xxxx-xxxx-xxxx-0axxxxxxxx54",
"productId": "Microsoft365EandFNCE-demonce",
"skuId": "USxxxxxxxxxxxxx01",
"mfgPartNumber": "CFxxxxxxxxxx:0001:P1M:M",
"planId": "Monthly-n18",
"quantity": 4,
"providerName": "AZURE",
"price": 155.48175048828125,
"cost": 155.48175048828125,
"msrp": 155.48175048828125,
"currencyCode": "NOK",
"subTotal": 621.927001953125,
"attributes": [
{
"name": "operations",
"value": "updateSubscription"
},
{
"name": "statusUpdate",
"value": "deleted"
}
],
"status": "IN_PROGRESS",
"createTime": "2025-05-23T05:52:44Z",
"updateTime": "2025-05-23T05:52:44Z",
"pricingInfo": "Pricebook price",
"wqmTaskStatus": "Task Not Created",
"productName": "Microsoft 365 NCE",
"skuName": "M365 Business Std",
"planName": "M365 Business Std",
"productOwnerCountryCode": "NL"
}
],
"provisioningInfo": {
"processId": "23xxxxxx-xxxx-xxxx-xxxx-6dxxxxxxxx28",
"processName": "Order_V3"
},
"createTime": "2025-05-23T05:52:43Z",
"updateTime": "2025-05-23T05:52:43Z",
"scheduledAt": "2025-05-23T05:52:43Z"
}
The parameters of the update order endpoint response vary according to the vendors.
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
userId |
String | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Double | The total price of the successful order. | Numeric |
portal |
String | The version of API. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
provisioningInfo |
Array | This array provides the provisioning information about the order items. | The elements in the provisioningInfo array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
scheduledAt |
String | The time when the order is scheduled to be updated in YYYY-MM-DD HH:Min format. It indicates the timestamp when the license count update should take effect. If not provided, the license count is updated immediately. | 2024-01-01T07:51:16Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
action |
String | Specifies the action such as CREATE, UPDATE and so on. | CREATE |
resourceId |
String | Specifies the product subscription ID, that is provided by the vendor. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
mfgPartNumber |
String | The manufacturing part number of the product. | Office-365-E1-n1 |
planId |
String | The plan ID of a subscription to be updated. | Monthly-n23 |
quantity |
Integer | The number of products. | 3 |
providerName |
String | The name of the vendor. | AZURE |
price |
Double | The price that the reseller charges to the end customer. | 155.481 |
cost |
Double | The cost that the provider charges to the partner. | 155.481 |
msrp |
Double | The cost that the provider charges to the partner. | 155.481 |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Double | The final price of the ordered items. | Numeric |
attributes |
Array | Array list that specifies the product-specific attributes, which are provided as Name - Value pair, as specified in the provisioning template. For more information, see Provisioning Template APIs. | The elements in the attributes array list. |
status |
String | The status of the order. | The elements in the attributes array list. |
createTime |
String | The time when the order is created in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
updateTime |
String | The time when the order is updated in YYYY-MM-DD HH:Min format. | 2025-05-23T04:47:56Z |
pricingInfo |
String | The pricing details of the order. | Pricebook price. |
wqmTaskStatus |
String | The status of a task that is handled by the WQM module. | Task Not Created |
productName |
String | The name of the product. | Microsoft 365 NCE |
skuName |
String | The name of the Stock Keeping Unit. | M365 Business Std |
planName |
String | The plan name of a subscription to be updated. | M365 Business Std. |
productOwnerCountryCode |
String | The country code of the customer (product owner). | NL |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric value |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Microsoft_Create_Order_V3_Provision_Process |
Sample Response - Error 400:Required attributes are not present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-001 ",
"detail": "The 'productId' attribute must be present in the 'order.orderItem' object."
}
]
}
]
}
Response Parameters: Error 400:Required attributes are not present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/v3orberrors.ErrorBody |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-001 |
detail |
String | Additional details of the error | The 'productId' attribute must be present in the 'order.orderItem' object. |
Sample Response - Error 400: Value of the atrribute is not one of the allowed values
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-002",
"detail": "The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED']."
}
]
}
]
}
Response Parameters: Error 400:Value of the atrribute is not one of the allowed values
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-002 |
detail |
String | Additional details of the error. | The 'order.status' must be equal to one of the allowed values: ['NEW', 'CONFIRMED', 'ON_HOLD', 'COMPLETED', 'ERROR', 'CANCELED'] |
Sample Response - Error 400: If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-003",
"detail": "The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.action is 'UPDATE', then order.orderItem.resourceId must be present
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-003 |
detail |
String | Additional details of the error. | The 'resourceId' attribute must be present in the 'order.orderItem' object when 'action' is 'UPDATE'. |
Sample Response - Error 400: If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
{
"error": "BAD_REQUEST: Invalid provisioning data",
"message": "BAD_REQUEST: Invalid provisioning data",
"code": 3,
"details": [
{
"@type": "type.googleapis.com/v3orberrors.ErrorBody",
"requestId": "17709cedcb7c7ee0423c",
"errors": [
{
"code": "COMM-VL-004",
"detail": "The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE'."
}
]
}
]
}
Response Parameters: Error 400:If order.orderItem.providerName is 'AZURE' and order.orderItem.action is 'CREATE'
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | BAD_REQUEST: Invalid provisioning data |
message |
String | Error description. | BAD_REQUEST: Invalid provisioning data |
code |
String | Error code. | 3 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
errors |
Array | Additional details about the error. | The elements in the errors array list. |
Elements in the errors array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Specific error code. | COMM-VL-004 |
detail |
String | Additional details of the error. | The 'domainName' attribute must be present in the 'Order.orderItem.attributes' array when the provider is 'AZURE' and the action is 'CREATE' |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Cancel Order
This API allows a partner to initiate the cancellation of an order under specific conditions. An upstream partner can cancel the order if the order status is "New" or "On hold" immediately after placing an order.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/orders/{orderId}:cancel
Sample Request:
curl --location --globoff --request POST 'https://ion.tdsynnex.com/api/v3/accounts/1234/customers/23456/orders/1234:cancel' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
customerId |
String | The unique customer ID. | 45678 | Yes |
orderId |
String | The unique order ID. | 7890 | Yes |
{
"name": "Test Customer",
"referenceId": "my-MSFT-order",
"displayName": "Office-365-F3",
"userId": "1234567",
"userName": "sample username",
"userEmail": "testemail@test.com",
"status": "COMPLETE",
"currencyCode": "EUR",
"total": 132.87,
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}", //URL Path
"referenceId": "reseller.system.id",
"action": "CREATE",
"resourceId": "e182b4e8-098b-123a-a1bc-e30e8f2ea8eb",
"productId": "OFFICE365NCE--smpnce",
"skuId": "Office-365-E1-n1",
"planId": "Monthly-n23",
"quantity": 3,
"providerName": "AZURE",
"price": 132.87, //Price charged by reseller to the end customer
"cost": 119.97, //The cost that the provider is charging the partner
"currencyCode": "EUR",
"subTotal": 132.87,
"endCustomerPO": "10",
"resellerPO": "20",
"attributes": [
{
"name": "userName",
"value": "johnd@SIEQAYP20FEB24FR.onmicrosoft.com"
},
{
"name": "password",
"value": "password"
}
],
"status": "COMPLETE",
"provisioningInfo": {
"processId": "e8118b72-c3d4-1ab2-a1b2-a48fe57e2c95",
"processName": "Microsoft_Create_Order_V3_Provision_Process"
},
"createTime": "2024-02-20T07:51:16Z",
"updateTime": "2024-02-20T07:51:16Z"
}
],
"provisioningInfo": {
"processId": "ab123c45-de6e-4031-9e3c-b18018188f22",
"processName": "Order_V3"
},
"createTime": "2024-02-20T07:51:15Z",
"updateTime": "2024-02-20T07:51:15Z",
"scheduledAt": "2024-02-20T07:51:15Z"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the customer. | Test Customer |
referenceId |
String | The unique reference ID defined in the request. | NCE-Order-Test |
displayName |
String | The user-defined display name. | Office-365-NCE |
userId |
Numeric | The unique user ID. | 12345 |
userName |
String | The username. | testusername |
userEmail |
String | The user email ID. | testemail@test.com |
status |
String | The status of the order. | COMPLETE |
currencyCode |
String | The currency code. | USD, EUR |
total |
Number | The total price of the successful order. | Numeric |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in the orderItems array list |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | TThe URL for the successfully placed order. | accounts/{account_id}/customers/{customer_id}/orders/{order_id} |
referenceId |
String | The unique reference ID of the order defined in the request. | Microsoft create order |
action |
String | The executed action of the API. | CREATE |
resourceId |
String | Specifies the subscription ID that was created at the external vendor’s side, upon completion of the order. | Alphanumeric |
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit(SKU) ID. | Office-365-E1-n1 |
planId |
String | The plan ID. | Monthly-n23 |
quantity |
Integer | The SKU quantity. | 3 |
providerName |
String | The name of the provider. | AZURE |
price |
Number | The price that the reseller charges the end customer. | Numeric |
cost |
Number | The cost that the provider charges the partner. | Numeric |
currencyCode |
String | The currency code. | USD, EUR |
subTotal |
Number | The total price of the ordererd items. | Numeric |
endCustomerPO |
Integer | The end customer's purchase order. | Numeric |
resellerPO |
Integer | The reseller's purchase order. | Numeric |
attributes |
Array | Array list that specifies additional details of the reseller. | The elements in the attributes array list. |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | username,password |
value |
String | Value of the attribute. | The value of the attribute mentioned in the name field. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
status |
String | The status of the order. | COMPLETE |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
provisioningInfo |
Array | This array provides provisioning information about the order items. | The elements in the provisioningInfo array list. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric |
processName |
String | The name of the process. This parameter in the orderitems array provides information about the vendor, action, and the endpoint. |
Microsoft_Create_Order_V3_Provision_Process |
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
provisioningInfo |
Array | This array provides provisioning information about the created order. | The elements in the provisioningInfo array list. |
Elements in the provisioningInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | Alphanumeric |
processName |
String | The name of the process. This parameter provides information about action and API endpoint. | Order_V3 |
createTime |
String | The time when the order was created in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
updateTime |
String | The time when the order was updated in YYYY-MM-DD HH:Min format. | 2024-01-01T07:51:16Z |
Cancel Order Scenario:
A complete order cancellation scenario includes multiple API calls.
Sequence Diagram:
Steps:
- Obtain
orderIdfrom either the following:- Obtain
orderIdfrom List Customer Orders. - Ontain
customerIdfrom List Account orders.
- Obtain
- Use the
accountIdto cancel the order.
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 404
{
"error": "NOT_FOUND",
"message": "resource 'accounts/1234/customers/12345/orders/4567' not found",
"code": 404,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 404 - Not Found
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | NOT_FOUND |
message |
String | Error description. | resource accounts/1234/customers/12345/orders/4567 not found. |
code |
String | Error code. | 404 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Subscription
The Subscription endpoints of StreamOne® Ion API allow you to:
List Customer Subscriptions
This endpoint allows you to retrieve details such as subscription IDs, number of licenses, and other relevant subscription-related data for a specific customer.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/subscriptions
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerID |
String | The unique customer ID. | 12345 | No |
subscriptionID |
String | The unique subscription ID. | 12345 | No |
resellerId |
Integer | The unique reseller ID. | 12345 | No |
providerId |
Integer | The unique cloud provider ID. | 12345 | No |
subscriptionStatus |
String | The current status of the subscription, such as,
|
INITIATED | No |
startDateRange.relativeDateRange |
String | The relative start date range of the list of subscriptions, such as,
|
UNKNOWN_RELATIVE_DATE_RANGE | No |
startDateRange.fixedDateRange.endDate |
String | Displays the results according to the start and end dates of a subscription. | 2023-9-17T09:48:16Zto2023-10-17T09:48:16Z | No |
endDate |
String | The time when the subscription ends in YYYY-MM-DD HH:Min format. | 2023-10-17T09:48:16Z | No |
endDateRange.relativeDateRange |
String | The relative end date range of the list of subscriptions, such as,
|
UNKNOWN_RELATIVE_DATE_RANGE | No |
endDateRange.fixedDateRange.startDate |
Filtering the results based on the start and end date of a subscription. | 2023-9-17T09:48:16Zto2023-10-17T09:48:16Z | No | |
billingTerm |
String | The period for which the subscription service is active. For example, Monthly, Quarterly, Annually, etc. | Monthly | No |
totalLicense |
String | The total number of subscriptions available for the account. | 1 | No |
ccpProductId |
String | The unique product ID in the CCP catalog. | TechDataAzureSentinel-smp | No |
providerProductId |
String | The unique product ID in the provider catalog. | Microsoft-product-id | No |
customerPo |
String | The end customer's purchase order. | customerpurchaseorder | |
resellerPo |
String | The reseller's purchase order. | resellerpurchaseorder | |
pagination |
String | Additional information about the pagination query parameters is available in the pagination parameters table. | Refer to the pagination parameters table | Yes |
customField.field |
String | Filter CustomerCustomFields attributes. Key name must be passed to this filter. | domainName | No |
customField.value |
String | Filter CustomerCustomFields attributes. Corresponding value for the key name must be passed to this filter. | ABCDEFG12FEB24FR | No |
cloudProviderName |
String | Name of the cloud provider, such as, GCP, AWS, etc. | AWS | No |
accountName |
String | Name of the account. | Account Name | No |
customerName |
String | Name of the customer. | John Doe | No |
subscriptionName |
String | Name of the subscription | Microsoft-subscription | No |
resourceType |
String | tring | Resource type is a unique identifier assigned to a resource within the subscriptions, such as:
|
VERTEX::Solution |
Pagination Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
limit |
Integer | Indicates the number of results that are returned in the response. | 10 | Yes |
offset |
Integer | Indicates the number of initial results that are skipped in the response | 10 | No |
filter |
String | Custom filters that can be applied to retrieve the required data. | microsoftsubscription | No |
sortBy |
String | This parameter allows to sort the data by a specific criterica. | resourcetype | No |
sortOrder |
String | Allows you to sort the data in ascending or descending order using ASC or DESC. | DESC | No |
userId |
Integer | A unique user ID assigned to users within a cart. | 1234 | No |
Sample Response:
{
"totalCount": "string",
"items": [
{
"id": "string",
"customerId": "string",
"resellerId": "string",
"isvId": "string",
"cloudProviderId": "string",
"subscriptionId": "string",
"subscriptionName": "string",
"resourceType": "ACRONIS::Tenant",
"ccpProductId": "string",
"ccpSkuId": "string",
"ccpPlanId": "string",
"subscriptionProductId": "string",
"subscriptionSkuId": "string",
"subscriptionOfferId": "string",
"subscriptionTotalLicenses": "string",
"unitType": "string",
"subscriptionStatus": "ACCEPTED",
"subscriptionPurchasedDate": "2019-08-24T14:15:22Z",
"subscriptionStartDate": "2019-08-24T14:15:22Z",
"subscriptionEndDate": "2019-08-24T14:15:22Z",
"cancellationAllowedUntilDate": "2019-08-24T14:15:22Z",
"subscriptionBillingType": "string",
"subscriptionBillingCycle": "string",
"subscriptionBillingTerm": "string",
"subscriptionRenewStatus": "string",
"billingCurrency": "string",
"customerCost": 0,
"parentSubscriptionId": "string",
"resellerPO": "string",
"customerPO": "string",
"ccpProductInfo": {
"productId": "string",
"productDisplayName": "string",
"skuId": "string",
"skuDisplayName": "string",
"planId": "string",
"planDisplayName": "string"
},
"isTrial": true,
"autoRenew": true,
"customerName": "string",
"partnerName": "string",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"price": 0,
"cost": 0,
"currency": "string",
"margin": 0,
"msrp": 0,
"renewalDate": "2019-08-24T14:15:22Z",
"cloudProviderName": "string"
}
],
"paginationResponse": {
"totalSize": 0
}
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
totalCount |
Integer | The total number of subscriptions available for the account. | 1 |
items |
Array | Array list that specifies subscription information. | The elements in the items array list. |
Elements in the ccpProductInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | The unique ID obtained from get customer subscription details endpoint. | 1234567 |
customerId |
String | The unique customer ID. | 12345 |
resellerId |
String | The unique reseller ID. | 1234 |
isvId |
String | ISV id in CCP. | 1234 |
cloudProviderId |
String | The unique cloud provider ID. | 111 |
subscriptionId |
String | The subscription ID from the provider. | 0a1b2345-a1bc-12ab-b0df-9d6a5cdb19f9 |
subscriptionName |
String | Name of the subscription product. | SentinelV1 |
resourceType |
String | Resources type is an unique identifier assigned to a resource within the subscriptions, such as:
|
VERTEX::Solution |
ccpProductId |
String | Unique identifier for the CCP product in the CCP catalog. | TechDataAzureSentinel-smp |
ccpSkuId |
String | Unique identifier for product SKU in the CCP catalog. | Tech-Data-Azure-Sentinel |
ccpPlanId |
String | Unique identifier for the product plan in the CCP catalog. | Based-on-Usage |
subscriptionProductId |
String | Unique identifier for the product in the provider product. | TechDataAzureSentinel-smp |
subscriptionSkuId |
String | Unique identifier for the product SKU in the provider product. | Tech-Data-Azure-Sentinel |
subscriptionOfferId |
String | Unique identifier for product offer in the provider product. | SentinelV1 |
subscriptionTotalLicenses |
Integer | Total number of subscription licences. | 1 |
unitType |
String | Provides the unit type of purchased subscription. | Usage-based |
subscriptionStatus |
String | The current status of the subscription, such as,
|
INITIATED |
subscriptionPurchasedDate |
String | The time when the subscription was purchased in YYYY-MM-DD HH:Min format. | 2023-10-17T09:48:16Z |
subscriptionStartDate |
String | The time when the subscription was started in YYYY-MM-DD HH:Min format. | 2023-10-17T09:48:16Z |
subscriptionEndDate |
String | The time when the subscription will end in YYYY-MM-DD HH:Min format. | 9999-12-31T00:00:00Z |
cancellationAllowedUntilDate |
String | The final date by which cancellation of the subscription is permitted. | 2023-14-17T09:48:16Z |
subscriptionBillingType |
String | Method used for billing subscription, such as,
|
usage |
subscriptionBillingCycle |
String | The period during which the subscriber is billed for the service. For example, Monthly, Quarterly, Annually, etc. | Monthly |
subscriptionBillingTerm |
String | Refers to the period for which the subscription service is active. For example, Monthly, Quarterly, Annually, etc. | Monthly |
subscriptionRenewStatus |
String | Indicates if the subscription renewal status is enabled or not. | ENABLED |
billingCurrency |
String | The billing currency. | USD |
customerCost |
Integer | Customer cost is the cost incurred by customer to obtain a product or service. This value will be returned for Microsoft CSP(VM and Perpetual) provider. | 2 |
parentSubscriptionId |
String | The parent subscription ID parameter is only returned for Azure, Perpetual and GWS Subscription. | parentSubscriptionID-Sample |
customerPo |
String | The end customer's purchase order. | customerpurchaseorder |
resellerPo |
String | The reseller's purchase order. | resellerpurchaseorder |
Elements in the ccpProductInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
productId |
String | Unique product ID in the CCP catalog. | TechDataAzureSentinel-smp |
productDisplayName |
String | Product display name in the CCP catalog. | TD SYNNEX Azure Sentinel |
skuId |
String | Product SKU ID in the CCP catalog. | Tech-Data-Azure-Sentinel |
skuDisplayName |
String | Product SKU name in the CCP catalog. | TD SYNNEX Azure Sentinel |
planId |
String | Product plan ID in the CCP catalog. | Based-on-Usage |
planDisplayName |
String | Plan display name in the CCP catalog. | TD SYNNEX Azure Sentinel |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
isTrial |
Boolean | Indicates if the subscription is in the trial phase. | true |
autoRenew |
String | Indicates if auto renewal is enabled for the subscription. | true |
customerName |
String | Name of the customer who purchased the plan. This will be a combination of first and last name. | John Doe |
partnerName |
String | Name of the partner. | Partnername |
lastUpdatedDate |
String | The time when the subscription was last updated in YYYY-MM-DD HH:Min format. | 2024-08-24T14:15:22Z |
price |
Number | The price that the reseller charges the end customer. | 100 |
cost |
Number | The cost that the provider charges the partner. | 90 |
currency |
String | The currency code. | USD |
margin |
Integer | Provides the margin value. | 0 |
total |
Integer | The total price of the subscription. | 0 |
msrp |
Integer | Provides the MSRP value. | 0 |
renewalDate |
String | The subscription renewal date in YYYY-MM-DD HH:Min format. | 2025-12-31T00:00:00Z |
cloudProviderName |
String | Cloud provider name. For example, AWS, GCP, etc. | AWS |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - InternalServerError
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Get Customer Subscription Details
The Get Customer Subscription Details endpoint allows you to retrieve details of a specific subscription, such as subscription IDs, number of licenses and other relevant subscription-related data for a specific customer.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/subscriptions/{subscriptionId}
Sample Request:
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/1234/customers/12345/subscriptions/123456' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
customerId |
String | The unique customer ID. | 45678 | Yes |
subscriptionId |
String | The unique subscription ID. | 7890 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
refresh |
Boolean | Including the refresh query parameter with the request, updates the results. | https://ion.tdsynnex.com/api/v3/accounts/{accountId}/customers/{customerId}/subscriptions/{subscriptionId}?refresh |
No |
Sample Response:
{
"id": "1234567",
"customerId": "12345",
"resellerId": "1234",
"isvId": "1234",
"cloudProviderId": "111",
"subscriptionId": "0a1b2345-a1bc-12ab-b0df-9d6a5cdb19f9",
"subscriptionName": "SentinelV1",
"resourceType": "VERTEX::Solution",
"ccpProductId": "TechDataAzureSentinel-smp",
"ccpSkuId": "Tech-Data-Azure-Sentinel",
"ccpPlanId": "Based-on-Usage",
"subscriptionProductId": "TechDataAzureSentinel-smp",
"subscriptionSkuId": "Tech-Data-Azure-Sentinel",
"subscriptionOfferId": "SentinelV1",
"subscriptionTotalLicenses": "1",
"unitType": "Usage-based",
"subscriptionStatus": "initiated",
"subscriptionPurchasedDate": "2023-10-17T09:48:16Z",
"subscriptionStartDate": "2023-10-17T09:48:16Z",
"subscriptionEndDate": "9999-12-31T00:00:00Z",
"subscriptionBillingType": "usage",
"subscriptionBillingCycle": "monthly",
"subscriptionBillingTerm": "P1M",
"subscriptionRenewStatus": "ENABLED",
"activityLogs": {
"totalCount": "string",
"items": [
{
"id": "string",
"actionType": "string",
"actionDate": "2024-08-24T14:15:22Z",
"actionStatus": "string",
"productId": "string",
"skuId": "string",
"offerId": "string",
"quantity": "string",
"subscriptionStatus": "ACCEPTED",
"partnerId": "string",
"billingCycle": "string",
"billingTerm": "string",
"autoRenewStatus": "string",
"actionDetails": "string",
"completionDate": "2024-08-24T14:15:22Z",
"ccpUserId": "string",
"ccpUserName": "string",
"ccpUserEmail": "string"
}
]
},
"attributes": [
{
"name": "CloudProvider",
"value": "Azure"
},
{
"name": "CustomerDomain",
"value": "duncofruitsupplu123.onmicrosoft.com"
},
{
"name": "CustomerTenantId",
"value": "cfc0ef66-1b44-4932-9702-53eca5136989"
},
{
"name": "EventId",
"value": "84525fa5-1b98-4708-ab33-187d44333c77"
},
{
"name": "OrderId",
"value": "140845"
},
{
"name": "OrderItemId",
"value": "160077"
},
{
"name": "ProcessId",
"value": "0e7e6127-a2cb-48cc-b0df-9d6a5cdb19f9"
},
{
"name": "Region",
"value": "US"
}
],
"ccpProductInfo": {
"productId": "TechDataAzureSentinel-smp",
"productDisplayName": "TD SYNNEX Azure Sentinel",
"skuId": "Tech-Data-Azure-Sentinel",
"skuDisplayName": "TD SYNNEX Azure Sentinel",
"planId": "Based-on-Usage",
"planDisplayName": "TD SYNNEX Azure Sentinel"
},
"isTrial": false,
"autoRenew": true,
"customerName": "Sample Name",
"price": 0,
"cost": 0,
"currency": "USD",
"margin": 0,
"total": 0,
"msrp": 0,
"renewalDate": "2025-12-31T00:00:00Z"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | The unique ID obtained from the get customer subscription details endpoint. | 1234567 |
customerId |
String | The unique customer ID. | 12345 |
resellerId |
String | The unique reseller ID. | 1234 |
isvId |
String | ISV ID in CCP. | 1234 |
cloudProviderId |
String | The unique cloud provider ID. | 111 |
subscriptionId |
String | The subscription ID from the provider. | 0a1b2345-a1bc-12ab-b0df-9d6a5cdb19f9 |
subscriptionName |
String | Name of the subscription product. | SentinelV1 |
resourceType |
String | Resources type is a unique identifier assigned to a resource within the subscriptions, such as:
|
VERTEX::Solution |
ccpProductId |
String | Unique identifier for the CCP product in the CCP catalog. | TechDataAzureSentinel-smp |
ccpSkuId |
String | Unique identifier for product SKU in the CCP catalog. | Tech-Data-Azure-Sentinel |
ccpPlanId |
String | Unique identifier for the product plan in the CCP catalog. | Based-on-Usage |
subscriptionProductId |
String | Unique identifier for the product in the provider product. | TechDataAzureSentinel-smp |
subscriptionSkuId |
String | Unique identifier for the product SKU in the provider product. | Tech-Data-Azure-Sentinel |
subscriptionOfferId |
String | Unique identifier for product offer in the provider product. | SentinelV1 |
subscriptionTotalLicenses |
Integer | Total number of subscription licences. | 1 |
unitType |
String | Provides the unit type of purchased subscription. | Usage-based |
subscriptionStatus |
String | The current status of the subscription, such as,
|
INITIATED |
subscriptionPurchasedDate |
String | The time when the subscription was purchased in YYYY-MM-DD HH:Min format. | 2023-10-17T09:48:16Z |
subscriptionStartDate |
String | The time when the subscription was started in YYYY-MM-DD HH:Min format. | 2023-10-17T09:48:16Z |
subscriptionEndDate |
String | The time when the subscription will end in YYYY-MM-DD HH:Min format. | 9999-12-31T00:00:00Z |
subscriptionBillingType |
String | The method used for billing subscriptions, such as,
|
usage |
subscriptionBillingCycle |
String | The period during which the subscriber is billed for the service. For example, Monthly, Quarterly, Annually, and so on. | Monthly |
subscriptionBillingTerm |
String | Refers to the period for which the subscription service is active. For example, Monthly, Quarterly, Annually and so on. | Monthly |
subscriptionRenewStatus |
String | Indicates if the subscription renewal status is enabled. | ENABLED |
activityLogs |
Array | Array list that specifies activity logs of the GCP, AZURE, AWS, or SOPHOS subscription. | The elements in the activityLogs array list |
Elements in the activityLogs array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
totalCount |
Integer | Total number of GCP, AWS, AZURE, or SOPHOS licences that were purchased. | 10 |
items |
Array | Array list that specifies details of the subscriptions. | The elements in the items array list |
Elements in the items array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
actionType |
String | The last action carried out for the subscription, such as, create, update, delete, retrieve. | CREATE |
actionDate |
String | The time when the action occured in YYYY-MM-DD HH:Min format. | 2024-10-17T09:48:16Z |
actionStatus |
String | The current status of the action. | Processing |
productId |
String | The unique product ID in the CCP catalog. | AZURE |
skuId |
String | The unique SKU ID in the CCP catalog. | AZURE-SKU |
offerId |
String | The unique offer ID for the product. | AZURE-offer-id |
quantity |
Integer | The number of licences. | 10 |
subscriptionStatus |
String. | The status of the subscription, such as,
|
ACTIVE |
partnerId |
String | The unique partner ID. | Microsoft |
billingCycle |
String | The method used for billing subscriptions, such as licence, free trial, etc. | FREE TRIAL |
billingTerm |
String | The period for which the subscription service is active. For example, Monthly, Quarterly, Annually, and so on. | Monthly |
autoRenewStatus |
String | Indicates if auto renewal is enabled for the subscription. | true |
actionDetails |
String | Additional details about the action. | String |
completionDate |
String | The date when the action will be completedin YYYY-MM-DD HH:Min format. | 2024-10-17T09:48:16Z |
ccpUserId |
Integer | The unique ID assigned to user in CCP. | 12345 |
ccpUserName |
String | Name of the user. | John Doe |
ccpUserEmail |
String | Email ID of the customer in CCP. | johndoe@sample.com |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
attributes |
Array | Array list that specifies custom attributes of the subscription. | The elements in the attributes array list |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Contain vendor specific attribute keys such as, cloud provider, customer domain, customer tenant ID, etc. | CloudProvider |
value |
String | Includes vendor specific attribute value such as, Azure, samplecustomerdomain@example.com, and so on. | Azure |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
ccpProductInfo |
Array | Array list that specifies CCP product information. | The elements in the ccpProductInfo array list |
Elements in the ccpProductInfo array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
productId |
String | Identifier for the product in the CCP catalog. | TechDataAzureSentinel-smp |
productDisplayName |
String | Product display name in the CCP catalog. | TD SYNNEX Azure Sentinel |
skuId |
String | Product SKU ID in the CCP catalog. | Tech-Data-Azure-Sentinel |
skuDisplayName |
String | Product SKU name in the CCP catalog. | TD SYNNEX Azure Sentinel |
planId |
String | Product plan ID in the CCP catalog. | Based-on-Usage |
planDisplayName |
String | Plan display name in the CCP catalog. | TD SYNNEX Azure Sentinel |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
isTrial |
Boolean | Indicates if the subscription is in trial phase. | true |
autoRenew |
String | Indicates if auto renewal is enabled for the subscription. | true |
customerName |
String | Name of the customer who purchased the plan. This will be a combination of first and last name. | John Doe |
partnerName |
String | Name of the partner. | Partnername |
lastUpdatedDate |
String | The time when the subscription was last updated in YYYY-MM-DD HH:Min format. | 2024-08-24T14:15:22Z |
price |
Number | The price that the reseller charges the end customer. | 100 |
cost |
Number | The cost that the provider charges the partner. | 90 |
currency |
String | The currency code. | USD |
margin |
Integer | Provides the margin value. | 0 |
total |
Integer | The total price of the subscription. | 0 |
msrp |
Integer | Provides the MSRP value. | 0 |
renewalDate |
String | The subscription renewal date in YYYY-MM-DD HH:Min format. | 2025-12-31T00:00:00Z |
cloudProviderName |
String | Cloud provider name. For example, AWS, GCP, etc. | AWS |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | permission denied to access accounts/12345 |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - InternalServerError
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Provisioning Templates
The Provisioning Templates endpoints of StreamOne® Ion V3 API allow you to:
- Get provisioning information by template ID
- Get provisioning information references by vendor, provider, or action
Get Provisioning Info By Vendor
The Provisioning API provides comprehensive information required for provisioning subscriptions. This includes details for creating and updating operations for Google, Microsoft, and IBM products and services. The response from this API provides all the necessary fields and information for seamless provisioning of various cloud products and services.
This endpoint supports filtering by vendor, provider and action.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/provisionTemplates
curl --location 'https://ion.tdsynnex.com/api/v3/accounts/1234/provisionTemplates?vendor=MICROSOFT&action=CREATE' \
--header 'Authorization: Bearer XXXXXXRMZGITODZMZI0ZNXXXXXXZMJKTZWRJZJVINTXXXXXX'
Request Parameter Description:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
Query Parameter Description:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
vendor |
String | Name of the vendor, such as,
|
MICROSOFT | Yes |
provider |
String | Name of the provider. | Sample provider | No |
action |
String | The action you need to perform for the selected vendor, such as,
|
CREATE | No |
Sample Response:
{
"id": "string",
"schema": "string",
"title": "string",
"description": "string",
"type": "string",
"properties": {
"referenceId": {
"type": "string",
"description": "User-defined reference Id of the order"
},
"displayName": {
"type": "string",
"description": "User-defined name of the order"
},
"orderItems": {
"type": "array",
"items": "#/$defs/orderItems"
}
},
"defs": {
"orderItems": {
"type": "object",
"description": "OrderItem details required for placing create order",
"required": [
"productId",
"skuId",
"planId",
"action",
"quantity",
"vendor",
"providerName",
"attributes"
],
"properties": {
"referenceId": {
"type": "string",
"description": "User-defined reference Id of the order item"
},
"productId": {
"type": "string",
"description": "User-defined reference Id of the order item"
},
"skuId": {
"type": "string",
"description": "Fetch from the product catalog <<product.sku.id>>"
},
"planId": {
"type": "string",
"description": "Fetch from the product catalog <<product.plan.id>>"
},
"action": {
"type": "string",
"description": "create"
},
"quantity": {
"type": 1,
"description": "Provide required license quantity"
},
"vendor": {
"type": "string",
"description": "Vendor name of the product: google"
},
"providerName": {
"type": "string",
"description": "Provide product category as a provider"
},
"endCustomerPO": {
"type": "string",
"description": "User-defined End customer purchase order reference"
},
"resellerPO": {
"type": "string",
"description": "User-defined Reseller purchase order reference"
},
"attributes": {
"type": "array",
"description": "Product specific attributes are represented as name value pair",
"items": {
"ref": "#/$defs/attributes"
}
}
}
},
"attributes": {
"type": "object",
"description": "Product specific attributes are represented as name-value pairs",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"enum": [
"alternateEmail",
"customerDomain",
"userName",
"billingEmail",
"projectName"
]
},
"value": {
"type": "string",
"description": "Required value for the above key"
}
}
}
}
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | The unique provisioned template ID. | provisioningtemplate12 |
schema |
String | The schema represents the source of the provisioned data. | https://json-schema.org/draft/1234-12/schema |
title |
String | Title of the provisioned data request. | Microsoft create |
description |
String | Added details about the provisioned template. | This document records the payload of Microsoft create order. |
type |
String | Provides the type of provisioning. | Object |
properties |
Array of objects | Object list that specifies the properties of the provisioned template. | The elements in the properties array list. |
Elements in the properties object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
referenceId |
Array of objects | Object list that specifies the details of the reference ID. | The elements in the referenceId array list. |
Elements in the referenceId object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | The type of reference ID. | string |
description |
String | Additional information about the reference ID. | User-defined reference ID of the order. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
Array of objects | Object list that specifies the details of the display name. | The elements in the displayName array list. |
Elements in the displayName object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | The type of display name. | String |
description |
String | Additional information about the display name. | User-defined name of the order |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
orderItems |
Array of objects | Object list that specifies the details of the order items. | The elements in the orderItems array list. |
Elements in the orderItems object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
Array | The type of order items. | Array of objects |
items |
String | Additional details about the order items. | Elements in the #/$defs/orderItems array. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
defs |
Array of objects | Information about the order items. | The elements in the defs array list. |
Elements in the defs object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
orderItems |
Array of objects | Additional details about the order items. | Elements in the orderItems object list. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | The type of order items. | object |
description |
String | Additional information about the order items. | Order Item details required for placing create order. |
required |
Array | Array of mandatory parameters for placing an order. | Elements in the required array. |
Elements in the required array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
planId |
String | The plan ID. | Monthly-n23 |
action |
String | Specifies the CREATE action. | CREATE |
quantity |
Integer | The SKU quantity. | 3 |
vendor |
String | Name of the vendor, such as,
|
MICROSOFT |
providerName |
String | The name of the provider. | AZURE |
attributes |
Array | Array list that specifies additional details of the reseller. | domainName,agreementDateAgreed |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
properties |
Array of objects | Additional information about the required properties of the order items. | Elements in the properties object list. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
referenceId |
Array | Information about order item reference ID. | Elements in the referenceID array list. |
Elements in the referenceID array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of reference ID. | |
description |
String | User-defined reference Id of the order item. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
productId |
Array | Information about the product ID. | Elements in the productID array list. |
Elements in the productID array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the product ID. | String |
description |
String | Additional details about the product ID parameter. | Fetch from the product catalog < |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
skuId |
Array | Information about the SKU ID. | Elements in the skuId array list. |
Elements in the skuID array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the SKU ID. | String |
description |
String | Additional details about the SKU ID parameter. | Fetch from the product catalog < |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
planId |
Array | Information about the plan ID. | Elements in the planID array list. |
Elements in the planID array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the plan ID. | String |
description |
String | Additional details about the product ID parameter. | Fetch from the product catalog < |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
action |
Array | Information about the action. | Elements in the action array list. |
Elements in the action array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the action. | String |
description |
String | Additional information about the action. | create |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
quantity |
Array | Information about the quantity. | Elements in the quantity array list. |
Elements in the quantity array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the quantity. | Integer |
description |
String | Additional information about the quantity. | Provide required license quantity. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
vendor |
Array | Information about the vendor. | Elements in the vendor array list. |
Elements in the vendor array list*
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of vendor. | String |
description |
String | Additional information about the vendor. | Vendor name of the product, example:microsoft |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
providerName |
Array | Information about the provider. | Elements in the providerName array list. |
Elements in the providerName array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the provider name. | Sample provider name |
description |
String | Additional details about provider name. | Provide product category as a provider |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
endCustomerPO |
Array | Information about end customer purchase order. | Elements in the endCustomerPO array. |
Elements in the endCustomerPO array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the end customer PO. | String |
description |
String | Additional information about the end customer PO. | User-defined End customer purchase order reference. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
resellerPO |
Array | Information about end reseller purchase order. | Elements in the resellerPO array. |
Elements in the resellerPO array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the end reseller PO. | String |
description |
String | Additional information about the reseller PO. | User-defined Reseller purchase order reference. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
attributes |
Array | Information about attributes. | Elements in the attributes array. |
Elements in the attributes array list
|type|String|Data type of attributes.|Array|
|description|String|Additional information about the attributes.|Product specific attributes are represented as name value pair|
|items|Array|Details about the items in the attributes list.|Elements in the items array.|
Elements in the items array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
ref |
String | Provisioning reference for the attributes of the order items. | #/$defs/attributes |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
attributes |
Array of objects | Information about the attributes. | Elements in the attributes object list. |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Type of the attributes. | object |
description |
String | Additional information about the attributes. | Product specific attributes are represented as name value pair. To purchase Azure RI, Microsoft Azure Plan subscription is manadatory. |
required |
Array | Information about the required attributes. | Elements in the required array list. |
Elements in the required array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
properties |
Array of objects | Information about the attribute properties. It includes information about the name-value pair. | Elements in the properties object list. |
Elements in the properties object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
Array | Information about the name properties of the attributes section. | Elements in the namearray list. |
Elements in the name array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the attributes. | String |
enum |
Array | List of the attributes. | Elements in the enum array list. |
Elements in the enum array list
| Attribute | Data Type | Description | Example |
|---|---|---|---|
domainName |
String | The unique domain name. | Alphanumeric |
agreementDateAgreed |
String | The agreement date in YYYY-MM-DD format. | 2024-01-01 |
agreementUserId |
String | The agreement user ID. | Alphanumeric |
agreementEmail |
String | The email ID associated with the agreement. | testemail@test.com |
agreementFirstName |
String | The first name associated with the agreement. | Test |
agreementLastName |
String | The last name associated with the agreement. | Customer |
agreementPhoneNumber |
String | The phone number associated with the agreement. | Numeric Value |
customTermEndDate |
String | The custom date when the agreement will end in YYYY-MM-DD format. | 2024-02-29 |
skuId |
String | The SKU (Stock Keeping Unit) ID. | Office-365 |
productId |
String | The product ID. | OFFICE365NCE--sample |
| Attribute | Data Type | Description | Example |
|---|---|---|---|
value |
Array | Information about the values of the attributes. | Elements in the value array list. |
Elements in the value array list
| Attribute | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the value of the attribute. | String |
description |
String | Additional information about the value of the attributes. | Required value for the above key. The values for - region, category, skuId(eg. 008), productId(eg. DZH318Z0CXT1) can be fetched from v3 inventory APIs and billingFrequency=monthly upfront. All other keys can reflect the same values given for Microsoft Azure Plan purchase. |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Get Provisioning Info By Template Id
The Provisioning API provides comprehensive information required for provisioning subscriptions. This includes details for creating and updating operations for Google, Microsoft, and IBM products and services. The response from this API provides all the necessary fields and information for seamless provisioning of various cloud products and services.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/provisionTemplates/{templateId}
Sample Request:
curl --location --globoff 'https://ion.tdsynnex.com/api/v3/accounts/1234/provisionTemplates/provisiontemplate33' \
--header 'Authorization: Bearer OTCWZWE3ZWQTMZA0NC0ZMDM3LTG5ZTCTMJU0NTGZOGY3ODGY'
Request Parameter Description:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | The unique account ID. | 1234 | Yes |
templateId |
String | The unique provision template ID. Additional details about the template IDs can be found in the Template ID reference table. | provisiontemplate01 | Yes |
Template ID reference table:
| Template ID | Corresponding Action |
|---|---|
| provisiontemplate01 | Google Workspace Create Order |
| provisiontemplate02 | Google Cloud Platform Create |
| provisiontemplate03 | Google Upgrade/Downgrade Subscription |
| provisiontemplate04 | Google Manage Entitlement |
| provisiontemplate05 | Manage Renewal Settings |
| provisiontemplate06 | Google Suspend |
| provisiontemplate07 | Google Activate |
| provisiontemplate10 | IBM Create Order |
| provisiontemplate11 | IBM Upgrade & Buymore subscription |
| provisiontemplate12 | IBM Enable/Disable Auto Renew |
| provisiontemplate13 | IBM Reactivate expired subscription |
| provisiontemplate30 | Microsoft create |
| provisiontemplate33 | Microsoft Modify & Manage Subscription |
| provisiontemplate34 | Microsoft Change Subscription plan |
| provisiontemplate35 | Microsoft Users & License(Add user) |
| provisiontemplate36 | Microsoft Users & License Update |
| provisiontemplate37 | Microsoft Users & License(Role Change) |
| provisiontemplate38 | Microsoft Add New Subscription |
| provisiontemplate40 | Sophos create |
| provisiontemplate41 | Sophos Manage Accounts |
| provisiontemplate42 | Sophos Manage Products |
| provisiontemplate43 | Google Workspace Transfer Order |
| provisiontemplate53 | Microsoft Modify Subscription |
| provisiontemplate54 | Microsoft Change Subscription |
| provisiontemplate55 | Microsoft Manage Renewal Settings |
| provisiontemplate56 | Microsoft Cancel |
| provisiontemplate57 | Microsoft Pause |
| provisiontemplate58 | Microsoft Resume |
| provisiontemplate60 | McAfee create |
| provisiontemplate61 | McAfee Manage Products |
| provisiontemplate62 | ITG Create |
| provisiontemplate63 | ITG Update |
| provisiontemplate67 | Itgenius Modify Subscription |
Sample Response:
{
"provisioningReference": {
"id": "provisiontemplate01",
"schema": "https://json-schema.org/draft/1234-12/schema",
"title": "Google Workspace Create Order",
"description": "This document records the payload of Google Workspace create order New Account Flow",
"type": "object",
"properties": {
"referenceId": {
"type": "string",
"description": "User-defined reference Id of the order"
},
"displayName": {
"type": "string",
"description": "User-defined name of the order"
},
"orderItems": {
"type": "array",
"items": {
"ref": "#/$defs/orderItems"
}
}
},
"defs": {
"orderItems": {
"type": "object",
"description": "OrderItem details required for placing create order",
"required": [
"productId",
"skuId",
"planId",
"action",
"quantity",
"attributes"
],
"properties": {
"referenceId": {
"type": "string",
"description": "User-defined reference Id of the order item"
},
"productId": {
"type": "string",
"description": "User-defined reference Id of the order item"
},
"skuId": {
"type": "string",
"description": "Fetch from the product catalog <<product.sku.id>>"
},
"planId": {
"type": "string",
"description": "Fetch from the product catalog <<product.plan.id>>"
},
"action": {
"type": "string",
"description": "create"
},
"quantity": {
"type": "integer",
"description": "Provide required license quantity"
},
"vendor": {
"type": "string",
"description": "Vendor name of the product: google"
},
"providerName": {
"type": "string",
"description": "Provide product category as a provider"
},
"endCustomerPO": {
"type": "string",
"description": "User defined End customer purchase order reference"
},
"resellerPO": {
"type": "string",
"description": "User defined Reseller purchase order reference"
},
"attributes": {
"type": "array",
"description": "Product specific attributes are represented as name value pair",
"items": {
"ref": "#/$defs/attributes"
}
}
}
},
"attributes": {
"type": "object",
"description": "Product specific attributes are represented as name value pair",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"enum": [
"alternateEmail",
"customerDomain",
"userName",
"billingAccount"
]
},
"value": {
"type": "string",
"description": "Required value for the above key"
}
}
}
}
}
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | The unique provisioned template ID. | provisioningtemplate12 |
schema |
String | The schema represents the source of the provisioned data. | https://json-schema.org/draft/1234-12/schema |
title |
String | Title of the provisioned data request. | Microsoft create |
description |
String | Added details about the provisioned template. | This document records the payload of Microsoft create order. |
type |
String | Provides the type of provisioning. | Object |
properties |
Array of objects | Object list that specifies the properties of the provisioned template. | The elements in the properties array list. |
Elements in the properties object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
referenceId |
Array of objects | Object list that specifies the details of the reference ID. | The elements in the referenceId array list. |
Elements in the referenceId object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | The type of reference ID. | string |
description |
String | Additional information about the reference ID. | User-defined reference ID of the order. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
Array of objects | Object list that specifies the details of the display name. | The elements in the displayName array list. |
Elements in the displayName object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | The type of display name. | String |
description |
String | Additional information about the display name. | User-defined name of the order |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
orderItems |
Array of objects | Object list that specifies the details of the order items. | The elements in the orderItems array list. |
Elements in the orderItems object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
Array | The type of order items. | Array of objects |
items |
String | Additional details about the order items. | Elements in the #/$defs/orderItems array. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
defs |
Array of objects | Information about the order items. | The elements in the defs array list. |
Elements in the defs object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
orderItems |
Array of objects | Additional details about the order items. | Elements in the orderItems object list. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | The type of order items. | object |
description |
String | Additional information about the order items. | Order Item details required for placing create order. |
required |
Array | Array of mandatory parameters for placing an order. | Elements in the required array. |
Elements in the required array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
productId |
String | The product ID. | OFFICE365NCE--smpnce |
skuId |
String | The Stock Keeping Unit (SKU) ID. | Office-365-E1-n1 |
planId |
String | The plan ID. | Monthly-n23 |
action |
String | Specifies the CREATE action. | CREATE |
quantity |
Integer | The SKU quantity. | 3 |
vendor |
String | Name of the vendor, such as,
|
MICROSOFT |
providerName |
String | The name of the provider. | AZURE |
attributes |
Array | Array list that specifies additional details of the reseller. | domainName,agreementDateAgreed |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
properties |
Array of objects | Additional information about the required properties of the order items. | Elements in the properties object list. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
referenceId |
Array | Information about order item reference ID. | Elements in the referenceID array list. |
Elements in the referenceID array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of reference ID. | |
description |
String | User-defined reference Id of the order item. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
productId |
Array | Information about the product ID. | Elements in the productID array list. |
Elements in the productID array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the product ID. | String |
description |
String | Additional details about the product ID parameter. | Fetch from the product catalog < |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
skuId |
Array | Information about the SKU ID. | Elements in the skuId array list. |
Elements in the skuID array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the SKU ID. | String |
description |
String | Additional details about the SKU ID parameter. | Fetch from the product catalog < |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
planId |
Array | Information about the plan ID. | Elements in the planID array list. |
Elements in the planID array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the plan ID. | String |
description |
String | Additional details about the product ID parameter. | Fetch from the product catalog < |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
action |
Array | Information about the action. | Elements in the action array list. |
Elements in the action array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the action. | String |
description |
String | Additional information about the action. | create |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
quantity |
Array | Information about the quantity. | Elements in the quantity array list. |
Elements in the quantity array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the quantity. | Integer |
description |
String | Additional information about the quantity. | Provide required license quantity. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
vendor |
Array | Information about the vendor. | Elements in the vendor array list. |
Elements in the vendor array list*
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of vendor. | String |
description |
String | Additional information about the vendor. | Vendor name of the product, example:microsoft |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
providerName |
Array | Information about the provider. | Elements in the providerName array list. |
Elements in the providerName array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the provider name. | Sample provider name |
description |
String | Additional details about provider name. | Provide product category as a provider |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
endCustomerPO |
Array | Information about end customer purchase order. | Elements in the endCustomerPO array. |
Elements in the endCustomerPO array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the end customer PO. | String |
description |
String | Additional information about the end customer PO. | User-defined End customer purchase order reference. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
resellerPO |
Array | Information about end reseller purchase order. | Elements in the resellerPO array. |
Elements in the resellerPO array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the end reseller PO. | String |
description |
String | Additional information about the reseller PO. | User-defined Reseller purchase order reference. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
attributes |
Array | Information about attributes. | Elements in the attributes array. |
Elements in the attributes array list
|type|String|Data type of attributes.|Array|
|description|String|Additional information about the attributes.|Product specific attributes are represented as name value pair|
|items|Array|Details about the items in the attributes list.|Elements in the items array.|
Elements in the items array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
ref |
String | Provisioning reference for the attributes of the order items. | #/$defs/attributes |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
attributes |
Array of objects | Information about the attributes. | Elements in the attributes object list. |
Elements in the attributes array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Type of the attributes. | object |
description |
String | Additional information about the attributes. | Product specific attributes are represented as name value pair. To purchase Azure RI, Microsoft Azure Plan subscription is manadatory. |
required |
Array | Information about the required attributes. | Elements in the required array list. |
Elements in the required array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | domainName,agreementDateAgreed |
value |
String | The value of the attribute. | The value of the attribute mentioned in the name field. |
| Parameter | Data Type | Description | Example |
|---|---|---|---|
properties |
Array of objects | Information about the attribute properties. It includes information about the name-value pair. | Elements in the properties object list. |
Elements in the properties object list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
Array | Information about the name properties of the attributes section. | Elements in the namearray list. |
Elements in the name array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the attributes. | String |
enum |
Array | List of the attributes. | Elements in the enum array list. |
Elements in the enum array list
| Attribute | Data Type | Description | Example |
|---|---|---|---|
domainName |
String | The unique domain name. | Alphanumeric |
agreementDateAgreed |
String | The agreement date in YYYY-MM-DD format. | 2024-01-01 |
agreementUserId |
String | The agreement user ID. | Alphanumeric |
agreementEmail |
String | The email ID associated with the agreement. | testemail@test.com |
agreementFirstName |
String | The first name associated with the agreement. | Test |
agreementLastName |
String | The last name associated with the agreement. | Customer |
agreementPhoneNumber |
String | The phone number associated with the agreement. | Numeric Value |
customTermEndDate |
String | The custom date when the agreement will end in YYYY-MM-DD format. | 2024-02-29 |
skuId |
String | The SKU (Stock Keeping Unit) ID. | Office-365 |
productId |
String | The product ID. | OFFICE365NCE--sample |
| Attribute | Data Type | Description | Example |
|---|---|---|---|
value |
Array | Information about the values of the attributes. | Elements in the value array list. |
Elements in the value array list
| Attribute | Data Type | Description | Example |
|---|---|---|---|
type |
String | Data type of the value of the attribute. | String |
description |
String | Additional information about the value of the attributes. | Required value for the above key. The values for - region, category, skuId(eg. 008), productId(eg. DZH318Z0CXT1) can be fetched from v3 inventory APIs and billingFrequency=monthly upfront. All other keys can reflect the same values given for Microsoft Azure Plan purchase. |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | User does not have access to this resource. |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:PermissionDeniedError
{
"error": "PERMISSION_DENIED",
"message": "permission denied to access accounts/12345",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 403 - Permission Denied Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | PERMISSION_DENIED |
message |
String | Error description | permission denied to access accounts/12345 |
code |
String | Error code | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "123abcd5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Server Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title | INTERNAL_ERROR |
message |
String | Error description | Internal Server Error |
code |
String | Error code | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Cart
The Cart endpoints of StreamOne® Ion API allow you to:
List Cart
The List Cart endpoint provides a list of carts associated with the specified customer. You can filter the response by limit, offset, sortOrder, and so on.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts
Sample Request:
curl --request GET \
--url 'https://ion.tdsynnex.com/api/v3/customers/%7BcustomerId%7D/carts?pagination=SOME_UNKNOWN_VALUE&status=SOME_STRING_VALUE'
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | 1234 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
pagination |
Array List | Array list that specifies pagination parameters. | The elements in pagination array list. |
Yes |
status |
String | The status of the cart. | Values such as:
|
Yes |
Elements in the pagination array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
limit |
Integer | Specifies the size of data sets returned by the API, ensuring performance and usability. | pagination.limit=10 | Yes |
offset |
Integer | Determines the number of items that should be skipped from the beginning of the dataset before returning results. | pagination.limit=10 &pagination.offset=20 | No |
filter |
String | Retrieves precise and relevant data. | pagination.filter=cartDisplayName | No |
sortBy |
String | Sorts the data according to one or more attribute names that specify the order in of data. | pagination.paymentType | No |
sortOrder |
String | Specifies the order of sorting. | Values such as:
|
Yes |
userId |
Integer | A unique identifier assigned to individual users within a cart. | 1234 | No |
Sample Response
{
"carts": [
{
"name": "1234",
"cartDisplayName": "Cart - 1234",
"userName": "John",
"payment": {
"paymentType": "PAYMENT_TYPE_UNSPECIFIED",
"creditCardName": "JD"
},
"status": "CART_STATUS_UNSPECIFIED",
"currencyCode": "USD",
"totalItems": 0
}
]
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
carts |
Array list | Array list that specifies cart details. | The elements in cart array list. |
Elements in the cart array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Specifies name of the cart. | 12345 |
cartdisplayName |
String | Specifies the display name of the cart. | Cart - 1234 |
userName |
String | Specifies the user associated with the cart. | smpreseller |
payment |
Object | The array list that specifies the payment details. | The elements in the payment array list. |
status |
String | Specifies the status of the cart. | Values such as:
|
currencyCode |
String | Specifies the currency code. | Values such as USD, EUR, and so on. |
totalItems |
Integer | Specifies the number of items in the cart. | 2 |
Elements in the payment array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
creditCardName |
String | Specifies the name of the credit card. | 1234 |
Get Cart
The Get Cart endpoint retrieves details of a specific cart according to the associated customer ID and cart ID.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts/{cartId}
Sample Request:
curl --request GET \
--url https://ion.tdsynnex.com/api/v3/customers/%7BcustomerId%7D/carts/%7BcartId%7D
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | 1234 | Yes |
cartId |
Integer | Cart ID. | 1234 | Yes |
Sample Response
{
"carts": [
{
"name": "1234",
"cartDisplayName": "Cart - 1234",
"userName": "John",
"payment": {
"paymentType": "PAYMENT_TYPE_UNSPECIFIED",
"creditCardName": "JD"
},
"status": "CART_STATUS_UNSPECIFIED",
"currencyCode": "USD",
"totalItems": 0
}
]
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Specifies name of the cart. | 12345 |
cartdisplayName |
String | Specifies the display name of the cart. | Cart - 1234 |
userName |
String | Specifies the user associated with the cart. | smpreseller |
payment |
Object | The array list that specifies the payment details. | The elements in the payment array list. |
status |
String | Specifies the status of the cart. | Values such as:
|
currencyCode |
String | Specifies the currency code. | Values such as USD, EUR, and so on. |
totalItems |
Integer | Specifies the number of items in the cart. | 2 |
Elements in the payment array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
creditCardName |
String | Specifies the name of the credit card. | 1234 |
Create Cart
The Create Cart endpoint creates a new cart for a specified customer.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts
Sample Request:
{
"cartDisplayName": "Cart - 1234",
"userName": "John",
"payment": {
"paymentType": "PAYMENT_TYPE_UNSPECIFIED",
"creditCardName": "JD"
},
"status": "CART_STATUS_UNSPECIFIED",
"currencyCode": "USD"
}
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | 1234 | Yes |
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
cartdisplayName |
String | Specifies the display name of the cart. | Cart - 1234 | No |
userName |
String | Specifies the user associated with the cart. | smpreseller | No |
payment |
Array list | The array list that specifies the payment details. | The elements in the payment array list. | No |
status |
String | Specifies the status of the cart. | Values such as:
|
No |
currencyCode |
String | Specifies the currency code. | Values such as USD, EUR, and so on. | No |
Elements in the payment array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
No |
creditCardName |
String | Specifies the name of the credit card. | 1234 | No |
Sample Response
{
"name": "1234",
"cartDisplayName": "Cart - 1234",
"userName": "John",
"payment": {
"paymentType": "PAYMENT_TYPE_UNSPECIFIED",
"creditCardName": "JD"
},
"status": "CART_STATUS_UNSPECIFIED",
"currencyCode": "USD",
"totalItems": 0
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Specifies name of the cart. | 12345 |
cartdisplayName |
String | Specifies the display name of the cart. | Cart - 1234 |
userName |
String | Specifies the user associated with the cart. | smpreseller |
payment |
Array list | The array list that specifies the payment details. | The elements in the payment array list. |
status |
String | Specifies the status of the cart. | Values such as:
|
currencyCode |
String | Specifies the currency code. | Values such as USD, EUR, and so on. |
totalItems |
Integer | Specifies the number of items in the cart. | 2 |
Elements in the payment array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
creditCardName |
String | Specifies the name of the credit card. | 1234 |
Update Cart
The Update Cart endpoint updates an existing cart.
HTTP Endpoint URL: PUT https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts/{cartId}
Sample Request:
{
"cartDisplayName": "Cart - 1234",
"userName": "John",
"payment": {
"paymentType": "PAYMENT_TYPE_UNSPECIFIED",
"creditCardName": "JD"
},
"status": "CART_STATUS_UNSPECIFIED",
"currencyCode": "USD"
}
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | 1234 | Yes |
cartId |
Integer | Cart ID. | 1234 | Yes |
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
cartdisplayName |
String | Specifies the display name of the cart. | Cart - 1234 | No |
userName |
String | Specifies the user associated with the cart. | smpreseller | No |
payment |
Object | The array list that specifies the payment details. | The elements in the payment array list. | No |
status |
String | Specifies the status of the cart. | Values such as:
|
No |
currencyCode |
String | Specifies the currency code. | Values such as USD, EUR, and so on. | No |
Elements in the payment array list
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
No |
creditCardName |
String | Specifies the name of the credit card. | JD | No |
Sample Response
{
"name": "1234",
"cartDisplayName": "Cart - 1234",
"userName": "John",
"payment": {
"paymentType": "PAYMENT_TYPE_UNSPECIFIED",
"creditCardName": "JD"
},
"status": "CART_STATUS_UNSPECIFIED",
"currencyCode": "USD",
"totalItems": 0
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Specifies name of the cart. | 12345 |
cartdisplayName |
String | Specifies the display name of the cart. | Cart - 1234 |
userName |
String | Specifies the user associated with the cart. | smpreseller |
payment |
Object | The array list that specifies the payment details. | The elements in the payment array list. |
status |
String | Specifies the status of the cart. | Values such as:
|
currencyCode |
String | Specifies the currency code. | Values such as USD, EUR, and so on. |
totalItems |
Integer | Specifies the number of items in the cart. | 2 |
Elements in the payment array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
creditCardName |
String | Specifies the name of the credit card. | JD |
Checkout Cart
The Checkout Cart endpoint starts a starts a cart’s purchase process.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts/{cartId}:checkout
Sample Request:
{
"totalCalculatedValue": 504.00,
"provisionData": [
{
"cartItemId": 162189,
"attributes": [
{
"name": "domainName",
"value": "SIEQAMRAPI568525Carts06"
},
{
"name": "agreementDateAgreed",
"value": "2023-11-08"
},
{
"name": "agreementUserId",
"value": "13789"
},
{
"name": "agreementEmail",
"value": "mrapicart8064656@gmail.com"
},
{
"name": "agreementFirstName",
"value": "MR"
},
{
"name": "agreementLastName",
"value": "RM"
},
{
"name": "agreementPhoneNumber",
"value": "9754321086"
},
{
"name": "companyRegistrationId",
"value": "1A4776"
},
{
"name": "customTermEndDate",
"value": "2023-11-30"
}
]
}
]
}
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | 1234 | Yes |
cartId |
String | The cart ID. | 1234 | Yes |
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
totalcalculatedValue |
Float | Specifies the final value of the cart including all the discounts. | 504.00 | Yes |
provisionData |
Array | Includes the provisioning attributes required for product activation after checkout. | The elements in provisionData array. |
Yes |
Elements in the provisionData array
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
cartItemId |
String | The cart item ID. | 12345 | Yes |
attributes |
Array | Specifies the additional details of the cart items. | The elements in attributes array. |
Yes |
Elements in the attributes array
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
name |
String | The name of the attribute. | agreementDateAgreed | Yes |
value |
String | The value of the attribute. | 2023-11-08 | Yes |
Sample Response
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}",
"referenceId": "customers/{customer_id}/carts/{cart_id}",
"displayName": "Cart - Test-001",
"userId": "3335",
"userName": "Account Admin",
"userEmail": "accountadmin@sample.com",
"status": "NEW",
"currencyCode": "USD",
"total": 10,
"cartId": "13xx4",
"orderItems": [
{
"name": "accounts/{account_id}/customers/{customer_id}/orders/{order_id}/orderItems/{orderItem_id}",
"referenceId": "customers/{customer_id}/cartItems/{cartItem_id}",
"action": "CREATE",
"productId": "IBMCognos",
"skuId": "IBM-Cognos-Analytics-on-Cloud-n4",
"planId": "Analytics-on-Cloud-1-Month-Upfro",
"quantity": 1,
"providerName": "IBM",
"currencyCode": "USD",
"subTotal": 10,
"addOns": [
{
"id": "IBM-Cognos-Analytics-on-Cloud-n1",
"planId": "IBM-Cognos-Analytics-on-Cloud-n1",
"displayName": "IBM Cognos Analytics on Cloud Standard",
"quantity": 1,
"price": 10,
"cost": 10,
"currencyCode": "USD",
"catalogAttributes": [
{
"name": "addon.ExternalId",
"value": "D20ENLL"
},
{
"name": "addon.plan.ExternalId",
"value": "EID2RPAX-D20ENLL-1-U,0"
}
],
"action": "CREATE"
}
],
"catalogAttributes": [
{
"name": "productCategories",
"value": "IBM"
},
{
"name": "productCloudProviderName",
"value": "accounts/10001/cloudProviders/12"
},
{
"name": "sku.Name",
"value": "IBM-Cognos-Analytics-on-Cloud-n4"
},
{
"name": "sku.DisplayName",
"value": "IBM Cognos Analytics on Cloud"
},
{
"name": "sku.ExternalId",
"value": "EID2RPAX"
},
{
"name": "sku.Verticals",
"value": "accounts/10001/verticals/Analytics-on-Cloud"
},
{
"name": "plan.Name",
"value": "Analytics-on-Cloud-1-Month-Upfro"
},
{
"name": "plan.DisplayName",
"value": "Analytics on Cloud 1 Month (Upfront) "
},
{
"name": "plan.ExternalId",
"value": "EID2RPAX-D2302LL-1-U,0"
},
{
"name": "plan.BillingPeriod",
"value": "monthly"
},
{
"name": "plan.ApprovalRequired",
"value": "false"
},
{
"name": "plan.DurationUnit",
"value": "month"
},
{
"name": "plan.DurationCount",
"value": "1"
},
{
"name": "plan.DurationType",
"value": "fixed"
},
{
"name": "customField.ProductId",
"value": "7627f2ad502ad84e75188ecce0a698bb"
},
{
"name": "customField.ProductSpecTemplate",
"value": "ibmproducts"
},
{
"name": "customField.IBMProductType",
"value": "Cognos"
},
{
"name": "customField.disable-v2c",
"value": "true"
},
{
"name": "customField.use-simulator-service",
"value": "true"
},
{
"name": "product.ownerAccountId",
"value": "10001"
},
{
"name": "credentialsName",
"value": "accounts/10001/providerCredentials/49"
}
],
"cartItemId": "19058",
"status": "NEW",
"createTime": "2023-10-05T19:19:41Z",
"updateTime": "2023-10-05T19:19:41Z"
}
],
"provisioningInfo": {
"processId": "b9bf8aea-bb82-425b-9620-cda180eb919d",
"processName": "Order_V3"
},
"createTime": "2023-10-05T19:19:41Z",
"updateTime": "2023-10-05T19:19:41Z"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Specifies name of the cart. | accounts/10259/customers/11782/orders/1868 |
referenceId |
String | A unique reference ID defined in the request. | customers/11782/carts/13714 |
displayName |
String | The display name of the cart. | Cart - Test-001 |
userId |
String | The user ID. | 1234. |
userName |
String | Specifies the user associated with the cart. | Account Admin |
userEmail |
String | Specifies the email address of the user. | accountadmin@sample.com |
status |
String | Specifies the status of the cart. | NEW |
currencyCode |
String | The currency code. | USD |
total |
Integer | Specifies the number of items in the cart. | 10 |
cartId |
Integer | Cart ID. | 12345 |
orderItems |
Array | Array list that specifies the details of the order items. | The elements in orderItems array. |
provisioningInfo |
Object | This array provides the provisioning information about the order items. | The elements in provisioningInfoobject. |
createTime |
String | The time when the cart is created in YYYY-MM-DD HH:Min format. | 2023-10-05T19:19:41Z |
updateTime |
String | The time when the cart is updated in YYYY-MM-DD HH:Min format. | 2023-10-05T19:19:41Z |
Elements in the orderItems array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | Specifies name of the cart. | accounts/10259/customers/11782/orders/1868/orderItems/1864 |
referenceId |
String | A unique reference ID defined in the request. | customers/11782/cartItems/19058 |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE |
productId |
String | The product ID. | IBMCognos |
skuId |
String | The SKU ID. | IBM-Cognos-Analytics-on-Cloud-n4 |
planId |
String | The plan ID. | Analytics-on-Cloud-1-Month-Upfro |
quantity |
Integer | Specifies the number of items in the cart. | 1 |
providerName |
String | The name of the provider. | IBM |
currencyCode |
String | The currency code. | USD |
subTotal |
Integer | Specifies the number of items in the cart. | 10 |
addOns |
Array | Includes a collection of optional products or services that can be linked to a cart. | The elementsin addOns array. |
catalogAttributes |
Array | Array list that specifies the product-specific attributes such as product category, cloud provider name, plan name and so on that are provided as Name - Value pair. | The elements in catalogAttributes array |
cartItemId |
String | The cart item ID. | 19058 |
status |
String | Specifies the status of the cart. | NEW |
createTime |
String | The time when the cart item is created in YYYY-MM-DD HH:Min format. | 2023-10-05T19:19:41Z |
updateTime |
String | The time when the cart item is updated in YYYY-MM-DD HH:Min format. | 2023-10-05T19:19:41Z |
Elements in addOns array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | Name of the cart item. | IBM-Cognos-Analytics-on-Cloud-n1 |
planId |
String | The plan ID. | IBM-Cognos-Analytics-on-Cloud-n1 |
displayName |
String | The display name of the cart item. | IBM Cognos Analytics on Cloud Standard |
quantity |
Integer | Specifies the number of items in the cart. | 2 |
price |
Integer | Specifies the cost of a cart item. | 10 |
cost |
Integer | Specifies the cost of items in the cart. | 10 |
currencyCode |
String | The currency code. | USD |
catalogAttributes |
Array | Array list that specifies the product-specific attributes such as product category, cloud provider name, plan name and so on that are provided as Name - Value pair. | The elements in catalogAttributes array. |
action |
String | The action to be performed such as CREATE, UPDATE and so on. | CREATE |
Elements in catalogAttributes array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | The name of the attribute. | productCategories |
value |
String | The value of the attribute. | IBM |
Elements in provisioningInfo array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
processId |
String | The unique process ID of the order. | alphanumeric |
processName |
String | The name of the process that helps in troubleshooting issues related to the order process. This parameter cannot be set in the request. | Order_V3 |
Cart Items
The Cart Items endpoints of StreamOne® Ion API allow you to:
List Cart Items
The List Cart Items endpoint provides a list of cart items associated with the specified customer.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts/{cartId}/cartItems
Sample Request:
curl --request GET \
--url https://ion.tdsynnex.com/api/v3/customers/%7BcustomerId%7D/carts/%7BcartId%7D/cartItems
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | Numeric | Yes |
cartId |
Integer | Cart ID. | Numeric | Yes |
Sample Response
{
"cartitems": [
{
"name": "customers/{customer_id}/cartItems/{cartItem_id}",
"cartName": "customers/{customer_id}/carts/{cart_id}",
"userName": "customers/{customer_id}/users/{user_id}",
"title": "Microsoft 365 NCE - Microsoft 365 E5",
"planName": "accounts/{account_id}/products/Microsoft365EandFNCE--smpnce/versions/725/plans/Annual-n108",
"period": "YEAR",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": 1,
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 9
},
"currencyCode": "USD",
"paymentSpec": {
"offlineAllowed": true,
"immutable": true
},
"termUid": "168d692db6b39025701a",
"checkedOut": "FAILED",
"ownerId": "194080",
"productType": "PRODUCT",
"skuId": "USxxx7TTxxxFLZ0002",
"productExternalId": "US,CFQ7TTC0LFLZ,0002,One-year term duration",
"priceModificationDetails": {
"masterPrice": 684,
"priceBeforePromoAndAdjustment": 861.84002685546875,
"recurringTotalAfterPromotion": 622.67945433445129,
"recurringTotalBeforeAdjustment": 622.67945433445129,
"firstBillingChargeBefore": 622.67945433445129,
"firstBillingChargeAfter": 622.67945433445129,
"totalBeforePromotion": 861.84002685546875,
"totalAfterPromotion": 622.67945433445129,
"termPriceBefore": 861.84002685546875,
"termPriceAfterAdjustment": 622.67945433445129,
"pricebookCost": 820.79998779296875,
"accountCost": 593.02802444839472,
"recurringTotalPricebookCost": 820.79998779296875,
"recurringTotalAccountcost": 593.02802444839472,
"totalPricebookCost": 820.79998779296875,
"totalAccountCost": 593.02802444839472,
"margin": 4.7619091459745366,
"appliedPromotions": [
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
},
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
}
],
"availablePromotions": [
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
},
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
}
]
},
"promotionExternalId": "39NFJQT280NS:000D:084R5MQ9QF2R",
"isEligibleForPromo": "AVAILABLE",
"termDuration": "year",
"termDurationCount": 1,
"productDisplayName": "Microsoft 365 NCE",
"planDisplayName": "Microsoft 365 E5"
},
{
"name": "customers/{customer_id}/cartItems/{cartItem_id}",
"cartName": "customers/{customer_id}/carts/{cart_id}",
"userName": "customers/{customer_id}/users/{user_id}",
"title": "Office 365 NCE - Office 365 E1",
"planName": "accounts/{account_id}/products/OFFICE365NCE--smpnce/versions/90/plans/Annual-n21",
"period": "YEAR",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": 1,
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 9
},
"addOns": [
{
"planId": "addon-Annual-n128",
"displayName": "Microsoft Teams Enterprise – Unattended License",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 50.88
}
},
{
"planId": "addon-Annual-n51",
"displayName": "Microsoft Defender for Office 365 F1",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 12.96
}
},
{
"planId": "addon-Annual-n69",
"displayName": "Microsoft Defender for Office 365 (Plan 1) (Non-Profit Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 8.64
}
},
{
"planId": "addon-Annual-n35",
"displayName": "Microsoft 365 Copilot (Non-Profit Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 275.4
}
},
{
"planId": "addon-Annual-n56",
"displayName": "Microsoft Defender for Office 365 (Plan 1) Student use benefit (Education Student Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD"
}
},
{
"planId": "addon-Annual-n41",
"displayName": "Microsoft 365 Copilot",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 324
}
},
{
"planId": "addon-Annual-n63",
"displayName": "Microsoft Defender for Office 365 (Plan 1)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 19.2
}
},
{
"planId": "addon-Annual-n125",
"displayName": "Microsoft Teams Enterprise",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 50.88
}
},
{
"planId": "addon-Annual-n62",
"displayName": "Microsoft Defender for Office 365 (Plan 1) (Governmental Community Cloud Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 19.2
}
},
{
"planId": "addon-Annual-n64",
"displayName": "Microsoft Defender for Office 365 (Plan 1) (Education Student Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 6.72
}
},
{
"planId": "addon-Annual-n71",
"displayName": "Microsoft Defender for Office 365 (Plan 1) (Education Faculty Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 13.44
}
},
{
"planId": "addon-Annual-n43",
"displayName": "Microsoft Copilot for Microsoft 365 A3 and A5 (Education Faculty Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 324
}
},
{
"planId": "addon-Annual-n42",
"displayName": "Microsoft 365 Copilot GCC",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 324
}
},
{
"planId": "addon-Annual-n38",
"displayName": "Copilot for Microsoft 365 (Education Student 18+)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 324
}
}
],
"currencyCode": "USD",
"paymentSpec": {
"offlineAllowed": true,
"immutable": true
},
"termUid": "17d899147a80f5586ef7",
"checkedOut": "FAILED",
"ownerId": "194080",
"productType": "PRODUCT",
"skuId": "USCxxxTTxxxF8Q0001",
"productExternalId": "US,CFQ7TTC0LF8Q,0001,One-year term duration",
"priceModificationDetails": {
"masterPrice": 120,
"priceBeforePromoAndAdjustment": 151.19999694824219,
"recurringTotalAfterPromotion": 151.19999694824219,
"recurringTotalBeforeAdjustment": 151.19999694824219,
"firstBillingChargeBefore": 151.19999694824219,
"firstBillingChargeAfter": 151.19999694824219,
"totalBeforePromotion": 151.19999694824219,
"totalAfterPromotion": 151.19999694824219,
"termPriceBefore": 151.19999694824219,
"termPriceAfterAdjustment": 151.19999694824219,
"pricebookCost": 144,
"accountCost": 144,
"recurringTotalPricebookCost": 144,
"recurringTotalAccountcost": 144,
"totalPricebookCost": 144,
"totalAccountCost": 144,
"margin": 4.7619028396586831
},
"termDuration": "year",
"termDurationCount": 1,
"productDisplayName": "Office 365 NCE",
"planDisplayName": "Office 365 E1"
},
{
"name": "customers/{customer_id}/cartItems/{cartItem_id}",
"cartName": "customers/{customer_id}/carts/{cart_id}",
"userName": "customers/{customer_id}/users/{user_id}",
"title": "BizTalk Server - BizTalk Server 2020 Branch - Commercial",
"planName": "accounts/{account_id}/products/BizTalkServerStandard-smp/versions/67/plans/BizTalk-Server-2020-Branch-n0",
"period": "YEAR",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": 1,
"upfrontPrice": {
"currency": "USD",
"value": 1
},
"recurringPrice": {
"currency": "USD",
"value": 1
},
"currencyCode": "USD",
"paymentSpec": {
"offlineAllowed": true
},
"termUid": "16c7177e1d9f7e934edb",
"checkedOut": "FAILED",
"ownerId": "205924",
"productType": "PRODUCT",
"skuId": "BizTalk-Server-2020-Branch",
"productExternalId": "US,DG7GMGF0G49Z,0002,Commercial",
"priceModificationDetails": {
"masterPrice": 1264,
"priceBeforePromoAndAdjustment": 1692.1800537109375,
"upfrontPriceAfterPromotion": 1692.1800537109375,
"recurringTotalBeforeAdjustment": 1692.1800537109375,
"firstBillingChargeBefore": 1692.1800537109375,
"firstBillingChargeAfter": 1692.1800537109375,
"totalBeforePromotion": 1692.1800537109375,
"totalAfterPromotion": 1692.1800537109375,
"termPriceBefore": 1692.1800537109375,
"termPriceAfterAdjustment": 1692.1800537109375,
"pricebookCost": 1611.5999755859375,
"accountCost": 1611.5999755859375,
"recurringTotalPricebookCost": 1611.5999755859375,
"recurringTotalAccountcost": 1611.5999755859375,
"totalPricebookCost": 1611.5999755859375,
"totalAccountCost": 1611.5999755859375,
"margin": 4.7619092275841757
},
"termDuration": "year",
"termDurationCount": 1,
"productDisplayName": "BizTalk Server",
"planDisplayName": "BizTalk Server 2020 Branch - Commercial"
},
{
"name": "customers/{customer_id}/cartItems/{cartItem_id}",
"cartName": "customers/{customer_id}/carts/{cart_id}",
"userName": "customers/{customer_id}/users/{user_id}",
"title": "Microsoft 365 NCE - Microsoft 365 E3 (no Teams)",
"planName": "accounts/{account_id}/products/Microsoft365EandFNCE--smpnce/versions/725/plans/Monthly822139",
"period": "MONTH",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": 1,
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 340.68
},
"addOns": [
{
"planId": "addon-Monthly-n84",
"displayName": "Compliance Manager Premium Assessment Add-On",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 5040
}
},
{
"planId": "addon-Monthly-n87",
"displayName": "Compliance Manager Premium Assessment Add-On",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 480
}
},
{
"planId": "addon-Monthly-n78",
"displayName": "Microsoft 365 G5 Compliance (Governmental Community Cloud Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 12.29
}
},
{
"planId": "addon-Monthly-n82",
"displayName": "Microsoft 365 G5 Compliance (Governmental Community Cloud Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 129
}
},
{
"planId": "addon-Monthly-n72",
"displayName": "Compliance Manager Premium Assessment Add-On (Governmental Community Cloud Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 480
}
},
{
"planId": "addon-Monthly-n76",
"displayName": "Compliance Manager Premium Assessment Add-On (Governmental Community Cloud Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 5040
}
},
{
"planId": "addon-Monthly-n129",
"displayName": "Microsoft Teams Enterprise – Unattended License",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 53.4
}
},
{
"planId": "addon-Monthly-n40",
"displayName": "Microsoft 365 Copilot (Non-Profit Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 289.2
}
},
{
"planId": "addon-Monthly-n36",
"displayName": "Microsoft 365 Copilot",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 340.2
}
},
{
"planId": "addon-Monthly-n75",
"displayName": "Microsoft 365 E5 Compliance",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 120.96
}
},
{
"planId": "addon-Monthly-n77",
"displayName": "Microsoft 365 E5 Compliance",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 11.52
}
},
{
"planId": "addon-Monthly-n127",
"displayName": "Microsoft Teams Enterprise",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 5.09
}
},
{
"planId": "addon-Monthly-n130",
"displayName": "Microsoft Teams Enterprise",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 53.4
}
},
{
"planId": "addon-Monthly-n74",
"displayName": "Microsoft 365 E5 Compliance (Non-Profit Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 5.18
}
},
{
"planId": "addon-Monthly-n83",
"displayName": "Microsoft 365 E5 Compliance (Non-Profit Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 54.48
}
},
{
"planId": "addon-Monthly-n73",
"displayName": "Compliance Manager Premium Assessment Add-On (Education Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 5040
}
},
{
"planId": "addon-Monthly-n85",
"displayName": "Compliance Manager Premium Assessment Add-On (Education Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 480
}
},
{
"planId": "addon-Monthly-n44",
"displayName": "Microsoft Copilot for Microsoft 365 A3 and A5 (Education Faculty Pricing)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 340.2
}
},
{
"planId": "addon-Monthly-n37",
"displayName": "Microsoft 365 Copilot GCC",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 340.2
}
},
{
"planId": "addon-Monthly-n39",
"displayName": "Copilot for Microsoft 365 (Education Student 18+)",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 340.2
}
}
],
"currencyCode": "USD",
"paymentSpec": {
"offlineAllowed": true,
"immutable": true
},
"termUid": "168d692db6b39025701a",
"checkedOut": "FAILED",
"ownerId": "194080",
"productType": "PRODUCT",
"skuId": "USCxxxTTCxxxLX0021",
"productExternalId": "US,CFQ7TTC0LFLX,0021,One-Year commitment for monthly/yearly billing",
"priceModificationDetails": {
"masterPrice": 425.8800048828125,
"priceBeforePromoAndAdjustment": 44.714248657226562,
"recurringTotalAfterPromotion": 32.306046467166517,
"recurringTotalBeforeAdjustment": 32.306046467166517,
"firstBillingChargeBefore": 32.306046467166517,
"firstBillingChargeAfter": 32.306046467166517,
"totalBeforePromotion": 536.57098388671875,
"totalAfterPromotion": 387.67255760599824,
"termPriceBefore": 536.57098388671875,
"termPriceAfterAdjustment": 387.67255760599824,
"pricebookCost": 42.584999084472656,
"accountCost": 30.767663564550865,
"recurringTotalPricebookCost": 42.584999084472656,
"recurringTotalAccountcost": 30.767663564550865,
"totalPricebookCost": 511.01998901367188,
"totalAccountCost": 369.21196277461036,
"margin": 4.7619039494020132,
"appliedPromotions": [
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
},
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
}
],
"availablePromotions": [
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
},
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
}
]
},
"isEligibleForPromo": "AVAILABLE",
"termDuration": "month",
"termDurationCount": 12,
"productDisplayName": "Microsoft 365 NCE",
"planDisplayName": "Microsoft 365 E3 (no Teams)"
}
]
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | A unique identifier of the cart item. | customers/{customer_id}/cartItems/{cartItem_id}. |
cartName |
String | A unique identifier of the cart for corresponding cart item. | customers/{customer_id}/carts/{cart_id}. |
userName |
String | The name of the user who uses the subscription. | customers/{customer_id}/users/{user_id}. |
title |
String list | The name of the product. | Microsoft 365 NCE - Microsoft 365 E5. |
planName |
String | The plan name of the subscription. | accounts/{account_id}/products/Microsoft365EandFNCE--smpnce/versions/725/plans/Annual-n108. |
period |
String | Specifies the billing period of the cart item. | Values such as
|
status |
String | Specifies the status of the cart item. | Values such as
|
payment |
Object | Specifies the mode of the payment. | The elements in payment object. |
quantity |
Integer | Specifies the quantity of the cart items. | 1 |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement or checkout. | The elements in upfrontPrice object. |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in recurringPrice object. |
addOns |
Array list | Includes a collection of optional products or services that can be linked to a cart item. | The elements in addOns array list. |
currencyCode |
String | The currency code. | USD. |
paymentSpec |
Object | Specifies the payment rules for cart items. | The elements in paymentSpec object. |
termUid |
String | A unique identifier for the subscription term. | System generated value. |
checkedOut |
String | Specifies whether the cart item is successfully checked out. | Values such as
|
ownerId |
String | A unique identifier for the customer or reseller who owns the cart item. | 194080. |
productType |
String | Specifies the type of product. | Values such as
|
skuId |
String | The SKU ID. | USCFQ7TTC0LFLZ0002. |
productExternalId |
String | External ID for the product. | US,CFQ7TTC0LFLZ,0002,One-year term duration. |
priceModificationDetails |
Object | Specifies detailed pricing information of the cart items. | The elements in priceModificationDetails object. |
promotionExternalId |
String | External ID of the promotional discount. | 39NFJQT280NS:000D:084R5MQ9QF2R. |
isEligibleForPromo |
String | Specifies whether the cart item is eligible for promotional discount. | AVAILABLE. |
termDuration |
String | Specifies the duration of subscription term. | year. |
termDurationCount |
Integer | Describes the value of the element in termDuration. |
1 |
productDisplayName |
String | The display name of the product. | Microsoft 365 NCE. |
planDisplayName |
String | The display name of the plan to be purchased. | Microsoft 365 E5. |
Elements in the payment object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
Elements in the upfrontPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
String | Specifies the recurring price. | 9 |
Elements in the addOns array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
planId |
String | Specifies the plan ID. | addon-Annual-n128 |
displaName |
String | The display name of the plan. | Microsoft Teams Enterprise – Unattended License |
quantitySpec |
Object | Specifies the quantity of the cart items. | The elements in the quantitySpec object |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement or checkout. | The elements in the upfrontPrice object |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in the recurringPrice object |
Elements in the quantitySpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
minQuantity |
Integer | Specifies the minimum quantity of the cart items to be purchased. | 1 |
maxQuantity |
Integer | Specifies the maximum quantity of the cart items to be purchased. | 2 |
Elements in the upfrontPrice - addOns object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice - addOns object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
Float | Specifies the recurring price. | 50.88 |
Elements in the paymentSpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
offlineAllowed |
Boolean | Specifies whether the offline payment is allowed for the corresponding cart item. | True |
immutable |
Boolean | Specifies whether the payment method can be modified. | Values such as
|
Elements in the priceModificationDetails object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
masterPrice |
Double | Specifies the original cost of the cart item before any adjustment. | 120 |
priceBeforePromoAndAdjustment |
Double | Specifies the cost of the cart item before promotional discount. | 861.84002685546875 |
recurringTotalAfterPromotion |
Double | Specifies the recurring cost of the cart item after applying a promotional discount. | 622.67945433445129 |
recurringTotalBeforeAdjustment |
Double | Specifies the recurring cost of the cart item before adjustment . | 622.67945433445129 |
firstBillingChargeBefore |
Double | Specifies the amount for the first billing cycle, before any discount or promotions are applied. | 622.67945433445129 |
firstBillingChargeAfter |
Double | Specifies the amount for the first billing cycle after any discount or promotions are applied. | 622.67945433445129 |
totalBeforePromotion |
Double | Specifies the total cost of the cart item before a promotional discount is applied. | 861.84002685546875 |
totalAfterPromotion |
Double | Specifies the total cost of the cart item after a promotional discount is applied. | 622.67945433445129 |
termPriceBefore |
Double | Specifies the cost of the cart item for a specific billing term, before a discount is applied. | 861.84002685546875 |
termPriceAfterAdjustment |
Double | Specifies the cost of the cart item for a specific billing term, after a discount is applied. | 622.67945433445129 |
pricebookCost |
Double | Specifies the cost of the cart item included in the pricebook. | 820.79998779296875 |
accountCost |
Double | Specifies the cost of the cart item applicable to the customer. | 593.02802444839472 |
recurringTotalPricebookCost |
Double | Specifies the cost of the product, charged at regular intervals, based on the pricebook rates. | 820.79998779296875 |
recurringTotalAccountcost |
Double | Specifies the cost of the product for a specific customer, charged at regular intervals. | 593.02802444839472 |
totalPricebookCost |
Double | Specifies toatl cost of the cart item including upfront price and recurring charges. | 820.79998779296875 |
totalAccountCost |
Double | Specifies the toatl cost of the cart item for a specific customer, including upfront price and recurring charges. | 593.02802444839472 |
margin |
Double | Specifies the profit margin for the cart item. | 4.7619091459745366 |
appliedPromotions |
Array | Specifies the details of the promotional discounts applied on the cart item. | The elements in appliedPromotions array |
availablePromotions |
Array | Specifies the details of the available promotional discounts for the cart item. | The elements in availablePromotions array |
Elements in the appliedPromotions array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the date when the promotional discount was applied on the cart item. | 2025-07-01T00:00:00Z |
endDate |
String | Specifies the last date of the promotional discount. | 2025-10-01T00:00:00Z |
value |
Float | Specifies the amount of promotional discount. | 0.15 |
adjustmentType |
String | Specifies the type of promotional discount. | percent |
Elements in the availablePromotions array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the date when the promotional discount was available for the cart item. | 2025-07-01T00:00:00Z |
endDate |
String | Specifies the last date of the promotional discount availble for the cart item. | 2025-10-01T00:00:00Z |
value |
String | Specifies the amount of the promotional discount. | 0.15 |
adjustmentType |
String | Specifies the type of promotional discount. | percent |
Create Cart Item
The Create Cart Item endpoint creates a new cart item for a specified customer.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts
Sample Request:
{
"planName": "accounts/{account_id}/products/IBMCognos/versions/17/plans/Analytics-on-Cloud-1-Month-Upfro",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": "1",
"currencyCode": "USD",
"productType": "PRODUCT"
}
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | Numeric | Yes |
cartId |
Integer | Cart ID. | Numeric | Yes |
Request Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
planName |
String | The plan name of the subscription. | Analytics-on-Cloud-1-Month-Upfro | Yes |
status |
String | Specifies the status of the cart item. | DRAFT | Yes |
payment |
Object | Specifies the mode of the payment. | The elements in payment object. |
Yes |
quantity |
Integer | Specifies the quantity of the cart items. | 1 | Yes |
currencyCode |
Integer | The currency code. | USD | Yes |
productType |
Integer | Specifies the type of product. | PRODUCT | Yes |
Sample Response
{
"name": "customers/{customer_id}/cartItems/{cartItem_id}",
"cartName": "customers/{customer_id}/carts/{cart_id}",
"userName": "customers/{customer_id}/users/{user_id}",
"title": "IBM Cognos Analytics on Cloud - Analytics on Cloud 1 Month (Upfront) ",
"planName": "accounts/{account_id}/products/IBMCognos/versions/17/plans/Analytics-on-Cloud-1-Month-Upfro",
"period": "MONTH",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": 1,
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD"
},
"addOns": [
{
"planId": "IBM-Cognos-Analytics-on-Cloud-n1",
"displayName": "IBM Cognos Analytics on Cloud Standard",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 10
}
},
{
"planId": "IBM-Cognos-Analytics-on-Cloud-n2",
"displayName": "IBM Cognos Analytics on Cloud Plus",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 35
}
},
{
"planId": "IBM-Cognos-Analytics-on-Cloud-n3",
"displayName": "IBM Cognos Analytics on Cloud Premium",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 40
}
}
],
"currencyCode": "USD",
"paymentSpec": {
"offlineAllowed": true
},
"termUid": "16b04d9dc0ba5c8a257d",
"checkedOut": "FAILED",
"ownerId": "3335",
"productType": "PRODUCT"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | A unique identifier of the cart item. | customers/{customer_id}/cartItems/{cartItem_id}. |
cartName |
String | A unique identifier of the cart for corresponding cart item. | customers/{customer_id}/carts/{cart_id}. |
userName |
String | The name of the user who uses the subscription. | customers/{customer_id}/users/{user_id}. |
title |
String list | The name of the product. | Microsoft 365 NCE - Microsoft 365 E5. |
planName |
String | The plan name of the subscription. | accounts/{account_id}/products/Microsoft365EandFNCE--smpnce/versions/725/plans/Annual-n108. |
period |
String | Specifies the billing period of the cart item. | Values such as
|
status |
String | Specifies the status of the cart item. | Values such as
|
payment |
Object | Specifies the mode of the payment. | The elements in payment object. |
quantity |
Integer | Specifies the quantity of the cart items. | 1 |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement or checkout. | The elements in upfrontPrice object. |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in recurringPrice object. |
addOns |
Array list | Includes a collection of optional products or services that can be linked to a cart item. | The elements in addOns array list. |
currencyCode |
String | The currency code. | USD. |
paymentSpec |
Object | Specifies the payment rules for cart items. | The elements in paymentSpec object. |
termUid |
String | A unique identifier for the subscription term. | Alphanumeric. |
checkedOut |
String | Specifies whether the cart item is successfully checked out. | Values such as
|
ownerId |
String | A unique identifier for the customer or reseller who owns the cart item. | 194080. |
productType |
String | Specifies the type of product. | Values such as
|
skuId |
String | The SKU ID. | USCFQ7TTC0LFLZ0002. |
productExternalId |
String | External ID for the product. | US,CFQ7TTC0LFLZ,0002,One-year term duration. |
promotionExternalId |
String | External ID of the promotional discount. | 39NFJQT280NS:000D:084R5MQ9QF2R. |
isEligibleForPromo |
String | Specifies whether the cart item is eligible for promotional discount. | AVAILABLE. |
termDuration |
String | Specifies the duration of subscription term. | year. |
termDurationCount |
Integer | Describes the value of the element in termDuration. |
1 |
productDisplayName |
String | The display name of the product. | Microsoft 365 NCE. |
planDisplayName |
String | The display name of the plan to be purchased. | Microsoft 365 E5. |
Elements in the payment array object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
Elements in the upfrontPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
String | Specifies the recurring price. | 9 |
Elements in the addOns array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
planId |
String | Specifies the plan ID. | addon-Annual-n128 |
displaName |
String | The display name of the plan. | Microsoft Teams Enterprise – Unattended License |
quantitySpec |
Object | Specifies the quantity of the cart items. | The elements in the quantitySpec object |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement or checkout. | The elements in the upfrontPrice object |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in the recurringPrice object |
Elements in the quantitySpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
minQuantity |
Integer | Specifies the minimum quantity of the cart items to be purchased. | 1 |
maxQuantity |
Integer | Specifies the maximum quantity of the cart items to be purchased. | 2 |
Elements in the upfrontPrice - addOns object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice - addOns object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
Float | Specifies the recurring price. | 50.88 |
Elements in the paymentSpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
offlineAllowed |
Boolean | Specifies whether the offline payment is allowed for the corresponding cart item. | True |
immutable |
Boolean | Specifies whether the payment method can be modified. | Values such as
|
Update Cart Item
The Update Cart Item endpoint updates an existing cart item.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts
Sample Request:
{
"name": "customers/{customer_id}/carts/{cart_id}/cartItems/{cartItem_id}",
"cartName": "customers/{customer_id}/carts/{cart_id}",
"userName": "customers/{customer_id}/users/{user_id}",
"title": "IBM Cognos Analytics on Cloud - Analytics on Cloud 1 Month (Upfront) ",
"planName": "accounts/{account_id}/products/IBMCognos/versions/17/plans/Analytics-on-Cloud-1-Month-Upfro",
"period": "MONTH",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": 1,
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD"
},
"addOns": [
{
"planId": "IBM-Cognos-Analytics-on-Cloud-n1",
"displayName": "IBM Cognos Analytics on Cloud Standard",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 10
},
"quantity": 1
}
],
"currencyCode": "USD",
"paymentSpec": {
"offlineAllowed": true
},
"termUid": "16b04d9dc0ba5c8a257d",
"checkedOut": "FAILED",
"ownerId": "3335",
"productType": "PRODUCT"
}
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | Numeric | Yes |
cartId |
Integer | Cart Id. | Numeric | Yes |
cartItemId |
Integer | Cart item Id. | Numeric | Yes |
Request Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | A unique identifier of the cart item. | customers/{customer_id}/cartItems/{cartItem_id}. |
cartName |
String | A unique identifier of the cart for corresponding cart item. | customers/{customer_id}/carts/{cart_id}. |
userName |
String | The name of the user who uses the subscription. | customers/{customer_id}/users/{user_id}. |
title |
String list | The name of the product. | Microsoft 365 NCE - Microsoft 365 E5. |
planName |
String | The plan name of the subscription. | accounts/{account_id}/products/Microsoft365EandFNCE--smpnce/versions/725/plans/Annual-n108. |
period |
String | Specifies the billing period of the cart item. | Values such as
|
status |
String | Specifies the status of the cart item. | Values such as
|
payment |
Object | Specifies the mode of the payment. | The elements in payment object. |
quantity |
Integer | Specifies the quantity of the cart items. | 1 |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement/checkout. | The elements in upfrontPrice object. |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in recurringPrice object. |
addOns |
Array list | Includes a collection of optional products or services that can be linked to a cart item. | The elements in addOns array list. |
currencyCode |
String | The currency code. | USD. |
paymentSpec |
Object | Specifies the payment rules for cart items. | The elements in paymentSpec object. |
termUid |
String | A unique identifier for the subscription term. | Alphanumeric. |
checkedOut |
String | Specifies whether the cart item is successfully checked out. | Values such as
|
ownerId |
String | A unique identifier for the customer or reseller who owns the cart item. | 194080. |
productType |
String | Specifies the type of product. | Values such as
|
skuId |
String | The SKU ID. | USCFQ7TTC0LFLZ0002. |
productExternalId |
String | External ID for the product. | US,CFQ7TTC0LFLZ,0002,One-year term duration. |
promotionExternalId |
String | External ID for the promotional discount. | 39NFJQT280NS:000D:084R5MQ9QF2R. |
isEligibleForPromo |
String | Specifies whether the cart item is eligible for promotional discount. | AVAILABLE. |
termDuration |
String | Specifies the duration of subscription term. | year. |
termDurationCount |
Integer | Describes the value of the element in termDuration. |
1 |
productDisplayName |
String | The display name of the product. | Microsoft 365 NCE. |
planDisplayName |
String | The display name of the plan to be purchased. | Microsoft 365 E5. |
Elements in the payment object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
Elements in the upfrontPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
String | Specifies the recurring price. | 9 |
Elements in the addOns array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
planId |
String | Specifies the plan ID. | addon-Annual-n128 |
displaName |
String | The display name of the plan. | Microsoft Teams Enterprise – Unattended License |
quantitySpec |
Object | Specifies the quantity of the cart items. | The elements in the quantitySpec object |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement or checkout. | The elements in the upfrontPrice object |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in the recurringPrice object |
Elements in the quantitySpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
minQuantity |
Integer | Specifies the minimum quantity of the cart items to be purchased. | 1 |
maxQuantity |
Integer | Specifies the maximum quantity of the cart items to be purchased. | 2 |
Elements in the upfrontPrice - addOns object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice - addOns object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
Float | Specifies the recurring price. | 50.88 |
Elements in the paymentSpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
offlineAllowed |
Boolean | Specifies whether the offline payment is allowed for the corresponding cart item. | True |
immutable |
Boolean | Specifies whether the payment method can be modified. | Values such as
|
Sample Response
{
"name": "customers/{customer_id}/cartItems/{cartItem_id}",
"cartName": "customers/{customer_id}/carts/{cart_id}",
"userName": "customers/{customer_id}/users/{user_id}",
"title": "IBM Cognos Analytics on Cloud - Analytics on Cloud 1 Month (Upfront) ",
"planName": "accounts/{account_id}/products/IBMCognos/versions/17/plans/Analytics-on-Cloud-1-Month-Upfro",
"period": "MONTH",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": 1,
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD"
},
"addOns": [
{
"planId": "IBM-Cognos-Analytics-on-Cloud-n1",
"displayName": "IBM Cognos Analytics on Cloud Standard",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 10
}
},
{
"planId": "IBM-Cognos-Analytics-on-Cloud-n2",
"displayName": "IBM Cognos Analytics on Cloud Plus",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 35
}
},
{
"planId": "IBM-Cognos-Analytics-on-Cloud-n3",
"displayName": "IBM Cognos Analytics on Cloud Premium",
"quantitySpec": {
"minQuantity": 1,
"maxQuantity": 1
},
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 40
}
}
],
"currencyCode": "USD",
"paymentSpec": {
"offlineAllowed": true
},
"termUid": "16b04d9dc0ba5c8a257d",
"checkedOut": "FAILED",
"ownerId": "3335",
"productType": "PRODUCT"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | A unique identifier of the cart item. | customers/{customer_id}/cartItems/{cartItem_id}. |
cartName |
String | A unique identifier of the cart for corresponding cart item. | customers/{customer_id}/carts/{cart_id}. |
userName |
String | The name of the user who uses the subscription. | customers/{customer_id}/users/{user_id}. |
title |
String list | The name of the product. | Microsoft 365 NCE - Microsoft 365 E5. |
planName |
String | The plan name of the subscription. | accounts/{account_id}/products/Microsoft365EandFNCE--smpnce/versions/725/plans/Annual-n108. |
period |
String | Specifies the billing period of the cart item. | Values such as
|
status |
String | Specifies the status of the cart item. | Values such as
|
payment |
Object | Specifies the mode of the payment. | The elements in payment object. |
quantity |
Integer | Specifies the quantity of the cart items. | 1 |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement or checkout. | The elements in upfrontPrice object. |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in recurringPrice object. |
addOns |
Array list | Includes a collection of optional products or services that can be linked to a cart item. | The elements in addOns array list. |
currencyCode |
String | The currency code. | USD. |
paymentSpec |
Object | Specifies the payment rules for cart items. | The elements in paymentSpec object. |
termUid |
String | A unique identifier for the subscription term. | Alphanumeric. |
checkedOut |
String | Specifies whether the cart item is successfully checked out. | Values such as
|
ownerId |
String | A unique identifier for the customer or reseller who owns the cart item. | 194080. |
productType |
String | Specifies the type of product. | Values such as
|
skuId |
String | The SKU ID. | USCFQ7TTC0LFLZ0002. |
productExternalId |
String | External ID for the product. | US,CFQ7TTC0LFLZ,0002,One-year term duration. |
promotionExternalId |
String | External ID of the promotional discount. | 39NFJQT280NS:000D:084R5MQ9QF2R. |
isEligibleForPromo |
String | Specifies whether the cart item is eligible for promotional discount. | AVAILABLE. |
termDuration |
String | Specifies the duration of subscription term. | year. |
termDurationCount |
Integer | Describes the value of the element in termDuration. |
1 |
productDisplayName |
String | The display name of the product. | Microsoft 365 NCE. |
planDisplayName |
String | The display name of the plan to be purchased. | Microsoft 365 E5. |
Elements in the payment object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
Elements in the upfrontPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
String | Specifies the recurring price. | 9 |
Elements in the addOns array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
planId |
String | Specifies the plan ID. | addon-Annual-n128 |
displaName |
String | The display name of the plan. | Microsoft Teams Enterprise – Unattended License |
quantitySpec |
Object | Specifies the quantity of the cart items. | The elements in the quantitySpec object |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement or checkout. | The elements in the upfrontPrice object |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in the recurringPrice object |
Elements in the quantitySpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
minQuantity |
Integer | Specifies the minimum quantity of the cart items to be purchased. | 1 |
maxQuantity |
Integer | Specifies the maximum quantity of the cart items to be purchased. | 2 |
Elements in the upfrontPrice - addOns object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice - addOns object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
Float | Specifies the recurring price. | 50.88 |
Elements in the paymentSpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
offlineAllowed |
Boolean | Specifies whether the offline payment is allowed for the corresponding cart item. | True |
immutable |
Boolean | Specifies whether the payment method can be modified. | Values such as
|
Get Cart Item
The Get Cart Item endpoint retrieves details of a specific cart item according to the associated customer ID and cart ID.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/customers/{customerId}/carts/{cartId}/cartItems/{cartItemId}
Sample Request:
curl --request GET \
--url https://ion.tdsynnex.com/api/v3/customers/%7BcustomerId%7D/carts/%7BcartId%7D/cartItems/%7BcartItemId%7D
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
customerId |
Integer | Customer Id in CCP. | Numeric | Yes |
cartId |
Integer | Cart Id. | Numeric | Yes |
cartItemId |
Integer | Cart item Id. | Numeric | Yes |
Sample Response
{
"name": "customers/{customer_id}/cartItems/{cartItem_id}",
"cartName": "customers/{customer_id}/carts/{cart_id}",
"userName": "customers/{customer_id}/users/{user_id}",
"title": "Microsoft 365 NCE - Microsoft 365 E5",
"planName": "accounts/{account_id}/products/Microsoft365EandFNCE--smpnce/versions/725/plans/Annual-n108",
"period": "YEAR",
"status": "DRAFT",
"payment": {
"paymentType": "OFFLINE"
},
"quantity": 1,
"upfrontPrice": {
"currency": "USD"
},
"recurringPrice": {
"currency": "USD",
"value": 9
},
"currencyCode": "USD",
"paymentSpec": {
"offlineAllowed": true,
"immutable": true
},
"termUid": "168d692db6b39025701a",
"checkedOut": "FAILED",
"ownerId": "194080",
"productType": "PRODUCT",
"skuId": "USCxxxTTxxxFLZ0002",
"productExternalId": "US,CFQ7TTC0LFLZ,0002,One-year term duration",
"priceModificationDetails": {
"masterPrice": 684,
"priceBeforePromoAndAdjustment": 861.84002685546875,
"recurringTotalAfterPromotion": 622.67945433445129,
"recurringTotalBeforeAdjustment": 622.67945433445129,
"firstBillingChargeBefore": 622.67945433445129,
"firstBillingChargeAfter": 622.67945433445129,
"totalBeforePromotion": 861.84002685546875,
"totalAfterPromotion": 622.67945433445129,
"termPriceBefore": 861.84002685546875,
"termPriceAfterAdjustment": 622.67945433445129,
"pricebookCost": 820.79998779296875,
"accountCost": 593.02802444839472,
"recurringTotalPricebookCost": 820.79998779296875,
"recurringTotalAccountcost": 593.02802444839472,
"totalPricebookCost": 820.79998779296875,
"totalAccountCost": 593.02802444839472,
"margin": 4.7619091459745366,
"appliedPromotions": [
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
},
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
}
],
"availablePromotions": [
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
},
{
"startDate": "2025-07-01T00:00:00Z",
"endDate": "2025-10-01T00:00:00Z",
"value": 0.15,
"adjustmentType": "percent"
}
]
},
"promotionExternalId": "39xxxQTxxxNS:xxxD:08xxxMQxxx2R",
"isEligibleForPromo": "AVAILABLE",
"termDuration": "year",
"termDurationCount": 1,
"productDisplayName": "Microsoft 365 NCE",
"planDisplayName": "Microsoft 365 E5"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
name |
String | A unique identifier of the cart item. | customers/{customer_id}/cartItems/{cartItem_id}. |
cartName |
String | A unique identifier of the cart for corresponding cart item. | customers/{customer_id}/carts/{cart_id}. |
userName |
String | The name of the user who uses the subscription. | customers/{customer_id}/users/{user_id}. |
title |
String list | The name of the product. | Microsoft 365 NCE - Microsoft 365 E5. |
planName |
String | The plan name of the subscription. | accounts/{account_id}/products/Microsoft365EandFNCE--smpnce/versions/725/plans/Annual-n108. |
period |
String | Specifies the billing period of the cart item. | Values such as
|
status |
String | Specifies the status of the cart item. | Values such as
|
payment |
Object | Specifies the mode of the payment. | The elements in payment object. |
quantity |
Integer | Specifies the quantity of the cart items. | 1 |
upfrontPrice |
Object | Specifies the amount to be paid at the time of agreement or checkout. | The elements in upfrontPrice object. |
recurringPrice |
Object | Specifies the price of the product, charged at regular intervals during a selected phase. | The elements in recurringPrice object. |
currencyCode |
String | The currency code. | USD. |
paymentSpec |
Object | Specifies the payment rules for cart items. | The elements in paymentSpec object. |
termUid |
String | A unique identifier for the subscription term. | Alphanumeric. |
checkedOut |
String | Specifies whether the cart item is successfully checked out. | Values such as
|
ownerId |
String | A unique identifier for the customer or reseller who owns the cart item. | 194080. |
productType |
String | Specifies the type of product. | Values such as
|
skuId |
String | The SKU ID. | USCFQ7TTC0LFLZ0002. |
productExternalId |
String | External ID for the product. | US,CFQ7TTC0LFLZ,0002,One-year term duration. |
priceModificationDetails |
Object | Specifies the detailed pricing information of the cart items. | The elements in priceModificationDetails object. |
promotionExternalId |
String | External ID of the promotional discount. | 39NFJQT280NS:000D:084R5MQ9QF2R. |
isEligibleForPromo |
String | Specifies whether the cart item is eligible for promotional discount. | AVAILABLE. |
termDuration |
String | Specifies the duration of the subscription term. | year. |
termDurationCount |
Integer | Describes the value of the element in termDuration. |
1 |
productDisplayName |
String | The display name of the product. | Microsoft 365 NCE. |
planDisplayName |
String | The display name of the plan to be purchased. | Microsoft 365 E5. |
Elements in the payment object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
paymentType |
String | Specifies the payment method used. | Values such as:
|
Elements in the upfrontPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
Elements in the recurringPrice object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
String | Specifies the currency used. | USD |
value |
String | Specifies the recurring price. | 9 |
Elements in the paymentSpec object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
offlineAllowed |
Boolean | Specifies whether offline payment is allowed for the corresponding cart item. | True |
immutable |
Boolean | Specifies whether the payment method can be modified. | Values such as
|
Elements in the priceModificationDetails object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
masterPrice |
Double | Specifies the original cost of the cart item before any adjustment. | 120 |
priceBeforePromoAndAdjustment |
Double | Specifies the cost of the cart item before promotional discount. | 861.84002685546875 |
recurringTotalAfterPromotion |
Double | Specifies the recurring cost of the cart item after applying a promotional discount. | 622.67945433445129 |
recurringTotalBeforeAdjustment |
Double | Specifies the recurring cost of the cart item before adjustment . | 622.67945433445129 |
firstBillingChargeBefore |
Double | Specifies the amount for the first billing cycle, before any discount or promotions are applied. | 622.67945433445129 |
firstBillingChargeAfter |
Double | Specifies the amount for the first billing cycle after any discount or promotions are applied. | 622.67945433445129 |
totalBeforePromotion |
Double | Specifies the total cost of the cart item before a promotional discount is applied. | 861.84002685546875 |
totalAfterPromotion |
Double | Specifies the total cost of the cart item after a promotional discount is applied. | 622.67945433445129 |
termPriceBefore |
Double | Specifies the cost of the cart item for a specific billing term, before a discount is applied. | 861.84002685546875 |
termPriceAfterAdjustment |
Double | Specifies the cost of the cart item for a specific billing term, after a discount is applied. | 622.67945433445129 |
pricebookCost |
Double | Specifies the cost of the cart item included in the pricebook. | 820.79998779296875 |
accountCost |
Double | Specifies the cost of the cart item applicable to the customer. | 593.02802444839472 |
recurringTotalPricebookCost |
Double | Specifies the cost of the product, charged at regular intervals, based on the pricebook rates. | 820.79998779296875 |
recurringTotalAccountcost |
Double | Specifies the cost of the product for a specific customer, charged at regular intervals. | 593.02802444839472 |
totalPricebookCost |
Double | Specifies toatl cost of the cart item including upfront price and recurring charges. | 820.79998779296875 |
totalAccountCost |
Double | Specifies the toatl cost of the cart item for a specific customer, including upfront price and recurring charges. | 593.02802444839472 |
margin |
Double | Specifies the profit margin for the cart item. | 4.7619091459745366 |
appliedPromotions |
Array | Specifies the details of the promotional discounts applied on the cart item. | The elements in appliedPromotions array |
availablePromotions |
Array | Specifies the details of the available promotional discounts for the cart item. | The elements in availablePromotions array |
Elements in the appliedPromotions array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the date when the promotional discount was applied on the cart item. | 2025-07-01T00:00:00Z |
endDate |
String | Specifies the last date of the promotional discount. | 2025-10-01T00:00:00Z |
value |
Float | Specifies the amount of promotional discount. | 0.15 |
adjustmentType |
String | Specifies the type of promotional discount. | percent |
Elements in the availablePromotions array
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the date when the promotional discount was available for the cart item. | 2025-07-01T00:00:00Z |
endDate |
String | Specifies the last date of the promotional discount availble for the cart item. | 2025-10-01T00:00:00Z |
value |
String | Specifies the amount of the promotional discount. | 0.15 |
adjustmentType |
String | Specifies the type of promotional discount. | percent |
Reports
Reports transform raw data into a structured format. StreamOne Ion provides predefined report templates. You can use reports to track billing information and subscription data, for a specific user.
Using the Report endpoints, you can perform following activities:
- Explore the existing report templates
- Retrieve the data
- Integrate the data with tools such as CRM, Power BI and so on
- Download the report in csv format
- Delete reports
You can retrieve the report ID for a specific report, using the following methods:
-
From List Reports endpoint
Using List Reports endpoint, you can obtain the report ID for any report. - From UI
The procedure to obtain the report ID from UI is stated below. - Sign-in to your account.
A dashboard page is displayed. - Select Reports.
A list of report categories is displayed on the Reports page. - Select the required report category.
A list of available reports is displayed. - Select the required report.
The report ID is displayed in the address bar.
The Reports endpoints of StreamOne® Ion API allow you to:
Get Reports MetaData
Using the Get Report Metadata endpoint, you can retrieve information about the structure of the report including column definitions, currency information, date ranges, and so on. This structure does not include actual data.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/reports/{report_id}
Sample Request:
curl --request GET \
--url 'https://ion.tdsynnex.com/api/v3/accounts/%7BaccountId%7D/reports/%7Breport_id%7D?include_metadata=SOME_BOOLEAN_VALUE'
Request Parameter Description:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | Reseller ID in CCP. | 1234 | Yes |
report_Id |
String | Report ID. | 56789 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
include_metadata |
Boolean | Includes detailed metadata of the corresponding report. | Values such as True and False | No |
Sample Response
{
"reportId":"23582",
"displayName":"Microsoft CSP Billing Customers Report",
"category":"BILLING_REPORTS",
"createdBy":"System",
"lastUpdatedBy":"System",
"specs":
{
"allColumns":[
{
"id":"116712",
"displayName":"Availability ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.availability_id"
},
{
"id":"116708",
"displayName":"Azure Customer Country",
"groupable":true,
"columnTemplateId":"azure_plan_billingazure_customer_country"
},
{
"id":"116709",
"displayName":"Azure Customer ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.azure_customer_id"
},
{
"id":"153151",
"displayName":"Billing Cycle",
"groupable":true,"columnTemplateId":"azure_plan_billing.term_and_billingcycle"
},
{
"id":"158760",
"displayName":"Billing Frequency",
"groupable":true,
"columnTemplateId":"azure_plan_billing.billing_frequency"
},
{
"id":"153150",
"displayName":"Charge EndDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.usage_endtime"
},
{
"id":"153149",
"displayName":"Charge StartDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.usage_starttime"
},
{
"id":"116718",
"displayName":"Charge Type",
"groupable":true,
"columnTemplateId":"azure_plan_billing.charge_type"
},
{
"id":"1412002",
"displayName":"Charge or Savings Plan",
"groupable":true,
"columnTemplateId":"azure_plan_billing.benefit_type"
},
{
"id":"116694",
"displayName":"Cloud Account Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.cloud_account_name"
},
{
"id":"116704",
"displayName":"Currency Conversion Rates",
"groupable":true,
"columnTemplateId":"azure_plan_billing.conversion_rates"
},
{
"id":"116676",
"displayName":"Customer Company",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_company_name"
},
{
"id":"1434946",
"displayName":"Customer Company Reseller",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_company_name_reseller"
},
{
"id":"116684",
"displayName":"Customer Cost",
"columnTemplateId":"azure_plan_billing.customer_cost"
},
{
"id":"116699",
"displayName":"Customer Cost (Invoiced Currency)",
"columnTemplateId":"azure_plan_billing.customer_cost_invoice"
},
{
"id":"116698",
"displayName":"Customer Cost (Provider Currency)",
"columnTemplateId":"azure_plan_billing.customer_cost_raw"
},
{
"id":"116696",
"displayName":"Customer Country",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_country"
},
{
"id":"116674",
"displayName":"Customer ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_id"
},
{
"id":"116675",
"displayName":"Customer Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.unique_name"
},
{
"id":"116697",
"displayName":"Customer State",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_state"
},
{
"id":"122070",
"displayName":"Discount Rate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.discount_rate"
},
{
"id":"148041",
"displayName":"Domain Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.domain_name"
},
{
"id":"1422786",
"displayName":"Effective Unit Price",
"groupable":true,
"columnTemplateId":"azure_plan_billing.effective_unit_price"
},
{
"id":"1035708",
"displayName":"Entitlement Description",
"groupable":true,
"columnTemplateId":"azure_plan_billing.entitlement_description"
},
{
"id":"122069",
"displayName":"EntitlementID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.entitlement_id"
},
{
"id":"116671",
"displayName":"Group Tag ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.group_tag_id"
},
{
"id":"116672",
"displayName":"Group Tag Label",
"groupable":true,
"columnTemplateId":"azure_plan_billing.group_tag_label"
},
{
"id":"116706",
"displayName":"Invoice Currency",
"groupable":true,
"columnTemplateId":"azure_plan_billing.invoice_currency"
},
{
"id":"116707",
"displayName":"Invoice Number",
"groupable":true,
"columnTemplateId":"azure_plan_billing.invoice_number"
},
{
"id":"116713",
"displayName":"MPN ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.mpn_id"
},
{
"id":"1430286",
"displayName":"MSRP",
"columnTemplateId":"azure_plan_billing.msrp_cost"
},
{
"id":"116685",
"displayName":"Margin",
"columnTemplateId":"azure_plan_billing.margin"
},
{
"id":"116703",
"displayName":"Margin (Invoiced Currency)",
"columnTemplateId":"azure_plan_billing.margin_invoice"
},
{
"id":"116702",
"displayName":"Margin (Provider Currency)",
"columnTemplateId":"azure_plan_billing.margin_raw"
},
{
"id":"116682",
"displayName":"Meter Category",
"groupable":true,
"columnTemplateId":"azure_plan_billing.meter_category"
},
{
"id":"116691",
"displayName":"Meter ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.meter_id"
},
{
"id":"116681",
"displayName":"Meter Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.meter_name"
},
{
"id":"116687",
"displayName":"Meter Sub Category",
"groupable":true,
"columnTemplateId":"azure_plan_billing.meter_sub_category"
},
{
"id":"116690",
"displayName":"Metered Region",
"groupable":true,
"columnTemplateId":"azure_plan_billing.metered_region"
},
{
"id":"1487669",
"displayName":"Mfg Part Number",
"groupable":true,
"columnTemplateId":"azure_plan_billing.mfg_part_number"
},
{
"id":"153152",
"displayName":"Order Date",
"groupable":true,
"columnTemplateId":"azure_plan_billing.order_date"
},
{
"id":"1035707",
"displayName":"Order Number",
"groupable":true,
"columnTemplateId":"azure_plan_billing.order_number"
},
{
"id":"1508207",
"displayName":"Override Effective Date",
"groupable":true,
"columnTemplateId":"azure_plan_billing.override_effective_date"
},
{
"id":"1508208",
"displayName":"Override End Date",
"groupable":true,
"columnTemplateId":"azure_plan_billing.override_end_date"
},
{
"id":"469068",
"displayName":"PAC of Origin",
"groupable":true,
"columnTemplateId":"azure_plan_billing.pac_of_origin"
},
{
"id":"150431",
"displayName":"Period Quantity",
"groupable":true,
"columnTemplateId":"azure_plan_billing.period_quantity"
},
{
"id":"1499875",
"displayName":"Price Change",
"groupable":true,
"columnTemplateId":"azure_plan_billing.price_change"
},
{
"id":"1499876",
"displayName":"Price Change Value",
"groupable":true,
"columnTemplateId":"azure_plan_billing.price_change_value"
},
{
"id":"116677",
"displayName":"Price book",
"groupable":true,
"columnTemplateId":"azure_plan_billing.price_book"
},
{
"id":"116678",
"displayName":"Price book ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.price_book_id"
},
{
"id":"116710",
"displayName":"Product ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.product_id"
},
{
"id":"116715",
"displayName":"Product Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.product_name"
},
{
"id":"158759",
"displayName":"Promotion EndDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.promotion_enddate"
},
{
"id":"152096",
"displayName":"Promotion Rate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.promotion_rate"
},
{
"id":"158758",
"displayName":"Promotion StartDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.promotion_startdate"
},
{
"id":"152095",
"displayName":"PromotionID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.promotion_id"
},
{
"id":"116705",
"displayName":"Provider Currency",
"groupable":true,
"columnTemplateId":"azure_plan_billing.provider_currency"
},
{
"id":"121566",
"displayName":"Publisher ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.publisher_id"
},
{
"id":"121565",
"displayName":"Publisher Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.publisher_name"
},
{
"id":"1415206",
"displayName":"Rate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.rate"
},
{
"id":"116689",
"displayName":"Region",
"groupable":true,
"columnTemplateId":"azure_plan_billing.region"
},
{
"id":"116670",
"displayName":"Reseller ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.reseller_id"
},
{
"id":"116714",
"displayName":"Reseller MPN ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.reseller_mpn_id"
},
{
"id":"116673",
"displayName":"Reseller Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.reseller_name"
},
{
"id":"147735",
"displayName":"Reservation Order ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.reservation_order_id"
},
{
"id":"116680",
"displayName":"Resource Group",
"groupable":true,
"columnTemplateId":"azure_plan_billing.resource_group"
},
{
"id":"116692",
"displayName":"Resource URI",
"groupable":true,
"columnTemplateId":"azure_plan_billing.resource_uri"
},
{
"id":"116711",
"displayName":"SKU ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.sku_id"
},
{
"id":"116716",
"displayName":"SKU Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.sku_name"
},
{
"id":"1412001",
"displayName":"Savings Plan ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.benefit_id"
},
{
"id":"1412000",
"displayName":"Savings Plan Order ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.benefit_order_id"
},
{
"id":"950384",
"displayName":"Seat Count",
"groupable":true,
"columnTemplateId":"azure_plan_billing.seat_count"
},
{
"id":"897807",
"displayName":"Segment",
"groupable":true,
"columnTemplateId":"azure_plan_billing.segment"
},
{
"id":"116683",
"displayName":"Seller Cost",
"columnTemplateId":"azure_plan_billing.seller_cost"
},
{
"id":"116701",
"displayName":"Seller Cost (Invoiced Currency)",
"columnTemplateId":"azure_plan_billing.seller_cost_invoice"
},
{
"id":"116700",
"displayName":"Seller Cost (Provider Currency)",
"columnTemplateId":"azure_plan_billing.seller_cost_raw"
},
{
"id":"153148",
"displayName":"Subscription EndDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.subscription_enddate"
},
{
"id":"116679",
"displayName":"Subscription ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.cloud_account_number"
},
{
"id":"153147",
"displayName":"Subscription StartDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.subscription_startdate"
},
{
"id":"116717",
"displayName":"Term And Billing Cycle",
"groupable":true,
"columnTemplateId":"azure_plan_billing.term_and_billing_cycle"
},
{
"id":"116695",
"displayName":"Type",
"groupable":true,
"columnTemplateId":"azure_plan_billing.type"
},
{
"id":"116688",
"displayName":"Unit",
"groupable":true,
"columnTemplateId":"azure_plan_billing.unit"
},
{
"id":"1415205",
"displayName":"Unit Price",
"groupable":true,
"columnTemplateId":"azure_plan_billing.unit_price"
},
{
"id":"116686",
"displayName":"Usage Quantity",
"columnTemplateId":"azure_plan_billing.usage"
},
{
"id":"121564",
"displayName":"Usage Type",
"groupable":true,
"columnTemplateId":"azure_plan_billing.usage_type"
}
],
"selectedColumns":[
{
"id":"116675",
"displayName":"Customer Name",
"groupingLevel":1,
"isInvoiceKey":true,
"valueType":"STRING",
"columnHeading":"Customer Name",
"columnTemplateId":"azure_plan_billing.unique_name"
},
{
"id":"121565",
"displayName":"Publisher Name",
"groupingLevel":2,
"valueType":"STRING",
"columnHeading":"Publisher Name",
"columnTemplateId":"azure_plan_billing.publisher_name"
},
{
"id":"116694",
"displayName":"Cloud Account Name",
"groupingLevel":3,
"valueType":"STRING",
"columnHeading":"Cloud Account Name",
"columnTemplateId":"azure_plan_billing.cloud_account_name"
},
{
"id":"116715",
"displayName":"Product Name",
"groupingLevel":4,
"valueType":"STRING",
"columnHeading":"Product Name",
"columnTemplateId":"azure_plan_billing.product_name"
},
{
"id":"116716",
"displayName":"SKU Name",
"groupingLevel":5,
"valueType":"STRING",
"columnHeading":"SKU Name",
"columnTemplateId":"azure_plan_billing.sku_name"
},
{
"id":"116717",
"displayName":"Term And Billing Cycle",
"groupingLevel":6,
"valueType":"STRING",
"columnHeading":"Term And Billing Cycle",
"columnTemplateId":"azure_plan_billing.term_and_billing_cycle"
},
{
"id":"116677",
"displayName":"Price book",
"valueType":"STRING",
"columnHeading":"Price book",
"columnTemplateId":"azure_plan_billing.price_book"
},
{
"id":"116683",
"displayName":"Seller Cost",
"aggType":"SUM_COLUMN_AGGREGATION_TYPE",
"valueType":"MONEY",
"columnHeading":"Seller Cost (USD)",
"columnTemplateId":"azure_plan_billing.seller_cost"
},
{
"id":"116684",
"displayName":"Customer Cost",
"aggType":"SUM_COLUMN_AGGREGATION_TYPE",
"valueType":"MONEY",
"columnHeading":"Customer Cost (USD)",
"columnTemplateId":"azure_plan_billing.customer_cost"
},
{
"id":"116685",
"displayName":"Margin",
"aggType":"SUM_COLUMN_AGGREGATION_TYPE",
"valueType":"MONEY",
"columnHeading":"Margin (USD)",
"columnTemplateId":"azure_plan_billing.margin"
},
{
"id":"116686",
"displayName":"Usage Quantity",
"aggType":"SUM_COLUMN_AGGREGATION_TYPE",
"valueType":"FLOAT",
"columnHeading":"Usage Quantity",
"columnTemplateId":"azure_plan_billing.usage"
},
{
"id":"116688",
"displayName":"Unit",
"valueType":"STRING",
"columnHeading":"Unit",
"columnTemplateId":"azure_plan_billing.unit"
},
{
"id":"116689",
"displayName":"Region",
"valueType":"STRING",
"columnHeading":"Region",
"columnTemplateId":"azure_plan_billing.region"
},
{
"id":"950384",
"displayName":"Seat Count",
"valueType":"FLOAT",
"columnHeading":"Seat Count",
"columnTemplateId":"azure_plan_billing.seat_count"
}
],
"columnFilters":[
{
"id":"116675",
"displayName":"Customer Name",
"columnTemplateId":"azure_plan_billing.unique_name"
},
{
"id":"121565",
"displayName":"Publisher Name",
"columnTemplateId":"azure_plan_billing.publisher_name"
},
{
"id":"116694",
"displayName":"Cloud Account Name",
"columnTemplateId":"azure_plan_billing.cloud_account_name"
},
{
"id":"116677",
"displayName":"Price book",
"columnTemplateId":"azure_plan_billing.price_book"
},
{
"id":"116689",
"displayName":"Region",
"columnTemplateId":"azure_plan_billing.region"
}
],
"dateRangeOption":
{
"selectedRange":
{
"relativeDateRange":"MONTH_TO_DATE",
"relativeActualDateRange":
{
"startDate":"2025-05-01T00:00:00Z",
"endDate":"2025-05-14T00:00:00Z"
}
}
},
"currencyOption":
{
"availableCurrencies":
[
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
{
"code":"AUD",
"symbol":"$",
"name":"Australian Dollar",
"displayOrder":2
},
{
"code":"CAD",
"symbol":"$",
"name":"Canadian Dollar",
"displayOrder":4
},
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
{
"code":"CHF",
"symbol":"CHF",
"name":"Swiss Franc",
"displayOrder":9
},
{
"code":"SGD",
"symbol":"$",
"name":"Singapore Dollar",
"displayOrder":11
},
{
"code":"MYR",
"symbol":"MYR",
"name":"Malaysian Ringgits",
"displayOrder":21
},
{
"code":"INR",
"symbol":"₹",
"name":"Indian Rupee",
"displayOrder":24
},
{
"code":"VND",
"symbol":"₫",
"name":"Vietnamese đồng",
"displayOrder":26
},
{
"code":"ALL",
"symbol":"Lek",
"name":"Albanian Lek",
"displayOrder":34
},
{
"code":"AMD",
"symbol":"֏",
"name":"Armenian dram",
"displayOrder":44
}
],
"selectedCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
}
},
"customerFieldKeys":
[
{
"displayName":"AutomationField123",
"uniqueKey":"AutomationTest070520240307"
},
{
"displayName":"Automation_TestCustomField",
"uniqueKey":"Test_Fields_0506020327_Edited_20240716"
},
{
"displayName":"CIS_ID",
"uniqueKey":"CIS_ID"
},
{
"displayName":"Consolidation_Type",
"uniqueKey":"Consolidation_Type"
},
{
"displayName":"DefectValidation",
"uniqueKey":"DefectValidation"
},
{
"displayName":"Microsoft_ResellerPO",
"uniqueKey":"Microsoft_ResellerPO"
},
{
"displayName":"SAP ID",
"uniqueKey":"SAP_ID"
}
],
"cloudAccountFieldKeys":
[
{
"displayName":"End_Customer_PO",
"uniqueKey":"End_Customer_PO"
},
{
"displayName":"GNH",
"uniqueKey":"GNH"
},
{
"displayName":"Reseller_1PO",
"uniqueKey":"Reseller1_PO"
},
{
"displayName":"Reseller_PO",
"uniqueKey":"Reseller_PO"
}
],
"conversionRates":
[
{
"fromCurrency":
{
"code":"AUD",
"symbol":"$",
"name":"Australian Dollar",
"displayOrder":2
},
"toCurrency":
{
"code":"AUD",
"symbol":"$",
"name":"Australian Dollar",
"displayOrder":2
},
"rate":1
},
{
"fromCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"toCurrency":
{
"code":"CAD",
"symbol":"$",
"name":"Canadian Dollar",
"displayOrder":4
},
"rate":1.511186389847
},
{
"fromCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"toCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"rate":1
},
{
"fromCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"toCurrency":
{
"code":"INR",
"symbol":"₹",
"name":"Indian Rupee",
"displayOrder":24
},
"rate":92.984482469384
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"ALL",
"symbol":"Lek",
"name":"Albanian Lek",
"displayOrder":34
},
"rate":90.21199819576
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"AMD",
"symbol":"֏",
"name":"Armenian dram",
"displayOrder":44
},
"rate":388.048117966628
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"AUD",
"symbol":"$",
"name":"Australian Dollar",
"displayOrder":2
},
"rate":1.484979433035
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{"code":"CAD",
"symbol":"$",
"name":"Canadian Dollar",
"displayOrder":4
},
"rate":1.363196422973
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"CHF",
"symbol":"CHF",
"name":"Swiss Franc",
"displayOrder":9
},
"rate":0.862597678405
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"rate":1.25
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"MYR",
"symbol":"MYR",
"name":"Malaysian Ringgits",
"displayOrder":21
},
"rate":4.377497909745
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"SGD",
"symbol":"$",
"name":"Singapore Dollar",
"displayOrder":11
},
"rate":1.308034207711
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"rate":1,
"isDefault":true
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"VND",
"symbol":"₫",
"name":"Vietnamese đồng",
"displayOrder":26
},
"rate":25000
}
],
"importsStatus":
{
"imports":
[
{
"details":"MpnIDs: 5462014",
"billingMonth":"2025-05-01T00:00:00Z",
"ranAt":"2025-05-14T10:13:46Z"
}
]
}
},
"createTime":"0001-01-01T00:00:00Z",
"providerIds":["30"],
"reportTemplateId":"azure_plan_billing",
"reportModule":"REPORTS_REPORTS_MODULE"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
reportId |
String | The report ID. | Numeric value such as 1234 |
displayName |
String | The name of the report that is displayed on the UI. | AWS billing report |
category |
String | Specifies the type of report and helps to organize reports in the UI. | Billing_Reports |
createdBy |
String | Specifies the author of the report. | System |
lastUpdatedBy |
String | Specifies the latest editor of the report. | System |
specs |
Object | Report setting that the user specifies. | The elements in the specs object |
createTime |
String | The time when the report is created, in YYYY-MM-DD HH:Min format. | 0001-01-01T00:00:00Z |
providerIds |
Array | The cloud provider ID. | 30 |
reportTemplateId |
String | An identifier for a specific report layout. | Azure_Plan_Billing |
reportModule |
String | The modules that use the reports service. | Values such as
|
Elements in the specs object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
allColumns |
Array | All available columns for this report. | The elements in the allColumns array list |
selectedColumns |
Array | All selected columns for this report. | The elements in the selectedColumns array list |
columnFilters |
Array | Filters the report data using predefined filters such as customerName, pricebook, region, and so on. | The elements in the columnFilters array list |
dateRangeOption |
Object | The available and selected date ranges for the report. | The elements in the dateRangeOption object |
currencyOption |
Object | The available and selected currencies for the report. | The elements in the currencyOption object |
customerFieldKeys |
Array | Specifies the list of available custom fields linked to the customers for the corresponding account | The elements in the customerFieldKeys array list |
cloudAccountKeys |
Array | Specifies the list of cloud accounts (SubscriptionIDs) linked to the customer. | The elements in the cloudAccountKeys array list |
conversionRates |
Array | Consists of conversion rates which can be used to convert money values from one currency to another. Note: This field is dynamically populated by the API, but the values are not saved in the system. | The elements in the conversionRates array list |
importStatus |
Object | Specifies the details of the data import process. | The elements in the importStatus object |
Elements in the allColumns array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | Numeric value such as 123456 |
displayName |
String | The name of the column that is displayed on UI. | Availability ID |
groupable |
Boolean | Indicates whether the data in this column can be grouped in the report output. If set to true, the column can be used for grouping data rows. | Values such as True or False |
columnTamplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the selectedColumns array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | Numeric value such as 123456 |
displayName |
String | The name of the column that is displayed on UI. | Customer Name |
groupingLevel |
Integer | Indicates the hierarchical level of data grouping applied in the report. | Value 1 indicates the hierarchy is highest, followed by level 2, 3, and so on |
isInvoiceKey |
Boolean | Specifies whether the associated field serves as a key identifier for invoice generation or matching. | Values such as True or False |
valueType |
String | Indicates the data type of the value in a specific field. | Integer, String, Boolean and so on |
columnHeading |
String | The name of the column that is displayed on UI. | Customer Name |
columnTemplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the columnFilters array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | 123456. |
displayName |
String | The name of the column that is displayed on UI. | Customer Name |
columnTemplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the dateRangeOption object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
selectedRange |
Object | Indicates the reporting period of the data included in the report. It includes relative and fixed date range. | Values such as:
|
Elements in the selectedRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
relativeDateRange |
String | Specifies the dynamic period for the report. You can select a predefined date range instead of entering calendar inputs. | MONTH_TO_DATE |
relativeActualDateRange |
Object | Includes the startDate and endDate of the report. You can select the calendar inputs. | The elements in the relativeActualDateRange object |
Elements in the relativeActualDateRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the start date of the date range. | 2025-05-01T00:00:00Z |
endDate |
String | Specifies the end date of the date range. | 2025-05-14T00:00:00Z |
Elements in the currencyOption array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
availableCurrencies |
Array | Specifies the available currencies. | USD |
selectedCurrency |
Object | Indicates the selected currency. | USD |
Elements in the availableCurrencies array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the selectedCurrency object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the customerFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies a user-friendly name for custom fields. If the name is unavailable, set this as label. | AutomationField123 |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | AutomationFieldxxx. |
Elements in the cloudAccountFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies the user-friendly name for cloud account fields. If the name is unavailable, set this as label. | End_Customer_PO |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | End_Customer_xxx |
Elements in the conversionRates array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
fromCurrency |
Object | Indicates the source currency in which the original transaction is recorded. | The elements in the fromCurrency object |
toCurrency |
Object | Indicates the target currency in which fromCurrency amount has been converted to. | The elements in the toCurrency object |
rate |
Double Integer | Indicates the rate that is used to convert the value from the fromCurrency to the toCurrency. |
1 |
Elements in the fromCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | EUR |
symbol |
String | Currency symbol used for formatting the currency. | € |
name |
String | Name of the currency. | Euro |
displayOrder |
Integer | Display order for currency. | 5 |
Elements in the toCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency | $ |
name |
String | Name of the currency. | USD |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the importStatus array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
imports |
Array | Includes import details of the report. | The elements in the imports array list |
Elements in the imports array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
details |
String | Reseller Id. | MpnIDs: 123456 |
billingMonth |
String | Current month of billing. | 2025-05-01T00:00:00Z |
ranAt |
String | The time when the data is imported into the ION system. | 2025-05-14T10:13:46Z |
Get Report Data
Using the Get Report Data endpoint, you can retrieve information about the structure of the report including column definitions, currency information, date ranges, and so on. This structure includes the actual data.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/reports/{report_id}/data
Sample Request:
{
"reportId": "23582",
"displayName": "Microsoft CSP Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"specs": {
"allColumns": [
{
"id": "1470115",
"displayName": "Account Status",
"groupable": true,
"columnTemplateId": "saas_billing.account_status"
},
{
"id": "1470088",
"displayName": "Billing End Date",
"groupable": true,
"columnTemplateId": "saas_billing.billing_end_date"
},
{
"id": "1470087",
"displayName": "Billing Start Date",
"groupable": true,
"columnTemplateId": "saas_billing.billing_start_date"
},
{
"id": "1470106",
"displayName": "Billing Year Month",
"groupable": true,
"columnTemplateId": "saas_billing.billing_year_month"
},
{
"id": "1470114",
"displayName": "Charge Type",
"groupable": true,
"columnTemplateId": "saas_billing.charge_type"
},
{
"id": "1470078",
"displayName": "Cloud Account Number",
"groupable": true,
"columnTemplateId": "saas_billing.customer_account_id"
},
{
"id": "1470077",
"displayName": "Company",
"groupable": true,
"columnTemplateId": "saas_billing.unique_name"
},
{
"id": "1470107",
"displayName": "Cost Of Unit",
"groupable": true,
"columnTemplateId": "saas_billing.cost_of_unit"
},
{
"id": "1470097",
"displayName": "Currency Conversion Rates",
"groupable": true,
"columnTemplateId": "saas_billing.conversion_rates"
},
{
"id": "1470102",
"displayName": "Customer Company",
"groupable": true,
"columnTemplateId": "saas_billing.customer_company_name"
},
{
"id": "1470103",
"displayName": "Customer Company Reseller",
"groupable": true,
"columnTemplateId": "saas_billing.customer_company_name_reseller"
},
{
"id": "1470083",
"displayName": "Customer Cost",
"columnTemplateId": "saas_billing.customer_cost"
},
{
"id": "1470092",
"displayName": "Customer Cost (Invoiced Currency)",
"columnTemplateId": "saas_billing.customer_cost_invoice"
},
{
"id": "1470091",
"displayName": "Customer Cost (Provider Currency)",
"columnTemplateId": "saas_billing.customer_cost_raw"
},
{
"id": "1470089",
"displayName": "Customer Country",
"groupable": true,
"columnTemplateId": "saas_billing.customer_country"
},
{
"id": "1470112",
"displayName": "Customer External ID",
"groupable": true,
"columnTemplateId": "saas_billing.customer_external_id"
},
{
"id": "1470080",
"displayName": "Customer ID",
"groupable": true,
"columnTemplateId": "saas_billing.customer_id"
},
{
"id": "1470090",
"displayName": "Customer State",
"groupable": true,
"columnTemplateId": "saas_billing.customer_state"
},
{
"id": "1470079",
"displayName": "Description",
"groupable": true,
"columnTemplateId": "saas_billing.description"
},
{
"id": "1470109",
"displayName": "Domain Name",
"groupable": true,
"columnTemplateId": "saas_billing.domain_name"
},
{
"id": "1470099",
"displayName": "Invoice Currency",
"groupable": true,
"columnTemplateId": "saas_billing.invoice_currency"
},
{
"id": "1470084",
"displayName": "Margin",
"columnTemplateId": "saas_billing.margin"
},
{
"id": "1470096",
"displayName": "Margin (Invoiced Currency)",
"columnTemplateId": "saas_billing.margin_invoice"
},
{
"id": "1470095",
"displayName": "Margin (Provider Currency)",
"columnTemplateId": "saas_billing.margin_raw"
},
{
"id": "1470105",
"displayName": "Offer ID",
"groupable": true,
"columnTemplateId": "saas_billing.part_number"
},
{
"id": "1470116",
"displayName": "Payer Account ID",
"groupable": true,
"columnTemplateId": "saas_billing.payer_account_id"
},
{
"id": "1470104",
"displayName": "Period Quantity",
"groupable": true,
"columnTemplateId": "saas_billing.period_quantity"
},
{
"id": "1470101",
"displayName": "Price Book",
"groupable": true,
"columnTemplateId": "saas_billing.price_book"
},
{
"id": "1470100",
"displayName": "Price Book ID",
"groupable": true,
"columnTemplateId": "saas_billing.price_book_id"
},
{
"id": "1470076",
"displayName": "Provider",
"groupable": true,
"columnTemplateId": "saas_billing.provider"
},
{
"id": "1470098",
"displayName": "Provider Currency",
"groupable": true,
"columnTemplateId": "saas_billing.provider_currency"
},
{
"id": "1470086",
"displayName": "Provider ID",
"groupable": true,
"columnTemplateId": "saas_billing.provider_id"
},
{
"id": "1470110",
"displayName": "Reseller External ID",
"groupable": true,
"columnTemplateId": "saas_billing.reseller_external_id"
},
{
"id": "1470111",
"displayName": "Reseller External Name",
"groupable": true,
"columnTemplateId": "saas_billing.reseller_external_name"
},
{
"id": "1470081",
"displayName": "Reseller ID",
"groupable": true,
"columnTemplateId": "saas_billing.reseller_id"
},
{
"id": "1470108",
"displayName": "Sales Price Of Unit",
"groupable": true,
"columnTemplateId": "saas_billing.sales_price_of_unit"
},
{
"id": "1470113",
"displayName": "Seat Count",
"groupable": true,
"columnTemplateId": "saas_billing.seat_count"
},
{
"id": "1470082",
"displayName": "Seller Cost",
"columnTemplateId": "saas_billing.seller_cost"
},
{
"id": "1470094",
"displayName": "Seller Cost (Invoiced Currency)",
"columnTemplateId": "saas_billing.seller_cost_invoice"
},
{
"id": "1470093",
"displayName": "Seller Cost (Provider Currency)",
"columnTemplateId": "saas_billing.seller_cost_raw"
},
{
"id": "1470085",
"displayName": "Usage Quantity",
"columnTemplateId": "saas_billing.usage_quantity"
}
],
"dateRangeOption": {
"selectedRange": {
"relativeDateRange": "MONTH_TO_DATE",
"relativeActualDateRange": {
"startDate": "2024-07-01T00:00:00Z",
"endDate": "2024-07-11T00:00:00Z"
}
}
},
"currencyOption": {
"availableCurrencies": [
{
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
{
"code": "AUD",
"symbol": "$",
"name": "Australian Dollar",
"displayOrder": 2
},
{
"code": "CAD",
"symbol": "$",
"name": "Canadian Dollar",
"displayOrder": 4
},
{
"code": "CHF",
"symbol": "CHF",
"name": "Swiss Franc",
"displayOrder": 9
},
{
"code": "SGD",
"symbol": "$",
"name": "Singapore Dollar",
"displayOrder": 11
},
{
"code": "MYR",
"symbol": "MYR",
"name": "Malaysian Ringgits",
"displayOrder": 21
},
{
"code": "ALL",
"symbol": "Lek",
"name": "Albanian Lek",
"displayOrder": 34
},
{
"code": "AMD",
"symbol": "֏",
"name": "Armenian dram",
"displayOrder": 44
}
],
"selectedCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
}
},
"customerFieldKeys": [
{
"displayName": "AutomationField123",
"uniqueKey": "AutomationTest070520240307"
},
{
"displayName": "Automation_TestCustomField",
"uniqueKey": "Test_Fields_0506020327_Edited"
},
{
"displayName": "DefectValidation",
"uniqueKey": "DefectValidation"
}
],
"cloudAccountFieldKeys": [
{
"displayName": "End_Customer_PO",
"uniqueKey": "End_Customer_PO"
},
{
"displayName": "Reseller_PO",
"uniqueKey": "Reseller_PO"
}
],
"conversionRates": [
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "ALL",
"symbol": "Lek",
"name": "Albanian Lek",
"displayOrder": 34
},
"rate": 101.937980952766
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "AMD",
"symbol": "֏",
"name": "Armenian dram",
"displayOrder": 44
},
"rate": 522.682440314502
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "AUD",
"symbol": "$",
"name": "Australian Dollar",
"displayOrder": 2
},
"rate": 1.290283697449
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "CAD",
"symbol": "$",
"name": "Canadian Dollar",
"displayOrder": 4
},
"rate": 1.269300676828
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "CHF",
"symbol": "CHF",
"name": "Swiss Franc",
"displayOrder": 9
},
"rate": 0.890242412315
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "MYR",
"symbol": "MYR",
"name": "Malaysian Ringgits",
"displayOrder": 21
},
"rate": 4.041399936005
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "SGD",
"symbol": "$",
"name": "Singapore Dollar",
"displayOrder": 11
},
"rate": 1.324824808439
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"rate": 1,
"isDefault": true
}
]
},
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"12",
"14",
"34",
"28",
"33",
"36"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
}
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | Reseller ID in Cloud Commerce Platform. | 1234 | Yes |
report_Id |
String | Report ID. | 56789 | Yes |
Request Parameters Description
| Parameter | Data Type | Description | Example |
|---|---|---|---|
reportId |
String | The report ID. | Numeric value such as 1234 |
displayName |
String | The name of the report that is displayed on the UI. | AWS billing report |
category |
String | Specifies the type of report and helps to organize reports in the UI. | Billing_Reports |
createdBy |
String | Specifies the author of the report. | System |
lastUpdatedBy |
String | Specifies the latest editor of the report. | System |
specs |
Object | Report setting that the user specifies. | The elements in the specs object |
createTime |
String | The time when the report is created, in YYYY-MM-DD HH:Min format. | 0001-01-01T00:00:00Z |
providerIds |
Array | The cloud provider ID. | 30 |
reportTemplateId |
String | An identifier for a specific report layout. | Azure_Plan_Billing |
reportModule |
String | The modules that use the reports service. | Values such as
|
Elements in the specs object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
allColumns |
Array | All available columns for this report. | The elements in the allColumns array list |
dateRangeOption |
Object | The available and selected date ranges for the report. | The elements in the dateRangeOption object |
currencyOption |
Object | The available and selected currencies for the report. | The elements in the currencyOption object |
customerFieldKeys |
Array | Specifies the list of available custom fields linked to the customers for the corresponding account | The elements in the customerFieldKeys array list |
cloudAccountKeys |
Array | Specifies the list of cloud accounts (SubscriptionIDs) linked to the customer. | The elements in the cloudAccountKeys array list |
conversionRates |
Array | Consists of conversion rates which can be used to convert money values from one currency to another. Note: This field is dynamically populated by the API, but the values are not saved in the system. | The elements in the conversionRates array list |
Elements in the allColumns array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | Numeric value such as 123456 |
displayName |
String | The name of the column that is displayed on UI. | Availability ID |
groupable |
Boolean | Indicates whether the data in this column can be grouped in the report output. If set to true, the column can be used for grouping data rows. | Values such as True or False |
columnTamplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the dateRangeOption object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
selectedRange |
Object | Indicates the reporting period of the data included in the report. It includes relative and fixed date range. | Values such as:
|
Elements in the selectedRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
relativeDateRange |
String | Specifies the dynamic period for the report. You can select a predefined date range instead of entering calendar inputs. | MONTH_TO_DATE |
relativeActualDateRange |
Object | Includes the startDate and endDate of the report. You can select the calendar inputs. | The elements in the relativeActualDateRange object |
Elements in the relativeActualDateRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the start date of the date range. | 2025-05-01T00:00:00Z |
endDate |
String | Specifies the end date of the date range. | 2025-05-14T00:00:00Z |
Elements in the currencyOption array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
availableCurrencies |
Array | Specifies the available currencies. | USD |
selectedCurrency |
Object | Indicates the selected currency. | USD |
Elements in the availableCurrencies array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the selectedCurrency object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the customerFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies a user-friendly name for custom fields. If the name is unavailable, set this as label. | AutomationField123 |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | AutomationFieldxxx. |
Elements in the cloudAccountFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies the user-friendly name for cloud account fields. If the name is unavailable, set this as label. | End_Customer_PO |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | End_Customer_xxx |
Elements in the conversionRates array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
fromCurrency |
Object | Indicates the source currency in which the original transaction is recorded. | The elements in the fromCurrency object |
toCurrency |
Object | Indicates the target currency in which fromCurrency amount has been converted to. | The elements in the toCurrency object |
rate |
Double Integer | Indicates the rate that is used to convert the value from the fromCurrency to the toCurrency. |
1 |
Elements in the fromCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | EUR |
symbol |
String | Currency symbol used for formatting the currency. | € |
name |
String | Name of the currency. | Euro |
displayOrder |
Integer | Display order for currency. | 5 |
Elements in the toCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency | $ |
name |
String | Name of the currency. | USD |
displayOrder |
Integer | Display order for currency. | 1 |
Sample Response
{
"report": {
"reportId": "23582",
"displayName": "Microsoft CSP Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"specs": {
"allColumns": [
{
"id": "116712",
"displayName": "Availability ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.availability_id"
},
{
"id": "116708",
"displayName": "Azure Customer Country",
"groupable": true,
"columnTemplateId": "azure_plan_billing.azure_customer_country"
},
{
"id": "116709",
"displayName": "Azure Customer ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.azure_customer_id"
},
{
"id": "153151",
"displayName": "Billing Cycle",
"groupable": true,
"columnTemplateId": "azure_plan_billing.term_and_billingcycle"
},
{
"id": "158760",
"displayName": "Billing Frequency",
"groupable": true,
"columnTemplateId": "azure_plan_billing.billing_frequency"
},
{
"id": "153150",
"displayName": "Charge EndDate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.usage_endtime"
},
{
"id": "153149",
"displayName": "Charge StartDate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.usage_starttime"
},
{
"id": "116718",
"displayName": "Charge Type",
"groupable": true,
"columnTemplateId": "azure_plan_billing.charge_type"
},
{
"id": "1412002",
"displayName": "Charge or Savings Plan",
"groupable": true,
"columnTemplateId": "azure_plan_billing.benefit_type"
},
{
"id": "116694",
"displayName": "Cloud Account Name",
"groupable": true,
"columnTemplateId": "azure_plan_billing.cloud_account_name"
},
{
"id": "116704",
"displayName": "Currency Conversion Rates",
"groupable": true,
"columnTemplateId": "azure_plan_billing.conversion_rates"
},
{
"id": "116676",
"displayName": "Customer Company",
"groupable": true,
"columnTemplateId": "azure_plan_billing.customer_company_name"
},
{
"id": "1434946",
"displayName": "Customer Company Reseller",
"groupable": true,
"columnTemplateId": "azure_plan_billing.customer_company_name_reseller"
},
{
"id": "116684",
"displayName": "Customer Cost",
"columnTemplateId": "azure_plan_billing.customer_cost"
},
{
"id": "116699",
"displayName": "Customer Cost (Invoiced Currency)",
"columnTemplateId": "azure_plan_billing.customer_cost_invoice"
},
{
"id": "116698",
"displayName": "Customer Cost (Provider Currency)",
"columnTemplateId": "azure_plan_billing.customer_cost_raw"
},
{
"id": "116696",
"displayName": "Customer Country",
"groupable": true,
"columnTemplateId": "azure_plan_billing.customer_country"
},
{
"id": "116674",
"displayName": "Customer ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.customer_id"
},
{
"id": "116675",
"displayName": "Customer Name",
"groupable": true,
"columnTemplateId": "azure_plan_billing.unique_name"
},
{
"id": "116697",
"displayName": "Customer State",
"groupable": true,
"columnTemplateId": "azure_plan_billing.customer_state"
},
{
"id": "122070",
"displayName": "Discount Rate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.discount_rate"
},
{
"id": "148041",
"displayName": "Domain Name",
"groupable": true,
"columnTemplateId": "azure_plan_billing.domain_name"
},
{
"id": "1422786",
"displayName": "Effective Unit Price",
"groupable": true,
"columnTemplateId": "azure_plan_billing.effective_unit_price"
},
{
"id": "1035708",
"displayName": "Entitlement Description",
"groupable": true,
"columnTemplateId": "azure_plan_billing.entitlement_description"
},
{
"id": "122069",
"displayName": "EntitlementID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.entitlement_id"
},
{
"id": "116671",
"displayName": "Group Tag ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.group_tag_id"
},
{
"id": "116672",
"displayName": "Group Tag Label",
"groupable": true,
"columnTemplateId": "azure_plan_billing.group_tag_label"
},
{
"id": "116706",
"displayName": "Invoice Currency",
"groupable": true,
"columnTemplateId": "azure_plan_billing.invoice_currency"
},
{
"id": "116707",
"displayName": "Invoice Number",
"groupable": true,
"columnTemplateId": "azure_plan_billing.invoice_number"
},
{
"id": "116713",
"displayName": "MPN ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.mpn_id"
},
{
"id": "1430286",
"displayName": "MSRP",
"columnTemplateId": "azure_plan_billing.msrp_cost"
},
{
"id": "116685",
"displayName": "Margin",
"columnTemplateId": "azure_plan_billing.margin"
},
{
"id": "116703",
"displayName": "Margin (Invoiced Currency)",
"columnTemplateId": "azure_plan_billing.margin_invoice"
},
{
"id": "116702",
"displayName": "Margin (Provider Currency)",
"columnTemplateId": "azure_plan_billing.margin_raw"
},
{
"id": "116682",
"displayName": "Meter Category",
"groupable": true,
"columnTemplateId": "azure_plan_billing.meter_category"
},
{
"id": "116691",
"displayName": "Meter ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.meter_id"
},
{
"id": "116681",
"displayName": "Meter Name",
"groupable": true,
"columnTemplateId": "azure_plan_billing.meter_name"
},
{
"id": "116687",
"displayName": "Meter Sub Category",
"groupable": true,
"columnTemplateId": "azure_plan_billing.meter_sub_category"
},
{
"id": "116690",
"displayName": "Metered Region",
"groupable": true,
"columnTemplateId": "azure_plan_billing.metered_region"
},
{
"id": "1487669",
"displayName": "Mfg Part Number",
"groupable": true,
"columnTemplateId": "azure_plan_billing.mfg_part_number"
},
{
"id": "153152",
"displayName": "Order Date",
"groupable": true,
"columnTemplateId": "azure_plan_billing.order_date"
},
{
"id": "1035707",
"displayName": "Order Number",
"groupable": true,
"columnTemplateId": "azure_plan_billing.order_number"
},
{
"id": "1508207",
"displayName": "Override Effective Date",
"groupable": true,
"columnTemplateId": "azure_plan_billing.override_effective_date"
},
{
"id": "1508208",
"displayName": "Override End Date",
"groupable": true,
"columnTemplateId": "azure_plan_billing.override_end_date"
},
{
"id": "469068",
"displayName": "PAC of Origin",
"groupable": true,
"columnTemplateId": "azure_plan_billing.pac_of_origin"
},
{
"id": "150431",
"displayName": "Period Quantity",
"groupable": true,
"columnTemplateId": "azure_plan_billing.period_quantity"
},
{
"id": "1499875",
"displayName": "Price Change",
"groupable": true,
"columnTemplateId": "azure_plan_billing.price_change"
},
{
"id": "1499876",
"displayName": "Price Change Value",
"groupable": true,
"columnTemplateId": "azure_plan_billing.price_change_value"
},
{
"id": "116677",
"displayName": "Price book",
"groupable": true,
"columnTemplateId": "azure_plan_billing.price_book"
},
{
"id": "116678",
"displayName": "Price book ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.price_book_id"
},
{
"id": "116710",
"displayName": "Product ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.product_id"
},
{
"id": "116715",
"displayName": "Product Name",
"groupable": true,
"columnTemplateId": "azure_plan_billing.product_name"
},
{
"id": "158759",
"displayName": "Promotion EndDate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.promotion_enddate"
},
{
"id": "152096",
"displayName": "Promotion Rate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.promotion_rate"
},
{
"id": "158758",
"displayName": "Promotion StartDate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.promotion_startdate"
},
{
"id": "152095",
"displayName": "PromotionID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.promotion_id"
},
{
"id": "116705",
"displayName": "Provider Currency",
"groupable": true,
"columnTemplateId": "azure_plan_billing.provider_currency"
},
{
"id": "121566",
"displayName": "Publisher ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.publisher_id"
},
{
"id": "121565",
"displayName": "Publisher Name",
"groupable": true,
"columnTemplateId": "azure_plan_billing.publisher_name"
},
{
"id": "1415206",
"displayName": "Rate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.rate"
},
{
"id": "116689",
"displayName": "Region",
"groupable": true,
"columnTemplateId": "azure_plan_billing.region"
},
{
"id": "116670",
"displayName": "Reseller ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.reseller_id"
},
{
"id": "116714",
"displayName": "Reseller MPN ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.reseller_mpn_id"
},
{
"id": "116673",
"displayName": "Reseller Name",
"groupable": true,
"columnTemplateId": "azure_plan_billing.reseller_name"
},
{
"id": "147735",
"displayName": "Reservation Order ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.reservation_order_id"
},
{
"id": "116680",
"displayName": "Resource Group",
"groupable": true,
"columnTemplateId": "azure_plan_billing.resource_group"
},
{
"id": "116692",
"displayName": "Resource URI",
"groupable": true,
"columnTemplateId": "azure_plan_billing.resource_uri"
},
{
"id": "116711",
"displayName": "SKU ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.sku_id"
},
{
"id": "116716",
"displayName": "SKU Name",
"groupable": true,
"columnTemplateId": "azure_plan_billing.sku_name"
},
{
"id": "1412001",
"displayName": "Savings Plan ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.benefit_id"
},
{
"id": "1412000",
"displayName": "Savings Plan Order ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.benefit_order_id"
},
{
"id": "950384",
"displayName": "Seat Count",
"groupable": true,
"columnTemplateId": "azure_plan_billing.seat_count"
},
{
"id": "897807",
"displayName": "Segment",
"groupable": true,
"columnTemplateId": "azure_plan_billing.segment"
},
{
"id": "116683",
"displayName": "Seller Cost",
"columnTemplateId": "azure_plan_billing.seller_cost"
},
{
"id": "116701",
"displayName": "Seller Cost (Invoiced Currency)",
"columnTemplateId": "azure_plan_billing.seller_cost_invoice"
},
{
"id": "116700",
"displayName": "Seller Cost (Provider Currency)",
"columnTemplateId": "azure_plan_billing.seller_cost_raw"
},
{
"id": "153148",
"displayName": "Subscription EndDate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.subscription_enddate"
},
{
"id": "116679",
"displayName": "Subscription ID",
"groupable": true,
"columnTemplateId": "azure_plan_billing.cloud_account_number"
},
{
"id": "153147",
"displayName": "Subscription StartDate",
"groupable": true,
"columnTemplateId": "azure_plan_billing.subscription_startdate"
},
{
"id": "116717",
"displayName": "Term And Billing Cycle",
"groupable": true,
"columnTemplateId": "azure_plan_billing.term_and_billing_cycle"
},
{
"id": "116695",
"displayName": "Type",
"groupable": true,
"columnTemplateId": "azure_plan_billing.type"
},
{
"id": "116688",
"displayName": "Unit",
"groupable": true,
"columnTemplateId": "azure_plan_billing.unit"
},
{
"id": "1415205",
"displayName": "Unit Price",
"groupable": true,
"columnTemplateId": "azure_plan_billing.unit_price"
},
{
"id": "116686",
"displayName": "Usage Quantity",
"columnTemplateId": "azure_plan_billing.usage"
},
{
"id": "121564",
"displayName": "Usage Type",
"groupable": true,
"columnTemplateId": "azure_plan_billing.usage_type"
}
],
"selectedColumns": [
{
"id": "116675",
"displayName": "Customer Name",
"groupingLevel": 1,
"isInvoiceKey": true,
"valueType": "STRING",
"columnHeading": "Customer Name",
"columnTemplateId": "azure_plan_billing.unique_name"
},
{
"id": "121565",
"displayName": "Publisher Name",
"groupingLevel": 2,
"valueType": "STRING",
"columnHeading": "Publisher Name",
"columnTemplateId": "azure_plan_billing.publisher_name"
},
{
"id": "116694",
"displayName": "Cloud Account Name",
"groupingLevel": 3,
"valueType": "STRING",
"columnHeading": "Cloud Account Name",
"columnTemplateId": "azure_plan_billing.cloud_account_name"
},
{
"id": "116715",
"displayName": "Product Name",
"groupingLevel": 4,
"valueType": "STRING",
"columnHeading": "Product Name",
"columnTemplateId": "azure_plan_billing.product_name"
},
{
"id": "116716",
"displayName": "SKU Name",
"groupingLevel": 5,
"valueType": "STRING",
"columnHeading": "SKU Name",
"columnTemplateId": "azure_plan_billing.sku_name"
},
{
"id": "116717",
"displayName": "Term And Billing Cycle",
"groupingLevel": 6,
"valueType": "STRING",
"columnHeading": "Term And Billing Cycle",
"columnTemplateId": "azure_plan_billing.term_and_billing_cycle"
},
{
"id": "116677",
"displayName": "Price book",
"valueType": "STRING",
"columnHeading": "Price book",
"columnTemplateId": "azure_plan_billing.price_book"
},
{
"id": "116683",
"displayName": "Seller Cost",
"aggType": "SUM_COLUMN_AGGREGATION_TYPE",
"valueType": "MONEY",
"columnHeading": "Seller Cost (USD)",
"columnTemplateId": "azure_plan_billing.seller_cost"
},
{
"id": "116684",
"displayName": "Customer Cost",
"aggType": "SUM_COLUMN_AGGREGATION_TYPE",
"valueType": "MONEY",
"columnHeading": "Customer Cost (USD)",
"columnTemplateId": "azure_plan_billing.customer_cost"
},
{
"id": "116685",
"displayName": "Margin",
"aggType": "SUM_COLUMN_AGGREGATION_TYPE",
"valueType": "MONEY",
"columnHeading": "Margin (USD)",
"columnTemplateId": "azure_plan_billing.margin"
},
{
"id": "116686",
"displayName": "Usage Quantity",
"aggType": "SUM_COLUMN_AGGREGATION_TYPE",
"valueType": "FLOAT",
"columnHeading": "Usage Quantity",
"columnTemplateId": "azure_plan_billing.usage"
},
{
"id": "116688",
"displayName": "Unit",
"valueType": "STRING",
"columnHeading": "Unit",
"columnTemplateId": "azure_plan_billing.unit"
},
{
"id": "116689",
"displayName": "Region",
"valueType": "STRING",
"columnHeading": "Region",
"columnTemplateId": "azure_plan_billing.region"
},
{
"id": "950384",
"displayName": "Seat Count",
"valueType": "FLOAT",
"columnHeading": "Seat Count",
"columnTemplateId": "azure_plan_billing.seat_count"
}
],
"columnFilters": [
{
"id": "116675",
"displayName": "Customer Name",
"allValues": [
{
"displayValue": {
"valueType": "STRING",
"stringValue": "05 PM Bittitan WLMP (Pravin M)"
},
"valueId": "C-71093"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "16Aprcust1 (16Aprcust1)"
},
"valueId": "C-68852"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Apptium (Reston Office)"
},
"valueId": "C-71298"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "aptest (aptest)"
},
"valueId": "C-86423"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "AutoTest202502805 (maria white)"
},
"valueId": "C-94748"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "AutoTest20252805 (maria white)"
},
"valueId": "C-94738"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "BA_US_31July (BA_US_31July)"
},
"valueId": "C-81358"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "BA_USU1_02Aug (BA_USU1_02Aug)"
},
"valueId": "C-81540"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "BA_USU1_1Aug (BA_USU1_1Aug)"
},
"valueId": "C-81464"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Blue Company (Jim Blue)"
},
"valueId": "C-81583"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Datepicker Dec1 (Datepicker Dec1)"
},
"valueId": "C-87235"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Datepicker Dec31 (Datepicker Dec31)"
},
"valueId": "C-88733"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Datepicker Jan (Datepicker jan)"
},
"valueId": "C-88783"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Datepicker Jan2 (Datepicker Jan2)"
},
"valueId": "C-88782"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Datepicker Jan6 (Datepicker Jan6)"
},
"valueId": "C-88959"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Datepickerjan (Datepickerjan)"
},
"valueId": "C-88789"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "DoNotUseThisCustomer2 (TestQA TESTQA)"
},
"valueId": "C-67949"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "DP nce promo 4 (DP nce promo 4)"
},
"valueId": "C-92645"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "dp_25 (DP)"
},
"valueId": "C-86932"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Jancust1 (Jancust1)"
},
"valueId": "C-88792"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "MM TestCust02Jan25 (Mayur More)"
},
"valueId": "C-88796"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "MM TestCust30jan (Mayur More)"
},
"valueId": "C-90020"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "NCECustomer (Jaya c)"
},
"valueId": "C-87246"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "NCEPromo Jan13_2 (NCEPromo Jan13_2)"
},
"valueId": "C-89391"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "nsdatepicker3 (nsdatepicker3)"
},
"valueId": "C-87047"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Prath Tricust1 (Prath Tricust1)"
},
"valueId": "C-71623"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "PSAAT3 (Sindhu11)"
},
"valueId": "C-67375"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA01065654Org (AutomationCustomer0322052543)"
},
"valueId": "C-94830"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA02010824Org (AutomationCustomer0322052543)"
},
"valueId": "C-88776"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA02014043Org (Maria White)"
},
"valueId": "C-88780"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA02061630Org (Maria White)"
},
"valueId": "C-94868"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA02065817Org (Maria White)"
},
"valueId": "C-94872"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA02120938Org (Maria White)"
},
"valueId": "C-87211"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA03034020Org (Maria White)"
},
"valueId": "C-91167"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA03063416Org (Maria White)"
},
"valueId": "C-94913"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA03065422Org (Maria White)"
},
"valueId": "C-94914"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA05112307Org (Maria White)"
},
"valueId": "C-86152"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA06113019Org (Maria White)"
},
"valueId": "C-86193"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA06113654Org (Maria White)"
},
"valueId": "C-86214"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA07110943Org (Maria White)"
},
"valueId": "C-86240"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA1002104022Org (Maria White)"
},
"valueId": "C-84802"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA14040512Org (Maria White)"
},
"valueId": "C-93020"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA16120536Org (Maria White)"
},
"valueId": "C-88270"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA16124725Org (Maria White)"
},
"valueId": "C-88218"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA20044723Org (Maria White)"
},
"valueId": "C-93328"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA20052538Org (Maria White)"
},
"valueId": "C-94455"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA22044536Org (Maria White)"
},
"valueId": "C-93394"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA25114649Org (Maria White)"
},
"valueId": "C-86926"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA28054321Org (Maria White)"
},
"valueId": "C-94740"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA31031723Org (Maria White)"
},
"valueId": "C-92453"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "QA31033632Org (Maria White)"
},
"valueId": "C-92473"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Reg_MSFT_Prabha (Prabha)"
},
"valueId": "C-71482"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "sal Ops (Sal uat)"
},
"valueId": "C-81324"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Sravan_All Providers_New (Apptium)"
},
"valueId": "C-68879"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Sri Latha (SriL)"
},
"valueId": "C-83177"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "YP 01 July PO Test (YP 01 July PO Test)"
},
"valueId": "C-81470"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "YP 02 Jan 25 (YP 02 Jan 25)"
},
"valueId": "C-88797"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "YP Avepoint 07 May 01 (YP Avepoint 07 May 01)"
},
"valueId": "C-93928"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "YP NC Promo 27 Feb 02 25 (YP NC Promo 27 Feb 02 25)"
},
"valueId": "C-90914"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "YP Quote Defect test 01 (YP Quote Defect test 01)"
},
"valueId": "C-87340"
}
],
"columnTemplateId": "azure_plan_billing.unique_name"
},
{
"id": "121565",
"displayName": "Publisher Name",
"allValues": [
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Microsoft"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
}
}
],
"columnTemplateId": "azure_plan_billing.publisher_name"
},
{
"id": "116694",
"displayName": "Cloud Account Name",
"allValues": [
{
"displayValue": {
"valueType": "STRING",
"stringValue": "01621321-a7a5-4219-d28a-d865b7d35762"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "01634a2a-d132-4f9a-d56a-f4f006316ce1"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "03c32942-6a5c-4b9b-ddbc-faeb4cbec096"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "0842d780-9800-40b1-cf39-e2ce3980a60f"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "08834d50-f0ff-4ef6-c9a1-2fb8ef696002"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "08fbee87-1925-4647-d0d4-556a32b8fa8a"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "09460f52-2a9f-472d-d80c-41422bb668ef"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "0bdf4f71-d390-40ea-d0db-3a8c578ef196"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "0f9006ee-8d81-4093-c14e-ffcf1168224d"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "0fad1639-28a1-4524-de05-49d0bbea6d6e"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "120e729e-fb69-45ca-d3bb-8e8aecc04ed1"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "1815ead1-31f4-4fd9-d2cb-d2a71dc2f3b9"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "18cb0876-7025-45ed-cef7-c23c9444b501"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "1b599714-348d-43cd-c5c2-5fbd22c8ca9b"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "1bba7c78-758b-4516-d22b-557dcd50bab4"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "1cef0d8d-728d-424c-c1b9-56faadb26478"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "1eb5d68e-23db-4701-c2bb-6f1910b60281"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "2040fd6d-1d19-4347-dbeb-4360bf563bd0"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "226006aa-febd-4591-ca27-27124283c5ef"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "267cd77d-6c3d-4437-c8b0-0d8d52a2977a"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "27711d87-164b-477c-cd7b-e1b1dba745e5"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "2bd26b5e-224b-4d00-c1f8-b861f9f2e872"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "2d5852d4-5a27-415a-d582-84a2276fb02a"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "2dd5c0bd-dc9c-43c9-d79f-572181cada53"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "302c81dd-0bd1-4e8a-c875-283f65cc4849"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "3341a730-c1cd-44c1-d4eb-022b2f3a5e3b"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "3402317f-dde2-4244-c829-2c3585aa33b3"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "34157f92-de01-403e-daff-ecb863b2d147"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "357a1fdd-d97c-4f8a-d045-b6d37d5b74fc"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "3a46b3df-4272-4f0d-c6c9-6c74699b673e"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "3e066112-e70a-4bfd-dbef-8c6625095a1a"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "3fde2211-e785-48c0-c6bc-783276c2cee2"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "46ea12bd-ba8c-441b-cd35-8662a7a04190"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "47242756-a952-4bff-c094-ac15ad1cf0e1"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "47f14e6e-a76e-4706-cf92-069149ca2459"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "486d43ce-ecd4-4b69-c008-99558e7d3ba8"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "4bf36c0f-2a88-4ad9-cb7a-8db321545724"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "4c798840-62eb-4555-d34b-03f82495eaa5"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "4cd797c7-d5f1-4d9b-c3f1-11282b373fe9"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "51f27b93-d089-447b-d992-ad58e0c44950"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "54e39bbc-a0fb-4e92-ce72-ae29b3f8a7b6"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "58f1569e-d58b-4325-d7cc-658ff92501bf"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "58fc4a90-eadf-4db5-c298-a63cd74e6075"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "596e0a63-46e8-4585-dc12-c0a42dc6c826"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "5caa4cb4-44fe-462f-c72e-b40ab7d405ec"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "5ce10064-7008-41ef-d953-84c57b1afcec"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "5fde2dc1-a823-4c59-d001-5c60e856f9ff"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "6129cdcd-28b8-4d0b-d6d0-2dddef6d396d"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "625a57ef-7ea0-4a11-c7af-3bc4445c2e39"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "64ee2c66-d24c-43ac-caa3-954e5ce1f874"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "663342c6-72ff-4722-d01c-51cf47fa9870"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "6633c9cb-0044-4cea-c225-33df5d33ae64"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "67c97ffc-22fd-43ce-d97c-a6cef75e854a"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "6e2e148d-07a7-4234-d970-edb1524950db"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "716b0505-3442-4f5c-ccc8-4e12c1c15fb3"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "73ce99be-f876-4f79-d76e-dde94b3f9c7a"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "74d876f3-c105-4ca1-d341-45b178c6a0c7"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "78f74254-72ba-4be6-c9c3-521c63b89f88"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "7b20ebe6-8568-4511-dd8e-08535ae6bba4"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "7e348cf4-9a4f-42ab-c0e0-ef3a42c6ba76"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "80046765-c4d3-424b-c917-1c43e7467e5e"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "81d2f8d6-f345-4cee-cf44-4fcffebd03a8"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "823aebc3-6114-4fc4-c6b0-87a33e6d5a80"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "8294d334-9d2b-458b-cf57-26d32b2ab8ab"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "851920bc-44c1-4175-d268-e85df52d208e"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "86d919b9-ccf8-4c0a-d997-84091fe9f5b6"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "8b1a70ec-cd15-4100-c2da-88ed6d824d2f"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "8b1ba91e-4213-419e-cc70-b4d3d0e86cfb"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "8d56aaf5-eddc-4448-d042-114f79760299"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "8d5efd4f-dff7-4ad1-c48b-4e38bd94c824"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "97773081-b061-4d49-c1ce-c763c20b1dcd"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "9d1fc3b4-d9b6-4d46-ced2-057aba573b26"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "9feb391a-4cbd-4494-d333-1f4042661c52"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "a8d7f259-4e76-4ca7-dc9a-988c1cb764a2"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "b0380674-991b-4e29-d218-8ca92a0d91a0"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "b0c4acd6-2c60-4689-d346-9a2431c30b8f"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "b2b90d4f-98c3-4f98-cfaf-e8a0884b25af"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "b548a5e3-2bb9-4e2a-d879-ff26f5bc6dd2"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "b594d0f6-18f7-4eee-d1f9-12f3f03c04b1"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "b901c784-dc0f-4f6b-ca53-2e607958f7ad"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "bcbf41ad-dbc2-43ad-de66-557f77a5cf1b"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "bd0e815b-630e-4e6d-df3c-c82b0b844281"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "c2f0776b-0fec-434b-c2a9-23323ad233a0"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "c401f817-103d-4800-ce65-76b04d272f71"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "c84991d4-c2b3-42bf-cbe2-d96378a376bb"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "cab643fe-7040-496d-dd71-ab6281accb01"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "cddec4b8-3c2d-4ecf-cfbc-88d6b82925b8"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "cef80422-ce18-4594-db40-ae4b548722d0"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "cf95e35c-7b34-4453-cfe2-ce6171afc812"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "d48dd29b-4c9d-46ad-df7d-3af1c92f725c"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "d8b7ead4-949e-4434-d6fb-1c056d2cc0ec"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "d9522147-af54-4042-caaf-dd985780beef"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "dd503c12-3017-4a32-d2a9-694d277b00b6"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "e0251eb1-0506-476c-c87d-44b15c687e79"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "e853854d-0c1f-45e0-c027-03ed5e844965"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "e9c7e193-7041-4052-c412-85f4f322479d"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "ec6962d0-b73b-4ae2-dbf6-8e3bc1a6fd58"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "ed4345f0-f7ca-4cfe-db6b-c62939357172"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "ef3666d1-447e-4218-db4b-7241d5c07374"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "ef82b05b-25a2-4a39-d93d-01f2c445b614"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "efd6914b-3509-47ed-d7c7-c74efdf400d0"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f0b35eb4-17ad-48ef-d9c5-5cd60c8e43df"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f24499dc-9cd8-4e80-cb56-1ed9c8372096"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f355b209-a9a6-41d9-d963-758906ce246e"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f3e18dce-acc4-41ef-d351-0f8d25ee656a"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f4f9c523-16ed-4dec-d86d-2eb6ba9d9d5c"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f53a5ef8-22c7-489f-d90d-7ba74ea12507"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f884076c-3970-47eb-d74f-1d506e3ac19a"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f8925a61-3213-4f7f-cd0c-653286944e30"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "f9088104-9c18-43a1-d17b-67427c369bcd"
}
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "fa0bf8ae-06c5-47b1-d3d3-1b9981baab83"
}
}
],
"columnTemplateId": "azure_plan_billing.cloud_account_name"
},
{
"id": "116677",
"displayName": "Price book",
"allValues": [
{
"displayValue": {
"valueType": "STRING",
"stringValue": "aa"
},
"valueId": "16362"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "ABCD"
},
"valueId": "19389"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "AP_Test_1604"
},
"valueId": "21085"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "check PB"
},
"valueId": "17149"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "copy1"
},
"valueId": "17760"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "copy2"
},
"valueId": "17761"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "CSP - [Azure -15%, RI 0%, NCE +0%, SS +0%, PS +0%]"
},
"valueId": "19265"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Decimal"
},
"valueId": "18153"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Deepanjali_triennial_reseller"
},
"valueId": "16250"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Deep_tri_PB2"
},
"valueId": "16327"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Deep_tri_PB3"
},
"valueId": "16328"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Deep_tri_PB4"
},
"valueId": "16329"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "DonotdeleteAutoPricebook"
},
"valueId": "17877"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
"valueId": "20901"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Endcustomer 10%"
},
"valueId": "17017"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Eric Test pricebook"
},
"valueId": "19456"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Febpb 10%"
},
"valueId": "19845"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "GT MS_CSP PB"
},
"valueId": "16953"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "INSIGHT"
},
"valueId": "19074"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "INSIGHT JAN"
},
"valueId": "19075"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "KS PB10Feb2%"
},
"valueId": "19847"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "KSPromoPB01 %4"
},
"valueId": "19065"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Microsoft 365"
},
"valueId": "17034"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Microsoft CSP_vivek"
},
"valueId": "16949"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "MM Admin PB 5%"
},
"valueId": "17071"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "MM PB28jan 4%"
},
"valueId": "19488"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "MM pricebook 7"
},
"valueId": "17073"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "MM_BB_0416"
},
"valueId": "21086"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "MS CSP_Sagar"
},
"valueId": "16955"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "MS_MM_BB"
},
"valueId": "20847"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "ns triennial"
},
"valueId": "16272"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "NS_CHECKREPORT"
},
"valueId": "18319"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "NS_PSA_3"
},
"valueId": "15377"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Price override"
},
"valueId": "18323"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "ProcessCheck_12Jun"
},
"valueId": "16307"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "qa12"
},
"valueId": "15949"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "qa12"
},
"valueId": "15950"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "regression_2%"
},
"valueId": "19536"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "reseller+10%"
},
"valueId": "18699"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Sagar 20%"
},
"valueId": "17063"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Sagar 25%"
},
"valueId": "17064"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Sagar10%"
},
"valueId": "17065"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "SDS US -5%"
},
"valueId": "17106"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "SHI PB"
},
"valueId": "19143"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "SKquote29+25"
},
"valueId": "19506"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "SKTRI+20"
},
"valueId": "16176"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "SSGPB20"
},
"valueId": "17084"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Support 4% PB"
},
"valueId": "15743"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "sync_3%"
},
"valueId": "19795"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "synd reseller_3%"
},
"valueId": "19859"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "testPBCopy"
},
"valueId": "17406"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "TestPricebook01"
},
"valueId": "20219"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "Video Promo"
},
"valueId": "20408"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "YP +12% Global Adjustment"
},
"valueId": "20973"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
"valueId": "17060"
},
{
"displayValue": {
"valueType": "STRING",
"stringValue": "YP PB +15% Global Adjustment"
},
"valueId": "21013"
}
],
"columnTemplateId": "azure_plan_billing.price_book"
},
{
"id": "116689",
"displayName": "Region",
"allValues": [
{
"displayValue": {
"valueType": "STRING"
}
}
],
"columnTemplateId": "azure_plan_billing.region"
}
],
"dateRangeOption": {
"selectedRange": {
"relativeDateRange": "MONTH_TO_DATE",
"relativeActualDateRange": {
"startDate": "2025-06-01T00:00:00Z",
"endDate": "2025-06-03T00:00:00Z"
}
}
},
"currencyOption": {
"availableCurrencies": [
{
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
{
"code": "AUD",
"symbol": "$",
"name": "Australian Dollar",
"displayOrder": 2
},
{
"code": "CAD",
"symbol": "$",
"name": "Canadian Dollar",
"displayOrder": 4
},
{
"code": "EUR",
"symbol": "€",
"name": "Euro",
"displayOrder": 5
},
{
"code": "CHF",
"symbol": "CHF",
"name": "Swiss Franc",
"displayOrder": 9
},
{
"code": "SGD",
"symbol": "$",
"name": "Singapore Dollar",
"displayOrder": 11
},
{
"code": "MYR",
"symbol": "MYR",
"name": "Malaysian Ringgits",
"displayOrder": 21
},
{
"code": "INR",
"symbol": "₹",
"name": "Indian Rupee",
"displayOrder": 24
},
{
"code": "VND",
"symbol": "₫",
"name": "Vietnamese đồng",
"displayOrder": 26
},
{
"code": "ALL",
"symbol": "Lek",
"name": "Albanian Lek",
"displayOrder": 34
},
{
"code": "AMD",
"symbol": "֏",
"name": "Armenian dram",
"displayOrder": 44
}
],
"selectedCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
}
},
"customerFieldKeys": [
{
"displayName": "AutomationField123",
"uniqueKey": "AutomationTest070520240307"
},
{
"displayName": "Automation_TestCustomField",
"uniqueKey": "Test_Fields_0506020327_Edited_20240716"
},
{
"displayName": "CIS_ID",
"uniqueKey": "CIS_ID"
},
{
"displayName": "DefectValidation",
"uniqueKey": "DefectValidation"
},
{
"displayName": "Microsoft_ResellerPO",
"uniqueKey": "Microsoft_ResellerPO"
},
{
"displayName": "SAP ID",
"uniqueKey": "SAP_ID"
}
],
"cloudAccountFieldKeys": [
{
"displayName": "End_Customer_PO",
"uniqueKey": "End_Customer_PO"
},
{
"displayName": "GNH",
"uniqueKey": "GNH"
},
{
"displayName": "Reseller_1PO",
"uniqueKey": "Reseller1_PO"
},
{
"displayName": "Reseller_PO",
"uniqueKey": "Reseller_PO"
}
],
"conversionRates": [
{
"fromCurrency": {
"code": "AUD",
"symbol": "$",
"name": "Australian Dollar",
"displayOrder": 2
},
"toCurrency": {
"code": "AUD",
"symbol": "$",
"name": "Australian Dollar",
"displayOrder": 2
},
"rate": 1
},
{
"fromCurrency": {
"code": "EUR",
"symbol": "€",
"name": "Euro",
"displayOrder": 5
},
"toCurrency": {
"code": "CAD",
"symbol": "$",
"name": "Canadian Dollar",
"displayOrder": 4
},
"rate": 1.511186389847
},
{
"fromCurrency": {
"code": "EUR",
"symbol": "€",
"name": "Euro",
"displayOrder": 5
},
"toCurrency": {
"code": "EUR",
"symbol": "€",
"name": "Euro",
"displayOrder": 5
},
"rate": 1
},
{
"fromCurrency": {
"code": "EUR",
"symbol": "€",
"name": "Euro",
"displayOrder": 5
},
"toCurrency": {
"code": "INR",
"symbol": "₹",
"name": "Indian Rupee",
"displayOrder": 24
},
"rate": 92.984482469384
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "ALL",
"symbol": "Lek",
"name": "Albanian Lek",
"displayOrder": 34
},
"rate": 90.21199819576
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "AMD",
"symbol": "֏",
"name": "Armenian dram",
"displayOrder": 44
},
"rate": 388.048117966628
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "AUD",
"symbol": "$",
"name": "Australian Dollar",
"displayOrder": 2
},
"rate": 1.484979433035
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "CAD",
"symbol": "$",
"name": "Canadian Dollar",
"displayOrder": 4
},
"rate": 1.363196422973
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "CHF",
"symbol": "CHF",
"name": "Swiss Franc",
"displayOrder": 9
},
"rate": 0.862597678405
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "EUR",
"symbol": "€",
"name": "Euro",
"displayOrder": 5
},
"rate": 1.25
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "MYR",
"symbol": "MYR",
"name": "Malaysian Ringgits",
"displayOrder": 21
},
"rate": 4.377497909745
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "SGD",
"symbol": "$",
"name": "Singapore Dollar",
"displayOrder": 11
},
"rate": 1.308034207711
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"rate": 1,
"isDefault": true
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "VND",
"symbol": "₫",
"name": "Vietnamese đồng",
"displayOrder": 26
},
"rate": 25000
}
],
"importsStatus": {
"imports": [
{
"details": "MpnIDs: 5462014",
"billingMonth": "2025-06-01T00:00:00Z",
"ranAt": "2025-06-03T10:13:29Z"
}
]
}
},
"createTime": "0001-01-01T00:00:00Z",
"cacheMetadataProviderIds": [
"30"
],
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
"results": {
"rows": [
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA1002104022Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "84802",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "a8d7f259-4e76-4ca7-dc9a-988c1cb764a2"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Supply Chain Management"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Supply Chain Management"
},
{
"valueType": "STRING",
"stringValue": "Three-3 Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4851
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4091.01
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -759.99
}
},
{
"valueType": "FLOAT",
"floatValue": 0.611111104
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 22
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "dp_25 (DP)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86932",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "ef3666d1-447e-4218-db4b-7241d5c07374"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Commerce"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Commerce Attach to Qualifying Dynamics 365 Base Offer"
},
{
"valueType": "STRING",
"stringValue": "Three-3 Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 31.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 30
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.5
}
},
{
"valueType": "FLOAT",
"floatValue": 0.027777778
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "dp_25 (DP)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86932",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "596e0a63-46e8-4585-dc12-c0a42dc6c826"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Commerce"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Commerce Attach to Qualifying Dynamics 365 Base Offer"
},
{
"valueType": "STRING",
"stringValue": "Three-3 Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 31.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 30
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.5
}
},
{
"valueType": "FLOAT",
"floatValue": 0.027777778
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "nsdatepicker3 (nsdatepicker3)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "87047",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "5ce10064-7008-41ef-d953-84c57b1afcec"
},
{
"valueType": "STRING",
"stringValue": "Bridge to the Cloud 2 (BTTC2) Promo"
},
{
"valueType": "STRING",
"stringValue": "Bridge to the Cloud 2 (BTTC2) Promo - Dynamics 365 Business Central Premium"
},
{
"valueType": "STRING",
"stringValue": "Three-Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "NS_CHECKREPORT"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 189
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 132.3756
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -56.6244
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP NC Promo 27 Feb 02 25 (YP NC Promo 27 Feb 02 25)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "90914",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f53a5ef8-22c7-489f-d90d-7ba74ea12507"
},
{
"valueType": "STRING",
"stringValue": "Bridge to the Cloud 2 (BTTC2) Promo"
},
{
"valueType": "STRING",
"stringValue": "Bridge to the Cloud 2 (BTTC2) Promo - Dynamics 365 Business Central Essentials"
},
{
"valueType": "STRING",
"stringValue": "Three-Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 44.1
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 61.111111111111107
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 17.0111111111
}
},
{
"valueType": "FLOAT",
"floatValue": 0.027777778
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "DoNotUseThisCustomer2 (TestQA TESTQA)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "67949",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f24499dc-9cd8-4e80-cb56-1ed9c8372096"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 690.00000000000011
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 575
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -115
}
},
{
"valueType": "FLOAT",
"floatValue": 2.08333325
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 25
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "05 PM Bittitan WLMP (Pravin M)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71093",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "6129cdcd-28b8-4d0b-d6d0-2dddef6d396d"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Business Central Essentials"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Business Central Essentials"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 88.199999999999989
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 84
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -4.2
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA03063416Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94913",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "d9522147-af54-4042-caaf-dd985780beef"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 5.76
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.8
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -0.96
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA03065422Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94914",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "3a46b3df-4272-4f0d-c6c9-6c74699b673e"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 86.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 70
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -16.4
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP Avepoint 07 May 01 (YP Avepoint 07 May 01)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "93928",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "73ce99be-f876-4f79-d76e-dde94b3f9c7a"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Finance"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Finance"
},
{
"valueType": "STRING",
"stringValue": "Three-Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP PB +15% Global Adjustment"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 158760
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 182574
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 23814
}
},
{
"valueType": "FLOAT",
"floatValue": 20
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 20
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP Avepoint 07 May 01 (YP Avepoint 07 May 01)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "93928",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "8b1ba91e-4213-419e-cc70-b4d3d0e86cfb"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Finance"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Finance"
},
{
"valueType": "STRING",
"stringValue": "Three-Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP PB +15% Global Adjustment"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 158760
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 182574
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 23814
}
},
{
"valueType": "FLOAT",
"floatValue": 20
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 20
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "AutoTest202502805 (maria white)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94748",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft"
},
{
"valueType": "STRING",
"stringValue": "267cd77d-6c3d-4437-c8b0-0d8d52a2977a"
},
{
"valueType": "STRING",
"stringValue": "BizTalk Server 2020 Standard"
},
{
"valueType": "STRING",
"stringValue": "BizTalk Server 2020 Standard"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "FLOAT"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA01065654Org (AutomationCustomer0322052543)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94830",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft"
},
{
"valueType": "STRING",
"stringValue": "58f1569e-d58b-4325-d7cc-658ff92501bf"
},
{
"valueType": "STRING",
"stringValue": "BizTalk Server 2020 Standard"
},
{
"valueType": "STRING",
"stringValue": "BizTalk Server 2020 Standard"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "FLOAT"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02065817Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94872",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft"
},
{
"valueType": "STRING",
"stringValue": "d48dd29b-4c9d-46ad-df7d-3af1c92f725c"
},
{
"valueType": "STRING",
"stringValue": "BizTalk Server 2020 Standard"
},
{
"valueType": "STRING",
"stringValue": "BizTalk Server 2020 Standard"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "FLOAT"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "05 PM Bittitan WLMP (Pravin M)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71093",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft"
},
{
"valueType": "STRING",
"stringValue": "78f74254-72ba-4be6-c9c3-521c63b89f88"
},
{
"valueType": "STRING",
"stringValue": "Virtual Machines BS Series"
},
{
"valueType": "STRING",
"stringValue": "Reserved VM Instance, Standard_B1s, US East, 1 Year"
},
{
"valueType": "STRING",
"stringValue": "1 Year Reservation"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6.625
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.4166666666666661
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.2083333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING",
"stringValue": "1 Hour"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "AutoTest202502805 (maria white)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94748",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "cddec4b8-3c2d-4ecf-cfbc-88d6b82925b8"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Audio Conferencing"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Audio Conferencing"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "FLOAT"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 5
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02061630Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94868",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "bcbf41ad-dbc2-43ad-de66-557f77a5cf1b"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 17.28
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12.925439999999998
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -4.35456
}
},
{
"valueType": "FLOAT",
"floatValue": 3
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP 02 Jan 25 (YP 02 Jan 25)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88797",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "64ee2c66-d24c-43ac-caa3-954e5ce1f874"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 18
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.076
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -3.924
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "PSAAT3 (Sindhu11)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "67375",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "46ea12bd-ba8c-441b-cd35-8662a7a04190"
},
{
"valueType": "STRING",
"stringValue": "Visio Plan 2"
},
{
"valueType": "STRING",
"stringValue": "Visio Plan 2"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 21.6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 18
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -3.6
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "PSAAT3 (Sindhu11)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "67375",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "0fad1639-28a1-4524-de05-49d0bbea6d6e"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E3"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 33.12
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 27.6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -5.52
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Sravan_All Providers_New (Apptium)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "68879",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "34157f92-de01-403e-daff-ecb863b2d147"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 164.16
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 136.8
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -27.36
}
},
{
"valueType": "FLOAT",
"floatValue": 3
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02065817Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94872",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "51f27b93-d089-447b-d992-ad58e0c44950"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 939.6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 702.8208
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -236.7792
}
},
{
"valueType": "FLOAT",
"floatValue": 2.9
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02061630Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94868",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "27711d87-164b-477c-cd7b-e1b1dba745e5"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 57.599999999999994
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 43.0848
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -14.5152
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP 01 July PO Test (YP 01 July PO Test)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "81470",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "302c81dd-0bd1-4e8a-c875-283f65cc4849"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 9.5999999999999979
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.5071999999999992
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.0928
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA16120536Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88270",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "9d1fc3b4-d9b6-4d46-ced2-057aba573b26"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.7999999999999989
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -0.8
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02061630Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94868",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "0f9006ee-8d81-4093-c14e-ffcf1168224d"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 5.04
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.1666666666666661
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -0.8733333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA20044723Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "93328",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "74d876f3-c105-4ca1-d341-45b178c6a0c7"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 5.04
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.1999999999999993
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -0.84
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA14040512Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "93020",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "2dd5c0bd-dc9c-43c9-d79f-572181cada53"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.56
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 5.6548799999999995
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.90512
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA06113654Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86214",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "851920bc-44c1-4175-d268-e85df52d208e"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.2
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA06113019Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86193",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "120e729e-fb69-45ca-d3bb-8e8aecc04ed1"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.2
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA31031723Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "92453",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "8294d334-9d2b-458b-cf57-26d32b2ab8ab"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.2
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Reg_MSFT_Prabha (Prabha)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71482",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "09460f52-2a9f-472d-d80c-41422bb668ef"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.2
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA07110943Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86240",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "e9c7e193-7041-4052-c412-85f4f322479d"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.2
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA05112307Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86152",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f3e18dce-acc4-41ef-d351-0f8d25ee656a"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.4
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepickerjan (Datepickerjan)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88789",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "fa0bf8ae-06c5-47b1-d3d3-1b9981baab83"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12.394936708866666
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.0050632911
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Jan2 (Datepicker Jan2)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88782",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "2d5852d4-5a27-415a-d582-84a2276fb02a"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12.395
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.005
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "AutoTest202502805 (maria white)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94748",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "54e39bbc-a0fb-4e92-ce72-ae29b3f8a7b6"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.3080000000000007
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6.09
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.218
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0805555582
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Jan (Datepicker jan)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88783",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "2bd26b5e-224b-4d00-c1f8-b861f9f2e872"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 13.333333333333332
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.0666666667
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Jan6 (Datepicker Jan6)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88959",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "58fc4a90-eadf-4db5-c298-a63cd74e6075"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 8.3333333333333321
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 1.1333333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Dec1 (Datepicker Dec1)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "87235",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "b548a5e3-2bb9-4e2a-d879-ff26f5bc6dd2"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 8.3333333333333321
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 1.1333333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "16Aprcust1 (16Aprcust1)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "68852",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "cf95e35c-7b34-4453-cfe2-ce6171afc812"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E1"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E1"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "SHI PB"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 9.792
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.208
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Sravan_All Providers_New (Apptium)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "68879",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "1815ead1-31f4-4fd9-d2cb-d2a71dc2f3b9"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for enterprise"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for enterprise"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 144
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 113.05916666666666
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -30.9408333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.833333313
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 10
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Dec31 (Datepicker Dec31)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88733",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "b2b90d4f-98c3-4f98-cfaf-e8a0884b25af"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 30
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 24.431666666666665
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -5.5683333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Dec1 (Datepicker Dec1)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "87235",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "0842d780-9800-40b1-cf39-e2ce3980a60f"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 15
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 13.076666666666664
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.9233333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Dec1 (Datepicker Dec1)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "87235",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "8d5efd4f-dff7-4ad1-c48b-4e38bd94c824"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 15
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 16.666666666666664
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 1.6666666667
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "dp_25 (DP)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86932",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "b0380674-991b-4e29-d218-8ca92a0d91a0"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 270
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 211.14
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -58.86
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA28054321Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94740",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "357a1fdd-d97c-4f8a-d045-b6d37d5b74fc"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 283.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 212.058
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -71.442
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA28054321Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94740",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "c401f817-103d-4800-ce65-76b04d272f71"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 283.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 212.058
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -71.442
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA22044536Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "93394",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "1cef0d8d-728d-424c-c1b9-56faadb26478"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 283.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 212.058
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -71.442
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "aptest (aptest)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86423",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f355b209-a9a6-41d9-d963-758906ce246e"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "NS_CHECKREPORT"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 270
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 250
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -20
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "BA_US_31July (BA_US_31July)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "81358",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "c2f0776b-0fec-434b-c2a9-23323ad233a0"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Supply Chain Management"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Supply Chain Management"
},
{
"valueType": "STRING",
"stringValue": "Three-3 Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 3969
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 3233.9999999999995
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -735
}
},
{
"valueType": "FLOAT",
"floatValue": 0.583333313
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 21
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "NCEPromo Jan13_2 (NCEPromo Jan13_2)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "89391",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "4bf36c0f-2a88-4ad9-cb7a-8db321545724"
},
{
"valueType": "STRING",
"stringValue": "Bridge to the Cloud 2 (BTTC2) Promo"
},
{
"valueType": "STRING",
"stringValue": "Bridge to the Cloud 2 (BTTC2) Promo - Dynamics 365 Business Central Premium"
},
{
"valueType": "STRING",
"stringValue": "Three-Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "Endcustomer 10%"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 252
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 299.88
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 47.88
}
},
{
"valueType": "FLOAT",
"floatValue": 0.111111112
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 4
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Prath Tricust1 (Prath Tricust1)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71623",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "08fbee87-1925-4647-d0d4-556a32b8fa8a"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Supply Chain Management"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Supply Chain Management"
},
{
"valueType": "STRING",
"stringValue": "Three-3 Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 3969
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 3780
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -189
}
},
{
"valueType": "FLOAT",
"floatValue": 0.583333313
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 21
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "dp_25 (DP)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86932",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f4f9c523-16ed-4dec-d86d-2eb6ba9d9d5c"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Commerce"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Commerce Attach to Qualifying Dynamics 365 Base Offer"
},
{
"valueType": "STRING",
"stringValue": "Three-3 Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 31.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 30
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.5
}
},
{
"valueType": "FLOAT",
"floatValue": 0.027777778
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "dp_25 (DP)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86932",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "9feb391a-4cbd-4494-d333-1f4042661c52"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Commerce"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Commerce Attach to Qualifying Dynamics 365 Base Offer"
},
{
"valueType": "STRING",
"stringValue": "Three-3 Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 31.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 30
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.5
}
},
{
"valueType": "FLOAT",
"floatValue": 0.027777778
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP Quote Defect test 01 (YP Quote Defect test 01)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "87340",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "6e2e148d-07a7-4234-d970-edb1524950db"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 270
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 250
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -20
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02014043Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88780",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "cef80422-ce18-4594-db40-ae4b548722d0"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "reseller+10%"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 5.4166666666666661
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.7833333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP 02 Jan 25 (YP 02 Jan 25)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88797",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft"
},
{
"valueType": "STRING",
"stringValue": "01634a2a-d132-4f9a-d56a-f4f006316ce1"
},
{
"valueType": "STRING",
"stringValue": "SQL Server Standard Core 2022"
},
{
"valueType": "STRING",
"stringValue": "SQL Server Standard 2022- 2 Core License Pack - 1 year"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 197.93999999999997
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 168.249
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -29.691
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "MM TestCust30jan (Mayur More)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "90020",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "03c32942-6a5c-4b9b-ddbc-faeb4cbec096"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "MM Admin PB 5%"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.7999999999999989
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 3.75
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.05
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA03034020Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "91167",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "bd0e815b-630e-4e6d-df3c-c82b0b844281"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for enterprise"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for enterprise"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.4
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "DP nce promo 4 (DP nce promo 4)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "92645",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f8925a61-3213-4f7f-cd0c-653286944e30"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E3 15% Promo (2024-2025)"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E3 (no Teams)-Microsoft 365 E3 15% Promo (2024-2025)"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "Endcustomer 10%"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 36.19725
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 33.18315
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -3.0141
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "DP nce promo 4 (DP nce promo 4)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "92645",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "2040fd6d-1d19-4347-dbeb-4360bf563bd0"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E5 15% Annual Term Promo"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E5 (no Teams)-Microsoft 365 E5 15% Annual Term Promo"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "Endcustomer 10%"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 58.694624999999981
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 53.799899999999994
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -4.894725
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "05 PM Bittitan WLMP (Pravin M)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71093",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f9088104-9c18-43a1-d17b-67427c369bcd"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Business Central Essentials"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Business Central Essentials"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 88.199999999999989
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 84
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -4.2
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "05 PM Bittitan WLMP (Pravin M)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71093",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "47242756-a952-4bff-c094-ac15ad1cf0e1"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Business Central Essentials"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Business Central Essentials"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 88.199999999999989
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 84
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -4.2
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA03063416Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94913",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "716b0505-3442-4f5c-ccc8-4e12c1c15fb3"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 86.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 72
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -14.4
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP Avepoint 07 May 01 (YP Avepoint 07 May 01)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "93928",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "663342c6-72ff-4722-d01c-51cf47fa9870"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Finance"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Finance"
},
{
"valueType": "STRING",
"stringValue": "Three-Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP PB +15% Global Adjustment"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 158760
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 182574
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 23814
}
},
{
"valueType": "FLOAT",
"floatValue": 20
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 20
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA01065654Org (AutomationCustomer0322052543)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94830",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft"
},
{
"valueType": "STRING",
"stringValue": "0bdf4f71-d390-40ea-d0db-3a8c578ef196"
},
{
"valueType": "STRING",
"stringValue": "BizTalk Server 2020 Standard"
},
{
"valueType": "STRING",
"stringValue": "BizTalk Server 2020 Standard"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "FLOAT"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "05 PM Bittitan WLMP (Pravin M)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71093",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft"
},
{
"valueType": "STRING",
"stringValue": "5caa4cb4-44fe-462f-c72e-b40ab7d405ec"
},
{
"valueType": "STRING",
"stringValue": "Virtual Machines BS Series"
},
{
"valueType": "STRING",
"stringValue": "Reserved VM Instance, Standard_B1s, US East, 1 Year"
},
{
"valueType": "STRING",
"stringValue": "1 Year Reservation"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.4166666666666661
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.4166666667
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING",
"stringValue": "1 Hour"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "AutoTest202502805 (maria white)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94748",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "cddec4b8-3c2d-4ecf-cfbc-88d6b82925b8"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Audio Conferencing"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Audio Conferencing"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD"
}
},
{
"valueType": "FLOAT"
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "AutoTest202502805 (maria white)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94748",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "226006aa-febd-4591-ca27-27124283c5ef"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Audio Conferencing"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Audio Conferencing"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 3
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.5
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "dp_25 (DP)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86932",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "3e066112-e70a-4bfd-dbef-8c6625095a1a"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 5.76
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.8
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -0.96
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "dp_25 (DP)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86932",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "1b599714-348d-43cd-c5c2-5fbd22c8ca9b"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 5.76
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 4.8
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -0.96
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02061630Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94868",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "18cb0876-7025-45ed-cef7-c23c9444b501"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 11.955
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 8.94234
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -3.01266
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP 02 Jan 25 (YP 02 Jan 25)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88797",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f0b35eb4-17ad-48ef-d9c5-5cd60c8e43df"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 18
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.076
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -3.924
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Apptium (Reston Office)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71298",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "ef82b05b-25a2-4a39-d93d-01f2c445b614"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E3"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E3 - Unattended License"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING",
"stringValue": "INSIGHT JAN"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 51.84
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 35.251200000000004
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -16.5888
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Sravan_All Providers_New (Apptium)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "68879",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "80046765-c4d3-424b-c917-1c43e7467e5e"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E3"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E3"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 207.36
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 172.8
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -34.56
}
},
{
"valueType": "FLOAT",
"floatValue": 4
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 4
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "AutoTest202502805 (maria white)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94748",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "5fde2dc1-a823-4c59-d001-5c60e856f9ff"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Month commitment for monthly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 324
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 240
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -84
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "BA_USU1_02Aug (BA_USU1_02Aug)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "81540",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "1eb5d68e-23db-4701-c2bb-6f1910b60281"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 F3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.399999999999999
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 5.62
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -8.78
}
},
{
"valueType": "FLOAT",
"floatValue": 0.25
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02120938Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "87211",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "3402317f-dde2-4244-c829-2c3585aa33b3"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 21.6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 18
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -3.6
}
},
{
"valueType": "FLOAT",
"floatValue": 0.25
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA25114649Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86926",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "4c798840-62eb-4555-d34b-03f82495eaa5"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.2
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA16124725Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88218",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "dd503c12-3017-4a32-d2a9-694d277b00b6"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.2
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Jan (Datepicker jan)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88783",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "81d2f8d6-f345-4cee-cf44-4fcffebd03a8"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12.395
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.005
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Jancust1 (Jancust1)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88792",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "ec6962d0-b73b-4ae2-dbf6-8e3bc1a6fd58"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 14.4
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12.395
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.005
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA31033632Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "92473",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "cab643fe-7040-496d-dd71-ab6281accb01"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 22.679999999999996
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 18.9
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -3.78
}
},
{
"valueType": "FLOAT",
"floatValue": 0.25
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "AutoTest20252805 (maria white)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94738",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "7b20ebe6-8568-4511-dd8e-08535ae6bba4"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.56
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6.2999999999999989
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.26
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "AutoTest202502805 (maria white)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94748",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "e853854d-0c1f-45e0-c027-03ed5e844965"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 15.12
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12.599999999999998
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.52
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Jan (Datepicker jan)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88783",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "1bba7c78-758b-4516-d22b-557dcd50bab4"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Basic"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 7.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 6.6666666666666661
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -0.5333333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "nsdatepicker3 (nsdatepicker3)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "87047",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "8d56aaf5-eddc-4448-d042-114f79760299"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "NS_CHECKREPORT"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 39.84
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 27.903936
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -11.936064
}
},
{
"valueType": "FLOAT",
"floatValue": 0.333333343
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 4
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02061630Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94868",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "b0c4acd6-2c60-4689-d346-9a2431c30b8f"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 119.52000000000001
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 89.40096
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -30.11904
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Sri Latha (SriL)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "83177",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "ed4345f0-f7ca-4cfe-db6b-c62939357172"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 9.96
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 8.2999999999999989
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.66
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA20052538Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "94455",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "f884076c-3970-47eb-d74f-1d506e3ac19a"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Apps for business"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 10.455
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 8.7199999999999989
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -1.735
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "BA_USU1_1Aug (BA_USU1_1Aug)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "81464",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "625a57ef-7ea0-4a11-c7af-3bc4445c2e39"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E1"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E1"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 36
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 29.4325
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -6.5675
}
},
{
"valueType": "FLOAT",
"floatValue": 0.25
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Dec31 (Datepicker Dec31)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88733",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "01621321-a7a5-4219-d28a-d865b7d35762"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 30
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 25
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -5
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Jan (Datepicker jan)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88783",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "b594d0f6-18f7-4eee-d1f9-12f3f03c04b1"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 45
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 37.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -7.5
}
},
{
"valueType": "FLOAT",
"floatValue": 0.25
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 3
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Jancust1 (Jancust1)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88792",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "86d919b9-ccf8-4c0a-d997-84091fe9f5b6"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 30
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 25
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -5
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Datepicker Jan (Datepicker jan)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88783",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "67c97ffc-22fd-43ce-d97c-a6cef75e854a"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 Business Standard"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 15
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 12.851666666666667
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.1483333333
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "NCECustomer (Jaya c)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "87246",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "8b1a70ec-cd15-4100-c2da-88ed6d824d2f"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Business Central Essentials Attach"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Business Central Essentials Attach"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 22.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 20
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -2.5
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP 01 July PO Test (YP 01 July PO Test)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "81470",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "d8b7ead4-949e-4434-d6fb-1c056d2cc0ec"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E3"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E3"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 55.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 43.166399999999996
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -12.0336
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "YP 01 July PO Test (YP 01 July PO Test)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "81470",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "efd6914b-3509-47ed-d7c7-c74efdf400d0"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "YP Margin +15% July 24"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 91.2
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 71.3184
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -19.8816
}
},
{
"valueType": "FLOAT",
"floatValue": 0.166666672
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 2
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Reg_MSFT_Prabha (Prabha)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71482",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "e0251eb1-0506-476c-c87d-44b15c687e79"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E3 15% Promo (2024-2025)"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E3-Microsoft 365 E3 15% Promo (2024-2025)"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 477.36
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 397.8
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -79.56
}
},
{
"valueType": "FLOAT",
"floatValue": 1.08333337
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 13
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "PSAAT3 (Sindhu11)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "67375",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "47f14e6e-a76e-4706-cf92-069149ca2459"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 1197
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 950
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -247
}
},
{
"valueType": "FLOAT",
"floatValue": 2.08333325
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 25
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "PSAAT3 (Sindhu11)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "67375",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "3341a730-c1cd-44c1-d4eb-022b2f3a5e3b"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 45.6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 38
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -7.6
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "sal Ops (Sal uat)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "81324",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "6633c9cb-0044-4cea-c225-33df5d33ae64"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "Office 365 E5"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 45.6
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 38
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -7.6
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Reg_MSFT_Prabha (Prabha)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "71482",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "c84991d4-c2b3-42bf-cbe2-d96378a376bb"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E5"
},
{
"valueType": "STRING",
"stringValue": "Microsoft 365 E5"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 820.8
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 684
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -136.8
}
},
{
"valueType": "FLOAT",
"floatValue": 1
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 12
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "MM TestCust02Jan25 (Mayur More)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88796",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "3fde2211-e785-48c0-c6bc-783276c2cee2"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "Deep_tri_PB4"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 270
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 187.27199999999996
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -82.728
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "aptest (aptest)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86423",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "486d43ce-ecd4-4b69-c008-99558e7d3ba8"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "NS_CHECKREPORT"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 270
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 189.10799999999998
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -80.892
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA02010824Org (AutomationCustomer0322052543)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88776",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "4cd797c7-d5f1-4d9b-c3f1-11282b373fe9"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 270
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 200
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -70
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "dp_25 (DP)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "86932",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "b901c784-dc0f-4f6b-ca53-2e607958f7ad"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 270
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 211.14
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -58.86
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA22044536Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "93394",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "7e348cf4-9a4f-42ab-c0e0-ef3a42c6ba76"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 283.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 212.058
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -71.442
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "QA22044536Org (Maria White)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "93394",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "08834d50-f0ff-4ef6-c9a1-2fb8ef696002"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "Microsoft Copilot Studio"
},
{
"valueType": "STRING",
"stringValue": "One-Year commitment for monthly/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "DoNotDeletePricebook"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 283.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 212.058
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -71.442
}
},
{
"valueType": "FLOAT",
"floatValue": 0.0833333358
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "Blue Company (Jim Blue)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "81583",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "97773081-b061-4d49-c1ce-c763c20b1dcd"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Finance"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Finance"
},
{
"valueType": "STRING",
"stringValue": "Three-3 Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 3780
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 3600
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -180
}
},
{
"valueType": "FLOAT",
"floatValue": 0.555555582
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 20
}
]
},
{
"values": [
{
"valueType": "STRING",
"stringValue": "MM TestCust02Jan25 (Mayur More)",
"invoiceKey": {
"providerId": [
"30"
],
"customerId": "88796",
"providerCurrency": [
"USD"
]
}
},
{
"valueType": "STRING",
"stringValue": "Microsoft Corporation"
},
{
"valueType": "STRING",
"stringValue": "823aebc3-6114-4fc4-c6b0-87a33e6d5a80"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Supply Chain Management"
},
{
"valueType": "STRING",
"stringValue": "Dynamics 365 Supply Chain Management Attach to Qualifying Dynamics 365 Base Offer"
},
{
"valueType": "STRING",
"stringValue": "Three-Years commitment for monthly/3 Years/yearly billing"
},
{
"valueType": "STRING",
"stringValue": "Deep_tri_PB4"
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 31.5
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": 31.43333333333333
}
},
{
"valueType": "MONEY",
"moneyValue": {
"currency": "USD",
"value": -0.0666666667
}
},
{
"valueType": "FLOAT",
"floatValue": 0.027777778
},
{
"valueType": "STRING"
},
{
"valueType": "STRING"
},
{
"valueType": "FLOAT",
"floatValue": 1
}
]
}
]
},
"resultCount": "112",
"availableRowsCount": "112"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
report |
Object | The definition of a report. | The elements in the report object |
results |
Object | The content of the report. | The elements in the results object |
resultCount |
String | Represents the total number of rows returned, including any nested or child rows. | 112 |
availableRowsCount |
String | Represents the total number of rows that can be returned. | 112 |
Elements in the report object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
reportId |
String | The report ID. | Numeric value such as 1234 |
displayName |
String | The name of the report that is displayed on the UI. | AWS billing report |
category |
String | Specifies the type of report and helps to organize reports in the UI. | Billing_Reports |
createdBy |
String | Specifies the author of the report. | System |
lastUpdatedBy |
String | Specifies the latest editor of the report. | System |
specs |
Object | Report setting that the user specifies. | The elements in the specs object |
createTime |
String | The time when the report is created, in YYYY-MM-DD HH:Min format. | 0001-01-01T00:00:00Z |
providerIds |
Array | The cloud provider ID. | 30 |
reportTemplateId |
String | An identifier for a specific report layout. | Azure_Plan_Billing |
reportModule |
String | The modules that use the reports service. | Values such as
|
Elements in the specs object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
allColumns |
Array | All available columns for this report. | The elements in the allColumns array list |
selectedColumns |
Array | All selected columns for this report. | The elements in the selectedColumns array list |
columnFilters |
Array | Filters the report data using predefined filters such as customerName, pricebook, region, and so on. | The elements in the columnFilters array list |
dateRangeOption |
Object | The available and selected date ranges for the report. | The elements in the dateRangeOption object |
currencyOption |
Object | The available and selected currencies for the report. | The elements in the currencyOption object |
customerFieldKeys |
Array | Specifies the list of available custom fields linked to the customers for the corresponding account | The elements in the customerFieldKeys array list |
cloudAccountKeys |
Array | Specifies the list of cloud accounts (SubscriptionIDs) linked to the customer. | The elements in the cloudAccountKeys array list |
conversionRates |
Array | Consists of conversion rates which can be used to convert money values from one currency to another. Note: This field is dynamically populated by the API, but the values are not saved in the system. | The elements in the conversionRates array list |
importStatus |
Object | Specifies the details of the data import process. | The elements in the importStatus object |
Elements in the allColumns array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | Numeric value such as 123456 |
displayName |
String | The name of the column that is displayed on UI. | Availability ID |
groupable |
Boolean | Indicates whether the data in this column can be grouped in the report output. If set to true, the column can be used for grouping data rows. | Values such as True or False |
columnTamplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the selectedColumns array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | Numeric value such as 123456 |
displayName |
String | The name of the column that is displayed on UI. | Customer Name |
groupingLevel |
Integer | Indicates the hierarchical level of data grouping applied in the report. | Value 1 indicates the hierarchy is highest, followed by level 2, 3, and so on |
isInvoiceKey |
Boolean | Specifies whether the associated field serves as a key identifier for invoice generation or matching. | Values such as True or False |
valueType |
String | Indicates the data type of the value in a specific field. | Integer, String, Boolean and so on |
columnHeading |
String | The name of the column that is displayed on UI. | Customer Name |
columnTemplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the columnFilters array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | 123456. |
displayName |
String | The name of the column that is displayed on UI. | Customer Name |
columnTemplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the dateRangeOption object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
selectedRange |
Object | Indicates the reporting period of the data included in the report. It includes relative and fixed date range. | Values such as:
|
Elements in the selectedRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
relativeDateRange |
String | Specifies the dynamic period for the report. You can select a predefined date range instead of entering calendar inputs. | MONTH_TO_DATE |
relativeActualDateRange |
Object | Includes the startDate and endDate of the report. You can select the calendar inputs. | The elements in the relativeActualDateRange object |
Elements in the relativeActualDateRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the start date of the date range. | 2025-05-01T00:00:00Z |
endDate |
String | Specifies the end date of the date range. | 2025-05-14T00:00:00Z |
Elements in the currencyOption array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
availableCurrencies |
Array | Specifies the available currencies. | USD |
selectedCurrency |
Object | Indicates the selected currency. | USD |
Elements in the availableCurrencies array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the selectedCurrency object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the customerFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies a user-friendly name for custom fields. If the name is unavailable, set this as label. | AutomationField123 |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | AutomationFieldxxx. |
Elements in the cloudAccountFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies the user-friendly name for cloud account fields. If the name is unavailable, set this as label. | End_Customer_PO |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | End_Customer_xxx |
Elements in the conversionRates array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
fromCurrency |
Object | Indicates the source currency in which the original transaction is recorded. | The elements in the fromCurrency object |
toCurrency |
Object | Indicates the target currency in which fromCurrency amount has been converted to. | The elements in the toCurrency object |
rate |
Double Integer | Indicates the rate that is used to convert the value from the fromCurrency to the toCurrency. |
1 |
Elements in the fromCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | EUR |
symbol |
String | Currency symbol used for formatting the currency. | € |
name |
String | Name of the currency. | Euro |
displayOrder |
Integer | Display order for currency. | 5 |
Elements in the toCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency | $ |
name |
String | Name of the currency. | USD |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the importStatus array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
imports |
Array | Includes import details of the report. | The elements in the imports array list |
Elements in the imports array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
details |
String | Reseller Id. | MpnIDs: 123456 |
billingMonth |
String | Current month of billing. | 2025-05-01T00:00:00Z |
ranAt |
String | The time when the data is imported into the ION system. | 2025-05-14T10:13:46Z |
Elements in the results object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
rows |
Array | Represents the data records. Each row must have the same number of values. These values should align with the columns defined in the selectedColumns of the report specification. |
The elements in rows array |
Elements in the rows array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
values |
Array | Represents the values for each column. The order must match the order of columns defined in ReportData. | The elements in values array |
Elements in the values array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
valueType |
String | The types of value that can be returned as report data. | Values such as:
|
StringValue |
String | Represents the string values such as names, IDs, labels and so on. | Maria White |
invoiceKey |
Object | Specifies the invoice associated with the report data. It helps link each record to specific billing details such as provider, customer, and currency | The elements in invoiceKey object |
moneyValue |
Object | Represents the monetory values in the report such as currency and amount. | The elements in moneyValue object |
floatValue |
Float | Represents the decimal values in the report such as usage quantity, unit and so on. | 0.611111104 |
Elements in the invoiceKey object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
providerId |
Array | Specifies the cloud provider from which the invoice is generated. Typically, it includes a single entry. In a multi-provider report, if the provider column is not selected, it lists all providers for which the customer has data. | Numeric value such as 30 |
customerId |
String | The customer ID. For resellers, this will have a prefix of "R-". | 80842 |
providerCurrency |
Array | Specifies the currency from which an invoice is generated. Typically, it includes a single entry. In a multi-currency report, if the provider column is not selected, it lists all currencies for which the customer has data. | USD |
Elements in the moneyValue object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
currency |
Array | Specifies the name of the currency. | USD |
value |
String | Indicates the amount. | 4851 |
Sample Response - Error 400
{
"error": "INVALID_REQUEST",
"message": "must have required property 'orgName'",
"code": 400,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 400 - Invalid Request
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INVALID_REQUEST |
message |
String | Error description. | Must have required property 'orgName'. |
code |
String | Error code. | 400 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error. |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Get Report Data CSV
Using the Get Report Data CSV endpoint, you can retrieve the report structure in CSV format. The CSV file includes column definitions, currency information, date ranges, and the corresponding data values.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/reports/{report_id}/reportDataCsv
Get Report
The Get Report endpoint provides information about the structure of a report including column definitions, currency information, date ranges, and so on. This structure does not include actual data. It allows you to preview the layout and configuration of the report, based on your input parameters, before retrieving the full report data.
HTTP Endpoint URL: POST https://ion.tdsynnex.com/api/v3/accounts/{accountId}/reports/{report_id}/report
Sample Request:
{
"reportId": "23582",
"displayName": "Microsoft CSP Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"specs": {
"allColumns": [
{
"id": "1470115",
"displayName": "Account Status",
"groupable": true,
"columnTemplateId": "saas_billing.account_status"
},
{
"id": "1470088",
"displayName": "Billing End Date",
"groupable": true,
"columnTemplateId": "saas_billing.billing_end_date"
},
{
"id": "1470087",
"displayName": "Billing Start Date",
"groupable": true,
"columnTemplateId": "saas_billing.billing_start_date"
},
{
"id": "1470106",
"displayName": "Billing Year Month",
"groupable": true,
"columnTemplateId": "saas_billing.billing_year_month"
},
{
"id": "1470114",
"displayName": "Charge Type",
"groupable": true,
"columnTemplateId": "saas_billing.charge_type"
},
{
"id": "1470078",
"displayName": "Cloud Account Number",
"groupable": true,
"columnTemplateId": "saas_billing.customer_account_id"
},
{
"id": "1470077",
"displayName": "Company",
"groupable": true,
"columnTemplateId": "saas_billing.unique_name"
},
{
"id": "1470107",
"displayName": "Cost Of Unit",
"groupable": true,
"columnTemplateId": "saas_billing.cost_of_unit"
},
{
"id": "1470097",
"displayName": "Currency Conversion Rates",
"groupable": true,
"columnTemplateId": "saas_billing.conversion_rates"
},
{
"id": "1470102",
"displayName": "Customer Company",
"groupable": true,
"columnTemplateId": "saas_billing.customer_company_name"
},
{
"id": "1470103",
"displayName": "Customer Company Reseller",
"groupable": true,
"columnTemplateId": "saas_billing.customer_company_name_reseller"
},
{
"id": "1470083",
"displayName": "Customer Cost",
"columnTemplateId": "saas_billing.customer_cost"
},
{
"id": "1470092",
"displayName": "Customer Cost (Invoiced Currency)",
"columnTemplateId": "saas_billing.customer_cost_invoice"
},
{
"id": "1470091",
"displayName": "Customer Cost (Provider Currency)",
"columnTemplateId": "saas_billing.customer_cost_raw"
},
{
"id": "1470089",
"displayName": "Customer Country",
"groupable": true,
"columnTemplateId": "saas_billing.customer_country"
},
{
"id": "1470112",
"displayName": "Customer External ID",
"groupable": true,
"columnTemplateId": "saas_billing.customer_external_id"
},
{
"id": "1470080",
"displayName": "Customer ID",
"groupable": true,
"columnTemplateId": "saas_billing.customer_id"
},
{
"id": "1470090",
"displayName": "Customer State",
"groupable": true,
"columnTemplateId": "saas_billing.customer_state"
},
{
"id": "1470079",
"displayName": "Description",
"groupable": true,
"columnTemplateId": "saas_billing.description"
},
{
"id": "1470109",
"displayName": "Domain Name",
"groupable": true,
"columnTemplateId": "saas_billing.domain_name"
},
{
"id": "1470099",
"displayName": "Invoice Currency",
"groupable": true,
"columnTemplateId": "saas_billing.invoice_currency"
},
{
"id": "1470084",
"displayName": "Margin",
"columnTemplateId": "saas_billing.margin"
},
{
"id": "1470096",
"displayName": "Margin (Invoiced Currency)",
"columnTemplateId": "saas_billing.margin_invoice"
},
{
"id": "1470095",
"displayName": "Margin (Provider Currency)",
"columnTemplateId": "saas_billing.margin_raw"
},
{
"id": "1470105",
"displayName": "Offer ID",
"groupable": true,
"columnTemplateId": "saas_billing.part_number"
},
{
"id": "1470116",
"displayName": "Payer Account ID",
"groupable": true,
"columnTemplateId": "saas_billing.payer_account_id"
},
{
"id": "1470104",
"displayName": "Period Quantity",
"groupable": true,
"columnTemplateId": "saas_billing.period_quantity"
},
{
"id": "1470101",
"displayName": "Price Book",
"groupable": true,
"columnTemplateId": "saas_billing.price_book"
},
{
"id": "1470100",
"displayName": "Price Book ID",
"groupable": true,
"columnTemplateId": "saas_billing.price_book_id"
},
{
"id": "1470076",
"displayName": "Provider",
"groupable": true,
"columnTemplateId": "saas_billing.provider"
},
{
"id": "1470098",
"displayName": "Provider Currency",
"groupable": true,
"columnTemplateId": "saas_billing.provider_currency"
},
{
"id": "1470086",
"displayName": "Provider ID",
"groupable": true,
"columnTemplateId": "saas_billing.provider_id"
},
{
"id": "1470110",
"displayName": "Reseller External ID",
"groupable": true,
"columnTemplateId": "saas_billing.reseller_external_id"
},
{
"id": "1470111",
"displayName": "Reseller External Name",
"groupable": true,
"columnTemplateId": "saas_billing.reseller_external_name"
},
{
"id": "1470081",
"displayName": "Reseller ID",
"groupable": true,
"columnTemplateId": "saas_billing.reseller_id"
},
{
"id": "1470108",
"displayName": "Sales Price Of Unit",
"groupable": true,
"columnTemplateId": "saas_billing.sales_price_of_unit"
},
{
"id": "1470113",
"displayName": "Seat Count",
"groupable": true,
"columnTemplateId": "saas_billing.seat_count"
},
{
"id": "1470082",
"displayName": "Seller Cost",
"columnTemplateId": "saas_billing.seller_cost"
},
{
"id": "1470094",
"displayName": "Seller Cost (Invoiced Currency)",
"columnTemplateId": "saas_billing.seller_cost_invoice"
},
{
"id": "1470093",
"displayName": "Seller Cost (Provider Currency)",
"columnTemplateId": "saas_billing.seller_cost_raw"
},
{
"id": "1470085",
"displayName": "Usage Quantity",
"columnTemplateId": "saas_billing.usage_quantity"
}
],
"dateRangeOption": {
"selectedRange": {
"relativeDateRange": "Two_months_ago",
"relativeActualDateRange": {
"startDate": "2024-07-01T00:00:00Z",
"endDate": "2024-07-11T00:00:00Z"
}
}
},
"currencyOption": {
"availableCurrencies": [
{
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
{
"code": "AUD",
"symbol": "$",
"name": "Australian Dollar",
"displayOrder": 2
},
{
"code": "CAD",
"symbol": "$",
"name": "Canadian Dollar",
"displayOrder": 4
},
{
"code": "CHF",
"symbol": "CHF",
"name": "Swiss Franc",
"displayOrder": 9
},
{
"code": "SGD",
"symbol": "$",
"name": "Singapore Dollar",
"displayOrder": 11
},
{
"code": "MYR",
"symbol": "MYR",
"name": "Malaysian Ringgits",
"displayOrder": 21
},
{
"code": "ALL",
"symbol": "Lek",
"name": "Albanian Lek",
"displayOrder": 34
},
{
"code": "AMD",
"symbol": "֏",
"name": "Armenian dram",
"displayOrder": 44
}
],
"selectedCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
}
},
"customerFieldKeys": [
{
"displayName": "AutomationField123",
"uniqueKey": "AutomationTest070520240307"
},
{
"displayName": "Automation_TestCustomField",
"uniqueKey": "Test_Fields_0506020327_Edited"
},
{
"displayName": "DefectValidation",
"uniqueKey": "DefectValidation"
}
],
"cloudAccountFieldKeys": [
{
"displayName": "End_Customer_PO",
"uniqueKey": "End_Customer_PO"
},
{
"displayName": "Reseller_PO",
"uniqueKey": "Reseller_PO"
}
],
"conversionRates": [
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "ALL",
"symbol": "Lek",
"name": "Albanian Lek",
"displayOrder": 34
},
"rate": 101.937980952766
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "AMD",
"symbol": "֏",
"name": "Armenian dram",
"displayOrder": 44
},
"rate": 522.682440314502
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "AUD",
"symbol": "$",
"name": "Australian Dollar",
"displayOrder": 2
},
"rate": 1.290283697449
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "CAD",
"symbol": "$",
"name": "Canadian Dollar",
"displayOrder": 4
},
"rate": 1.269300676828
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "CHF",
"symbol": "CHF",
"name": "Swiss Franc",
"displayOrder": 9
},
"rate": 0.890242412315
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "MYR",
"symbol": "MYR",
"name": "Malaysian Ringgits",
"displayOrder": 21
},
"rate": 4.041399936005
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "SGD",
"symbol": "$",
"name": "Singapore Dollar",
"displayOrder": 11
},
"rate": 1.324824808439
},
{
"fromCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"toCurrency": {
"code": "USD",
"symbol": "$",
"name": "U.S. Dollar",
"displayOrder": 1
},
"rate": 1,
"isDefault": true
}
]
},
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"12",
"14",
"34",
"28",
"33",
"36"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
}
Path Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
String | Reseller ID in CCP. | 1234 | Yes |
report_Id |
String | Report ID. | 56789 | Yes |
Request Parameters Description:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
reportId |
String | The report ID. | Numeric value such as 1234 |
displayName |
String | The name of the report that is displayed on the UI. | AWS billing report |
category |
String | Specifies the type of report and helps to organize reports in the UI. | Billing_Reports |
createdBy |
String | Specifies the author of the report. | System |
lastUpdatedBy |
String | Specifies the latest editor of the report. | System |
specs |
Object | Report setting that the user specifies. | The elements in the specs object |
createTime |
String | The time when the report is created, in YYYY-MM-DD HH:Min format. | 0001-01-01T00:00:00Z |
providerIds |
Array | The cloud provider ID. | 30 |
reportTemplateId |
String | An identifier for a specific report layout. | Azure_Plan_Billing |
reportModule |
String | The modules that use the reports service. | Values such as
|
Elements in the specs object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
allColumns |
Array | All available columns for this report. | The elements in the allColumns array list |
dateRangeOption |
Object | The available and selected date ranges for the report. | The elements in the dateRangeOption object |
currencyOption |
Object | The available and selected currencies for the report. | The elements in the currencyOption object |
customerFieldKeys |
Array | Specifies the list of available custom fields linked to the customers for the corresponding account | The elements in the customerFieldKeys array list |
cloudAccountKeys |
Array | Specifies the list of cloud accounts (SubscriptionIDs) linked to the customer. | The elements in the cloudAccountKeys array list |
conversionRates |
Array | Consists of conversion rates which can be used to convert money values from one currency to another. Note: This field is dynamically populated by the API, but the values are not saved in the system. | The elements in the conversionRates array list |
Elements in the allColumns array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | Numeric value such as 123456 |
displayName |
String | The name of the column that is displayed on UI. | Availability ID |
groupable |
Boolean | Indicates whether the data in this column can be grouped in the report output. If set to true, the column can be used for grouping data rows. | Values such as True or False |
columnTamplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the dateRangeOption object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
selectedRange |
Object | Indicates the reporting period of the data included in the report. It includes relative and fixed date range. | Values such as:
|
Elements in the selectedRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
relativeDateRange |
String | Specifies the dynamic period for the report. You can select a predefined date range instead of entering calendar inputs. | MONTH_TO_DATE |
relativeActualDateRange |
Object | Includes the startDate and endDate of the report. You can select the calendar inputs. | The elements in the relativeActualDateRange object |
Elements in the relativeActualDateRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the start date of the date range. | 2025-05-01T00:00:00Z |
endDate |
String | Specifies the end date of the date range. | 2025-05-14T00:00:00Z |
Elements in the currencyOption array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
availableCurrencies |
Array | Specifies the available currencies. | USD |
selectedCurrency |
Object | Indicates the selected currency. | USD |
Elements in the availableCurrencies array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the selectedCurrency object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the customerFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies a user-friendly name for custom fields. If the name is unavailable, set this as label. | AutomationField123 |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | AutomationFieldxxx. |
Elements in the cloudAccountFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies the user-friendly name for cloud account fields. If the name is unavailable, set this as label. | End_Customer_PO |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | End_Customer_xxx |
Elements in the conversionRates array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
fromCurrency |
Object | Indicates the source currency in which the original transaction is recorded. | The elements in the fromCurrency object |
toCurrency |
Object | Indicates the target currency in which fromCurrency amount has been converted to. | The elements in the toCurrency object |
rate |
Double Integer | Indicates the rate that is used to convert the value from the fromCurrency to the toCurrency. |
1 |
Elements in the fromCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | EUR |
symbol |
String | Currency symbol used for formatting the currency. | € |
name |
String | Name of the currency. | Euro |
displayOrder |
Integer | Display order for currency. | 5 |
Elements in the toCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency | $ |
name |
String | Name of the currency. | USD |
displayOrder |
Integer | Display order for currency. | 1 |
Sample Response
{
"reportId":"23582",
"displayName":"Microsoft CSP Billing Customers Report",
"category":"BILLING_REPORTS",
"createdBy":"System",
"lastUpdatedBy":"System",
"specs":
{
"allColumns":[
{
"id":"116712",
"displayName":"Availability ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.availability_id"
},
{
"id":"116708",
"displayName":"Azure Customer Country",
"groupable":true,
"columnTemplateId":"azure_plan_billingazure_customer_country"
},
{
"id":"116709",
"displayName":"Azure Customer ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.azure_customer_id"
},
{
"id":"153151",
"displayName":"Billing Cycle",
"groupable":true,"columnTemplateId":"azure_plan_billing.term_and_billingcycle"
},
{
"id":"158760",
"displayName":"Billing Frequency",
"groupable":true,
"columnTemplateId":"azure_plan_billing.billing_frequency"
},
{
"id":"153150",
"displayName":"Charge EndDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.usage_endtime"
},
{
"id":"153149",
"displayName":"Charge StartDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.usage_starttime"
},
{
"id":"116718",
"displayName":"Charge Type",
"groupable":true,
"columnTemplateId":"azure_plan_billing.charge_type"
},
{
"id":"1412002",
"displayName":"Charge or Savings Plan",
"groupable":true,
"columnTemplateId":"azure_plan_billing.benefit_type"
},
{
"id":"116694",
"displayName":"Cloud Account Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.cloud_account_name"
},
{
"id":"116704",
"displayName":"Currency Conversion Rates",
"groupable":true,
"columnTemplateId":"azure_plan_billing.conversion_rates"
},
{
"id":"116676",
"displayName":"Customer Company",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_company_name"
},
{
"id":"1434946",
"displayName":"Customer Company Reseller",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_company_name_reseller"
},
{
"id":"116684",
"displayName":"Customer Cost",
"columnTemplateId":"azure_plan_billing.customer_cost"
},
{
"id":"116699",
"displayName":"Customer Cost (Invoiced Currency)",
"columnTemplateId":"azure_plan_billing.customer_cost_invoice"
},
{
"id":"116698",
"displayName":"Customer Cost (Provider Currency)",
"columnTemplateId":"azure_plan_billing.customer_cost_raw"
},
{
"id":"116696",
"displayName":"Customer Country",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_country"
},
{
"id":"116674",
"displayName":"Customer ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_id"
},
{
"id":"116675",
"displayName":"Customer Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.unique_name"
},
{
"id":"116697",
"displayName":"Customer State",
"groupable":true,
"columnTemplateId":"azure_plan_billing.customer_state"
},
{
"id":"122070",
"displayName":"Discount Rate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.discount_rate"
},
{
"id":"148041",
"displayName":"Domain Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.domain_name"
},
{
"id":"1422786",
"displayName":"Effective Unit Price",
"groupable":true,
"columnTemplateId":"azure_plan_billing.effective_unit_price"
},
{
"id":"1035708",
"displayName":"Entitlement Description",
"groupable":true,
"columnTemplateId":"azure_plan_billing.entitlement_description"
},
{
"id":"122069",
"displayName":"EntitlementID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.entitlement_id"
},
{
"id":"116671",
"displayName":"Group Tag ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.group_tag_id"
},
{
"id":"116672",
"displayName":"Group Tag Label",
"groupable":true,
"columnTemplateId":"azure_plan_billing.group_tag_label"
},
{
"id":"116706",
"displayName":"Invoice Currency",
"groupable":true,
"columnTemplateId":"azure_plan_billing.invoice_currency"
},
{
"id":"116707",
"displayName":"Invoice Number",
"groupable":true,
"columnTemplateId":"azure_plan_billing.invoice_number"
},
{
"id":"116713",
"displayName":"MPN ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.mpn_id"
},
{
"id":"1430286",
"displayName":"MSRP",
"columnTemplateId":"azure_plan_billing.msrp_cost"
},
{
"id":"116685",
"displayName":"Margin",
"columnTemplateId":"azure_plan_billing.margin"
},
{
"id":"116703",
"displayName":"Margin (Invoiced Currency)",
"columnTemplateId":"azure_plan_billing.margin_invoice"
},
{
"id":"116702",
"displayName":"Margin (Provider Currency)",
"columnTemplateId":"azure_plan_billing.margin_raw"
},
{
"id":"116682",
"displayName":"Meter Category",
"groupable":true,
"columnTemplateId":"azure_plan_billing.meter_category"
},
{
"id":"116691",
"displayName":"Meter ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.meter_id"
},
{
"id":"116681",
"displayName":"Meter Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.meter_name"
},
{
"id":"116687",
"displayName":"Meter Sub Category",
"groupable":true,
"columnTemplateId":"azure_plan_billing.meter_sub_category"
},
{
"id":"116690",
"displayName":"Metered Region",
"groupable":true,
"columnTemplateId":"azure_plan_billing.metered_region"
},
{
"id":"1487669",
"displayName":"Mfg Part Number",
"groupable":true,
"columnTemplateId":"azure_plan_billing.mfg_part_number"
},
{
"id":"153152",
"displayName":"Order Date",
"groupable":true,
"columnTemplateId":"azure_plan_billing.order_date"
},
{
"id":"1035707",
"displayName":"Order Number",
"groupable":true,
"columnTemplateId":"azure_plan_billing.order_number"
},
{
"id":"1508207",
"displayName":"Override Effective Date",
"groupable":true,
"columnTemplateId":"azure_plan_billing.override_effective_date"
},
{
"id":"1508208",
"displayName":"Override End Date",
"groupable":true,
"columnTemplateId":"azure_plan_billing.override_end_date"
},
{
"id":"469068",
"displayName":"PAC of Origin",
"groupable":true,
"columnTemplateId":"azure_plan_billing.pac_of_origin"
},
{
"id":"150431",
"displayName":"Period Quantity",
"groupable":true,
"columnTemplateId":"azure_plan_billing.period_quantity"
},
{
"id":"1499875",
"displayName":"Price Change",
"groupable":true,
"columnTemplateId":"azure_plan_billing.price_change"
},
{
"id":"1499876",
"displayName":"Price Change Value",
"groupable":true,
"columnTemplateId":"azure_plan_billing.price_change_value"
},
{
"id":"116677",
"displayName":"Price book",
"groupable":true,
"columnTemplateId":"azure_plan_billing.price_book"
},
{
"id":"116678",
"displayName":"Price book ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.price_book_id"
},
{
"id":"116710",
"displayName":"Product ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.product_id"
},
{
"id":"116715",
"displayName":"Product Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.product_name"
},
{
"id":"158759",
"displayName":"Promotion EndDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.promotion_enddate"
},
{
"id":"152096",
"displayName":"Promotion Rate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.promotion_rate"
},
{
"id":"158758",
"displayName":"Promotion StartDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.promotion_startdate"
},
{
"id":"152095",
"displayName":"PromotionID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.promotion_id"
},
{
"id":"116705",
"displayName":"Provider Currency",
"groupable":true,
"columnTemplateId":"azure_plan_billing.provider_currency"
},
{
"id":"121566",
"displayName":"Publisher ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.publisher_id"
},
{
"id":"121565",
"displayName":"Publisher Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.publisher_name"
},
{
"id":"1415206",
"displayName":"Rate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.rate"
},
{
"id":"116689",
"displayName":"Region",
"groupable":true,
"columnTemplateId":"azure_plan_billing.region"
},
{
"id":"116670",
"displayName":"Reseller ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.reseller_id"
},
{
"id":"116714",
"displayName":"Reseller MPN ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.reseller_mpn_id"
},
{
"id":"116673",
"displayName":"Reseller Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.reseller_name"
},
{
"id":"147735",
"displayName":"Reservation Order ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.reservation_order_id"
},
{
"id":"116680",
"displayName":"Resource Group",
"groupable":true,
"columnTemplateId":"azure_plan_billing.resource_group"
},
{
"id":"116692",
"displayName":"Resource URI",
"groupable":true,
"columnTemplateId":"azure_plan_billing.resource_uri"
},
{
"id":"116711",
"displayName":"SKU ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.sku_id"
},
{
"id":"116716",
"displayName":"SKU Name",
"groupable":true,
"columnTemplateId":"azure_plan_billing.sku_name"
},
{
"id":"1412001",
"displayName":"Savings Plan ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.benefit_id"
},
{
"id":"1412000",
"displayName":"Savings Plan Order ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.benefit_order_id"
},
{
"id":"950384",
"displayName":"Seat Count",
"groupable":true,
"columnTemplateId":"azure_plan_billing.seat_count"
},
{
"id":"897807",
"displayName":"Segment",
"groupable":true,
"columnTemplateId":"azure_plan_billing.segment"
},
{
"id":"116683",
"displayName":"Seller Cost",
"columnTemplateId":"azure_plan_billing.seller_cost"
},
{
"id":"116701",
"displayName":"Seller Cost (Invoiced Currency)",
"columnTemplateId":"azure_plan_billing.seller_cost_invoice"
},
{
"id":"116700",
"displayName":"Seller Cost (Provider Currency)",
"columnTemplateId":"azure_plan_billing.seller_cost_raw"
},
{
"id":"153148",
"displayName":"Subscription EndDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.subscription_enddate"
},
{
"id":"116679",
"displayName":"Subscription ID",
"groupable":true,
"columnTemplateId":"azure_plan_billing.cloud_account_number"
},
{
"id":"153147",
"displayName":"Subscription StartDate",
"groupable":true,
"columnTemplateId":"azure_plan_billing.subscription_startdate"
},
{
"id":"116717",
"displayName":"Term And Billing Cycle",
"groupable":true,
"columnTemplateId":"azure_plan_billing.term_and_billing_cycle"
},
{
"id":"116695",
"displayName":"Type",
"groupable":true,
"columnTemplateId":"azure_plan_billing.type"
},
{
"id":"116688",
"displayName":"Unit",
"groupable":true,
"columnTemplateId":"azure_plan_billing.unit"
},
{
"id":"1415205",
"displayName":"Unit Price",
"groupable":true,
"columnTemplateId":"azure_plan_billing.unit_price"
},
{
"id":"116686",
"displayName":"Usage Quantity",
"columnTemplateId":"azure_plan_billing.usage"
},
{
"id":"121564",
"displayName":"Usage Type",
"groupable":true,
"columnTemplateId":"azure_plan_billing.usage_type"
}
],
"selectedColumns":[
{
"id":"116675",
"displayName":"Customer Name",
"groupingLevel":1,
"isInvoiceKey":true,
"valueType":"STRING",
"columnHeading":"Customer Name",
"columnTemplateId":"azure_plan_billing.unique_name"
},
{
"id":"121565",
"displayName":"Publisher Name",
"groupingLevel":2,
"valueType":"STRING",
"columnHeading":"Publisher Name",
"columnTemplateId":"azure_plan_billing.publisher_name"
},
{
"id":"116694",
"displayName":"Cloud Account Name",
"groupingLevel":3,
"valueType":"STRING",
"columnHeading":"Cloud Account Name",
"columnTemplateId":"azure_plan_billing.cloud_account_name"
},
{
"id":"116715",
"displayName":"Product Name",
"groupingLevel":4,
"valueType":"STRING",
"columnHeading":"Product Name",
"columnTemplateId":"azure_plan_billing.product_name"
},
{
"id":"116716",
"displayName":"SKU Name",
"groupingLevel":5,
"valueType":"STRING",
"columnHeading":"SKU Name",
"columnTemplateId":"azure_plan_billing.sku_name"
},
{
"id":"116717",
"displayName":"Term And Billing Cycle",
"groupingLevel":6,
"valueType":"STRING",
"columnHeading":"Term And Billing Cycle",
"columnTemplateId":"azure_plan_billing.term_and_billing_cycle"
},
{
"id":"116677",
"displayName":"Price book",
"valueType":"STRING",
"columnHeading":"Price book",
"columnTemplateId":"azure_plan_billing.price_book"
},
{
"id":"116683",
"displayName":"Seller Cost",
"aggType":"SUM_COLUMN_AGGREGATION_TYPE",
"valueType":"MONEY",
"columnHeading":"Seller Cost (USD)",
"columnTemplateId":"azure_plan_billing.seller_cost"
},
{
"id":"116684",
"displayName":"Customer Cost",
"aggType":"SUM_COLUMN_AGGREGATION_TYPE",
"valueType":"MONEY",
"columnHeading":"Customer Cost (USD)",
"columnTemplateId":"azure_plan_billing.customer_cost"
},
{
"id":"116685",
"displayName":"Margin",
"aggType":"SUM_COLUMN_AGGREGATION_TYPE",
"valueType":"MONEY",
"columnHeading":"Margin (USD)",
"columnTemplateId":"azure_plan_billing.margin"
},
{
"id":"116686",
"displayName":"Usage Quantity",
"aggType":"SUM_COLUMN_AGGREGATION_TYPE",
"valueType":"FLOAT",
"columnHeading":"Usage Quantity",
"columnTemplateId":"azure_plan_billing.usage"
},
{
"id":"116688",
"displayName":"Unit",
"valueType":"STRING",
"columnHeading":"Unit",
"columnTemplateId":"azure_plan_billing.unit"
},
{
"id":"116689",
"displayName":"Region",
"valueType":"STRING",
"columnHeading":"Region",
"columnTemplateId":"azure_plan_billing.region"
},
{
"id":"950384",
"displayName":"Seat Count",
"valueType":"FLOAT",
"columnHeading":"Seat Count",
"columnTemplateId":"azure_plan_billing.seat_count"
}
],
"columnFilters":[
{
"id":"116675",
"displayName":"Customer Name",
"columnTemplateId":"azure_plan_billing.unique_name"
},
{
"id":"121565",
"displayName":"Publisher Name",
"columnTemplateId":"azure_plan_billing.publisher_name"
},
{
"id":"116694",
"displayName":"Cloud Account Name",
"columnTemplateId":"azure_plan_billing.cloud_account_name"
},
{
"id":"116677",
"displayName":"Price book",
"columnTemplateId":"azure_plan_billing.price_book"
},
{
"id":"116689",
"displayName":"Region",
"columnTemplateId":"azure_plan_billing.region"
}
],
"dateRangeOption":
{
"selectedRange":
{
"relativeDateRange":"MONTH_TO_DATE",
"relativeActualDateRange":
{
"startDate":"2025-05-01T00:00:00Z",
"endDate":"2025-05-14T00:00:00Z"
}
}
},
"currencyOption":
{
"availableCurrencies":
[
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
{
"code":"AUD",
"symbol":"$",
"name":"Australian Dollar",
"displayOrder":2
},
{
"code":"CAD",
"symbol":"$",
"name":"Canadian Dollar",
"displayOrder":4
},
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
{
"code":"CHF",
"symbol":"CHF",
"name":"Swiss Franc",
"displayOrder":9
},
{
"code":"SGD",
"symbol":"$",
"name":"Singapore Dollar",
"displayOrder":11
},
{
"code":"MYR",
"symbol":"MYR",
"name":"Malaysian Ringgits",
"displayOrder":21
},
{
"code":"INR",
"symbol":"₹",
"name":"Indian Rupee",
"displayOrder":24
},
{
"code":"VND",
"symbol":"₫",
"name":"Vietnamese đồng",
"displayOrder":26
},
{
"code":"ALL",
"symbol":"Lek",
"name":"Albanian Lek",
"displayOrder":34
},
{
"code":"AMD",
"symbol":"֏",
"name":"Armenian dram",
"displayOrder":44
}
],
"selectedCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
}
},
"customerFieldKeys":
[
{
"displayName":"AutomationField123",
"uniqueKey":"AutomationTest070520240307"
},
{
"displayName":"Automation_TestCustomField",
"uniqueKey":"Test_Fields_0506020327_Edited_20240716"
},
{
"displayName":"CIS_ID",
"uniqueKey":"CIS_ID"
},
{
"displayName":"Consolidation_Type",
"uniqueKey":"Consolidation_Type"
},
{
"displayName":"DefectValidation",
"uniqueKey":"DefectValidation"
},
{
"displayName":"Microsoft_ResellerPO",
"uniqueKey":"Microsoft_ResellerPO"
},
{
"displayName":"SAP ID",
"uniqueKey":"SAP_ID"
}
],
"cloudAccountFieldKeys":
[
{
"displayName":"End_Customer_PO",
"uniqueKey":"End_Customer_PO"
},
{
"displayName":"GNH",
"uniqueKey":"GNH"
},
{
"displayName":"Reseller_1PO",
"uniqueKey":"Reseller1_PO"
},
{
"displayName":"Reseller_PO",
"uniqueKey":"Reseller_PO"
}
],
"conversionRates":
[
{
"fromCurrency":
{
"code":"AUD",
"symbol":"$",
"name":"Australian Dollar",
"displayOrder":2
},
"toCurrency":
{
"code":"AUD",
"symbol":"$",
"name":"Australian Dollar",
"displayOrder":2
},
"rate":1
},
{
"fromCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"toCurrency":
{
"code":"CAD",
"symbol":"$",
"name":"Canadian Dollar",
"displayOrder":4
},
"rate":1.511186389847
},
{
"fromCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"toCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"rate":1
},
{
"fromCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"toCurrency":
{
"code":"INR",
"symbol":"₹",
"name":"Indian Rupee",
"displayOrder":24
},
"rate":92.984482469384
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"ALL",
"symbol":"Lek",
"name":"Albanian Lek",
"displayOrder":34
},
"rate":90.21199819576
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"AMD",
"symbol":"֏",
"name":"Armenian dram",
"displayOrder":44
},
"rate":388.048117966628
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"AUD",
"symbol":"$",
"name":"Australian Dollar",
"displayOrder":2
},
"rate":1.484979433035
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{"code":"CAD",
"symbol":"$",
"name":"Canadian Dollar",
"displayOrder":4
},
"rate":1.363196422973
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"CHF",
"symbol":"CHF",
"name":"Swiss Franc",
"displayOrder":9
},
"rate":0.862597678405
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"EUR",
"symbol":"€",
"name":"Euro",
"displayOrder":5
},
"rate":1.25
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"MYR",
"symbol":"MYR",
"name":"Malaysian Ringgits",
"displayOrder":21
},
"rate":4.377497909745
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"SGD",
"symbol":"$",
"name":"Singapore Dollar",
"displayOrder":11
},
"rate":1.308034207711
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"rate":1,
"isDefault":true
},
{
"fromCurrency":
{
"code":"USD",
"symbol":"$",
"name":"U.S. Dollar",
"displayOrder":1
},
"toCurrency":
{
"code":"VND",
"symbol":"₫",
"name":"Vietnamese đồng",
"displayOrder":26
},
"rate":25000
}
],
"importsStatus":
{
"imports":
[
{
"details":"MpnIDs: 5462014",
"billingMonth":"2025-05-01T00:00:00Z",
"ranAt":"2025-05-14T10:13:46Z"
}
]
}
},
"createTime":"0001-01-01T00:00:00Z",
"providerIds":["30"],
"reportTemplateId":"azure_plan_billing",
"reportModule":"REPORTS_REPORTS_MODULE"
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
reportId |
String | The report ID. | Numeric value such as 1234 |
displayName |
String | The name of the report that is displayed on the UI. | AWS billing report |
category |
String | Specifies the type of report and helps to organize reports in the UI. | Billing_Reports |
createdBy |
String | Specifies the author of the report. | System |
lastUpdatedBy |
String | Specifies the latest editor of the report. | System |
specs |
Object | Report setting that the user specifies. | The elements in the specs object |
createTime |
String | The time when the report is created, in YYYY-MM-DD HH:Min format. | 0001-01-01T00:00:00Z |
providerIds |
Array | The cloud provider ID. | 30 |
reportTemplateId |
String | An identifier for a specific report layout. | Azure_Plan_Billing |
reportModule |
String | The modules that use the reports service. | Values such as
|
Elements in the specs object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
allColumns |
Array | All available columns for this report. | The elements in the allColumns array list |
selectedColumns |
Array | All selected columns for this report. | The elements in the selectedColumns array list |
columnFilters |
Array | Filters the report data using predefined filters such as customerName, pricebook, region, and so on. | The elements in the columnFilters array list |
dateRangeOption |
Object | The available and selected date ranges for the report. | The elements in the dateRangeOption object |
currencyOption |
Object | The available and selected currencies for the report. | The elements in the currencyOption object |
customerFieldKeys |
Array | Specifies the list of available custom fields linked to the customers for the corresponding account | The elements in the customerFieldKeys array list |
cloudAccountKeys |
Array | Specifies the list of cloud accounts (SubscriptionIDs) linked to the customer. | The elements in the cloudAccountKeys array list |
conversionRates |
Array | Consists of conversion rates which can be used to convert money values from one currency to another. Note: This field is dynamically populated by the API, but the values are not saved in the system. | The elements in the conversionRates array list |
importStatus |
Object | Specifies the details of the data import process. | The elements in the importStatus object |
Elements in the allColumns array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | Numeric value such as 123456 |
displayName |
String | The name of the column that is displayed on UI. | Availability ID |
groupable |
Boolean | Indicates whether the data in this column can be grouped in the report output. If set to true, the column can be used for grouping data rows. | Values such as True or False |
columnTamplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the selectedColumns array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | Numeric value such as 123456 |
displayName |
String | The name of the column that is displayed on UI. | Customer Name |
groupingLevel |
Integer | Indicates the hierarchical level of data grouping applied in the report. | Value 1 indicates the hierarchy is highest, followed by level 2, 3, and so on |
isInvoiceKey |
Boolean | Specifies whether the associated field serves as a key identifier for invoice generation or matching. | Values such as True or False |
valueType |
String | Indicates the data type of the value in a specific field. | Integer, String, Boolean and so on |
columnHeading |
String | The name of the column that is displayed on UI. | Customer Name |
columnTemplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the columnFilters array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
id |
String | A unique identifier for a report column that is uniform for ReportColumn, ReportColumnDetail and ReportColumnFilter. | 123456. |
displayName |
String | The name of the column that is displayed on UI. | Customer Name |
columnTemplateId |
String | An identifier of the column template with the form. This is unique across all column templates. Its value must match across ReportColumn, ReportColumnDetail, and ReportColumnFilter. | aws_billing_summary.customer_cost |
Elements in the dateRangeOption object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
selectedRange |
Object | Indicates the reporting period of the data included in the report. It includes relative and fixed date range. | Values such as:
|
Elements in the selectedRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
relativeDateRange |
String | Specifies the dynamic period for the report. You can select a predefined date range instead of entering calendar inputs. | MONTH_TO_DATE |
relativeActualDateRange |
Object | Includes the startDate and endDate of the report. You can select the calendar inputs. | The elements in the relativeActualDateRange object |
Elements in the relativeActualDateRange object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
startDate |
String | Specifies the start date of the date range. | 2025-05-01T00:00:00Z |
endDate |
String | Specifies the end date of the date range. | 2025-05-14T00:00:00Z |
Elements in the currencyOption array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
availableCurrencies |
Array | Specifies the available currencies. | USD |
selectedCurrency |
Object | Indicates the selected currency. | USD |
Elements in the availableCurrencies array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the selectedCurrency object
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency. | $ |
name |
String | Name of the currency. | U.S. Dollar |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the customerFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies a user-friendly name for custom fields. If the name is unavailable, set this as label. | AutomationField123 |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | AutomationFieldxxx. |
Elements in the cloudAccountFieldKeys array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
displayName |
String | Specifies the user-friendly name for cloud account fields. If the name is unavailable, set this as label. | End_Customer_PO |
uniqueKey |
String | A system-defined identifier that uniquely references the field internally. | End_Customer_xxx |
Elements in the conversionRates array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
fromCurrency |
Object | Indicates the source currency in which the original transaction is recorded. | The elements in the fromCurrency object |
toCurrency |
Object | Indicates the target currency in which fromCurrency amount has been converted to. | The elements in the toCurrency object |
rate |
Double Integer | Indicates the rate that is used to convert the value from the fromCurrency to the toCurrency. |
1 |
Elements in the fromCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | EUR |
symbol |
String | Currency symbol used for formatting the currency. | € |
name |
String | Name of the currency. | Euro |
displayOrder |
Integer | Display order for currency. | 5 |
Elements in the toCurrency array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
code |
String | Three-character ISO 4217 currency code. (http://www.iso.org/iso/home/standards/currency_codes.htm). | USD |
symbol |
String | Currency symbol used for formatting the currency | $ |
name |
String | Name of the currency. | USD |
displayOrder |
Integer | Display order for currency. | 1 |
Elements in the importStatus array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
imports |
Array | Includes import details of the report. | The elements in the imports array list |
Elements in the imports array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
details |
String | Reseller Id. | MpnIDs: 123456 |
billingMonth |
String | Current month of billing. | 2025-05-01T00:00:00Z |
ranAt |
String | The time when the data is imported into the ION system. | 2025-05-14T10:13:46Z |
Sample Response - Error 400 { "error": "INVALID_REQUEST", "message": "must have required property 'orgName'", "code": 400, "details": [ { "@type": "type.googleapis.com/google.rpc.RequestInfo", "requestId": "176efaa5115cd4d84048" } ] }
**Response Parameters: Error 400 - Invalid Request**
|Parameter|Data Type|Description|Example|
|---------|---------|-----------|-------|
|`error`|String|Error title.|INVALID_REQUEST|
|`message`|String|Error description.|Must have required property 'orgName'.|
|`code`|String|Error code.|400|
|`details`|Array|Additional details regarding the request.|The elements in the `details` array list.|
**Elements in the `details` array list**
|Parameter|Data Type|Description|Example|
|---------|---------|-----------|-------|
|`@type`|String|Specifies the requested customer information.|type.googleapis.com/google.rpc.RequestInfo|
|`requestId`|String|Unique request ID.|123abcd5115cd4d84048|
```json
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error. |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
List Reports
Using the List Reports endpoint, you can retrieve list of reports that are available for a specific account.
HTTP Endpoint URL: GET https://ion.tdsynnex.com/api/v3/accounts/{accountId}/reports
Sample Request:
curl --request GET \
--url 'https://ion.tdsynnex.com/api/v3/accounts/%7BaccountId%7D/reports?module=SOME_STRING_VALUE'
Request Parameter Description:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
accountId |
Integer | Reseller ID in Cloud Commerce Platform. | 1234 | Yes |
Query Parameters:
| Parameter | Data Type | Description | Example | Required |
|---|---|---|---|---|
module |
String | The modules that use the reports service. | Values such as
|
No |
Sample Response:
{
"reports": [
{
"reportId": "10001",
"displayName": "Activity Log Price Override Report",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "0001-01-01T00:00:00Z",
"reportTemplateId": "activity_log_price_override",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10002",
"displayName": "Activity Log Report",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2019-07-10T17:21:18Z",
"reportTemplateId": "activity_log",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10003",
"displayName": "QA 0723063758",
"category": "CUSTOMER_REPORTS",
"createdBy": "krunal.ghodake",
"lastUpdatedBy": "krunal.ghodake",
"createTime": "2019-07-10T17:21:18Z",
"reportTemplateId": "activity_log",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10004",
"displayName": "Sales - Copy of Activity Log Report",
"category": "CUSTOMER_REPORTS",
"createdBy": "Sales Manager",
"lastUpdatedBy": "Sales Manager",
"createTime": "2019-07-10T17:21:18Z",
"reportTemplateId": "activity_log",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "20005",
"displayName": "AWS Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-06-05T15:42:53Z",
"providerIds": [
"1"
],
"reportTemplateId": "aws_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10005",
"displayName": "Microsoft CSP Billing Customers Report Custom date range 01",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:53Z",
"providerIds": [
"1"
],
"reportTemplateId": "aws_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10006",
"displayName": "AWS Free Tier Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "0001-01-01T00:00:00Z",
"providerIds": [
"1"
],
"reportTemplateId": "aws_free_tier",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10007",
"displayName": "AWS InLine Credits Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "0001-01-01T00:00:00Z",
"providerIds": [
"1"
],
"reportTemplateId": "billing_credits_report",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10008",
"displayName": "AWS Regional RI Optimization Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-11-16T21:00:40Z",
"providerIds": [
"1"
],
"reportTemplateId": "aws_ri_opt",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10009",
"displayName": "AWS Reserved Instance Allocation Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2019-02-07T05:05:59Z",
"providerIds": [
"1"
],
"reportTemplateId": "aws_ri_allocation",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "20008",
"displayName": "AWS Reserved Instance Inventory Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"1"
],
"reportTemplateId": "aws_ri_inventory",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10010",
"displayName": "Cloud Accounts Report",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2019-04-25T00:17:21Z",
"reportTemplateId": "cloud_accounts",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10011",
"displayName": "Copy of Cloud Accounts Report1",
"category": "CUSTOMER_REPORTS",
"createdBy": "krunal.ghodake",
"lastUpdatedBy": "krunal.ghodake",
"createTime": "2019-04-25T00:17:21Z",
"reportTemplateId": "cloud_accounts",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10012",
"displayName": "Customer EULA Report",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-11-02T18:39:20Z",
"reportTemplateId": "customer_eulas",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "11013",
"displayName": "Customer Test Drive Report",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-11-02T18:39:20Z",
"reportTemplateId": "customer_test_drives",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "20105",
"displayName": "Customers Subscriptions Report",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-11-02T18:39:20Z",
"reportTemplateId": "customer_subscriptions",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "20016",
"displayName": "GCP Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"2"
],
"reportTemplateId": "gcp_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "20007",
"displayName": "Legacy Azure Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"3"
],
"reportTemplateId": "azure_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "20819",
"displayName": "Marketplace Transaction Report",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2018-12-21T04:18:43Z",
"reportTemplateId": "customer_marketplace_transactions",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "21080",
"displayName": "Marketplace Transaction Report (Products V2)",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2019-02-21T17:34:05Z",
"reportTemplateId": "marketplace_transactions_v2",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10014",
"displayName": "Marketplace Transaction Report (V3)",
"category": "CUSTOMER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "0001-01-01T00:00:00Z",
"reportTemplateId": "marketplace_transactions_v3",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10015",
"displayName": "Microsoft CSP Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "0001-01-01T00:00:00Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10016",
"displayName": " 517273 Demo 01/16 VP Reseller ",
"category": "BILLING_REPORTS",
"createdBy": "New SMP Reseller",
"lastUpdatedBy": "New SMP Reseller",
"createTime": "2025-01-15T19:43:31Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10017",
"displayName": "Microsoft by Usage Type",
"category": "BILLING_REPORTS",
"createdBy": "New SMP Reseller",
"lastUpdatedBy": "New SMP Reseller",
"createTime": "2025-03-14T03:41:55Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10018",
"displayName": "Microsoft CSP Billing Customers Report -NCE Product",
"category": "BILLING_REPORTS",
"createdBy": "New SMP Reseller",
"lastUpdatedBy": "New SMP Reseller",
"createTime": "2024-08-29T05:56:07Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10019",
"displayName": "Microsoft CSP Billing Customers Report change currency",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2024-07-15T12:36:47Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10020",
"displayName": "MM New column report",
"category": "BILLING_REPORTS",
"createdBy": "New SMP Reseller",
"lastUpdatedBy": "New SMP Reseller",
"createTime": "2025-01-02T10:47:52Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10021",
"displayName": "Price override check - Example",
"category": "BILLING_REPORTS",
"createdBy": "New SMP Reseller",
"lastUpdatedBy": "New SMP Reseller",
"createTime": "2024-09-10T10:08:03Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10022",
"displayName": "SaaS Billing Customers Report Group",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2024-07-11T14:11:24Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10023",
"displayName": "SDS Report",
"category": "BILLING_REPORTS",
"createdBy": "Sagar Salvi",
"lastUpdatedBy": "Sagar Salvi",
"createTime": "2024-08-05T09:21:38Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10024",
"displayName": "SSGREPORT1",
"category": "BILLING_REPORTS",
"createdBy": "Sidda Reddy",
"lastUpdatedBy": "Sidda Reddy",
"createTime": "2024-08-05T09:21:38Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10025",
"displayName": "Subscription EndDate centered report",
"category": "BILLING_REPORTS",
"createdBy": "Joan Rubies",
"lastUpdatedBy": "Joan Rubies",
"createTime": "2024-07-18T08:55:42Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10026",
"displayName": "Microsoft CSP RI Inventory Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "0001-01-01T00:00:00Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_ri_inventory",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10027",
"displayName": "Copy of Microsoft CSP RI Inventory Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "krishna",
"lastUpdatedBy": "krishna",
"createTime": "2025-02-13T22:48:52Z",
"providerIds": [
"30"
],
"reportTemplateId": "azure_plan_ri_inventory",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "20601",
"displayName": "Partner EULA Report",
"category": "PARTNER_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2018-09-26T18:05:52Z",
"reportTemplateId": "partner_eulas",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10027",
"displayName": "Pricebooks Allocation Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "0001-01-01T00:00:00Z",
"reportTemplateId": "pricebooks_report",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "20015",
"displayName": "SaaS Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "System",
"lastUpdatedBy": "System",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"12",
"14",
"28",
"33",
"19",
"34",
"36"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10028",
"displayName": "IBM KS Report March 2025",
"category": "BILLING_REPORTS",
"createdBy": "New SMP Reseller",
"lastUpdatedBy": "New SMP Reseller",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"19",
"34",
"36",
"12",
"14",
"28",
"33"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10029",
"displayName": "KS July 2024 Report AvePoint",
"category": "BILLING_REPORTS",
"createdBy": "New SMP Reseller",
"lastUpdatedBy": "New SMP Reseller",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"19",
"34",
"36",
"12",
"14",
"28",
"33"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10030",
"displayName": "MM IBM Report",
"category": "BILLING_REPORTS",
"createdBy": "New SMP Reseller",
"lastUpdatedBy": "New SMP Reseller",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"19",
"34",
"36",
"12",
"14",
"28",
"33"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10031",
"displayName": "SaaS Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"33",
"12",
"14",
"28",
"34",
"36",
"19"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10032",
"displayName": "SaaS Billing Customers Report Add Column",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"34",
"36",
"19",
"28",
"33",
"12",
"14"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10032",
"displayName": "SaaS Billing Customers Report change Currency to Australian Dollar",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"34",
"36",
"19",
"28",
"33",
"12",
"14"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10033",
"displayName": "SaaS Billing Customers Report Custom Date",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"36",
"19",
"34",
"12",
"14",
"28",
"33"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10034",
"displayName": "SaaS Billing Customers Report Custom Date",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"12",
"14",
"28",
"33",
"19",
"34",
"36"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10035",
"displayName": "SaaS Billing Customers Report filter by Customer Name",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"12",
"14",
"28",
"33",
"19",
"34",
"36"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10036",
"displayName": "SaaS Billing Customers Report filtered by PB",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"12",
"14",
"28",
"33",
"19",
"34",
"36"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10037",
"displayName": "SaaS Billing Customers Report Group",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"34",
"36",
"19",
"33",
"12",
"14",
"28"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10038",
"displayName": "SaaS Billing Customers Report Remove Column",
"category": "BILLING_REPORTS",
"createdBy": "Yogi Test API",
"lastUpdatedBy": "Yogi Test API",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"19",
"34",
"36",
"14",
"28",
"33",
"12"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
},
{
"reportId": "10039",
"displayName": "Test - Copy of SaaS Billing Customers Report",
"category": "BILLING_REPORTS",
"createdBy": "Sales Manager",
"lastUpdatedBy": "Sales Manager",
"createTime": "2017-06-05T15:42:54Z",
"providerIds": [
"19",
"34",
"36",
"14",
"28",
"33",
"12"
],
"reportTemplateId": "saas_billing",
"reportModule": "REPORTS_REPORTS_MODULE"
}
]
}
Response Parameters:
| Parameter | Data Type | Description | Example |
|---|---|---|---|
reportId |
String | The report ID. | Numeric value such as 1234 |
displayName |
String | The name of the report that is displayed on the UI. | AWS billing report |
category |
String | Specifies the type of report and helps to organize reports in the UI. | Billing_Reports |
createdBy |
String | Specifies the author of the report. | System |
lastUpdatedBy |
String | Specifies who edited the report. | System |
createTime |
String | The time when the report is created, in YYYY-MM-DD HH:Min format. | 0001-01-01T00:00:00Z |
providerIds |
Array | The cloud provider ID. | 30 |
reportTemplateId |
String | An identifier for a specific report layout. | Azure_Plan_Billing |
reportModule |
String | The modules that use the reports service. | Values such as
|
Sample Response - Error 400
{
"error": "INVALID_REQUEST",
"message": "must have required property 'orgName'",
"code": 400,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 400 - Invalid Request
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INVALID_REQUEST |
message |
String | Error description. | Must have required property 'orgName'. |
code |
String | Error code. | 400 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 403:RBACFailedError
{
"error": "PERMISSION_DENIED",
"message": "User does not have access to this resource.",
"code": 403,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 403 - RBAC Failed Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | PERMISSION_DENIED |
message |
String | Error description. | User does not have access to this resource. |
code |
String | Error code. | 403 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Sample Response - Error 500:InternalError
{
"error": "INTERNAL_ERROR",
"message": "Internal Server Error",
"code": 500,
"details": [
{
"@type": "type.googleapis.com/google.rpc.RequestInfo",
"requestId": "176efaa5115cd4d84048"
}
]
}
Response Parameters: Error 500 - Internal Error
| Parameter | Data Type | Description | Example |
|---|---|---|---|
error |
String | Error title. | INTERNAL_ERROR |
message |
String | Error description. | Internal Server Error. |
code |
String | Error code. | 500 |
details |
Array | Additional details regarding the request. | The elements in the details array list. |
Elements in the details array list
| Parameter | Data Type | Description | Example |
|---|---|---|---|
@type |
String | Specifies the requested customer information. | type.googleapis.com/google.rpc.RequestInfo |
requestId |
String | Unique request ID. | 123abcd5115cd4d84048 |
Errors
The StreamOne ION API uses the following error codes:
| Error Code | Error Message | Description | Troubleshooting Method |
|---|---|---|---|
| 400 | Bad Request | Your request is invalid. | Verify whether the request parameters are according to the API specifications. |
| 401 | Unauthorized | Your login is incorrect. | Ensure that the authentication details included in the API headers are valid. |
| 403 | Forbidden | Your request is invalid. | Check if you have the necessary permissions to access the requested data. |
| 404 | Not Found | The specified API could not be found. | Ensure that the endpoint request URL is correct. |
| 405 | Method Not Allowed | The method to access an API endpoint is invalid. | Ensure that the method used to access the endpoint is accurate. |
| 429 | Too Many Requests | You have exceeded the rate of limit for the requests. | Reduce the frequency of requests and try to access the endpoint again later. |
| 500 | Internal Server Error | An unexpected server error occured. | Please try again later. If the issue persists, contact us. |
| 503 | Service Unavailable | We are temporarily offline for maintenance. | Please try again later. If the issue persists, contact us. |