logo
API docs by Redocly

Order Placement Service (2.51)

Order Placement Service Concepts

Abstract

The Order Placement API provides the ability to manage and view order information throughout the life cycle of an order.

  • Note: Additional functionality for this purpose is being added to the newer REST API Order Management Service.

Order Placement Service Concepts

Cart Life Cycle

Carts and all the items contained within them pass through five different stages during their lifetime. The five stages to a cart are Placement, Checkout, Submission, Processing, Completion. During each of the these stages, different operations which may update the items in the cart are allowed. For example, once a cart has been successfully submitted, the cart now becomes an order that can begin processing, so starting at that point only a limited number of properties can be changed (using the ModifyOrder operation).

The intent of "Lookup" functionality is to allow the caller to locate a single cart and to optionally return detailed tabular information related to that cart, while the intent of a "Search" is to return a potentially large number of carts/orders along with minimal, non-tabular, i.e., one-to-one, data. For example, a lookup would be used to access a list of all services and features associated with a particular cart, while a search would be used for accessing just the basic order state and date information for all orders for a particular customer account or all orders for any account on a particular day.

  • Note: When different search criteria fields are specified, they are "AND"-ed together so that each additional field specified will further limit the search results. Also, when no search response elements are specified, only the minimum order search data (i.e., OrderID and OrderState) will be returned.

Paging

The amount of information retrieved from an operation may require that the resulting response be broken down into smaller sets of data. If this is the case, then a PagingInformation element can be used to specify which piece of the information the caller wants. For example a call to a search operation may yield 100 results. If, however, the search operation only allows a maximum amount of 20 results to be returned, then only the first 20 results will be returned to the caller. To retrieve the remaining results, the caller could then use PagingInformation element to specify the next sequential page to retrieve the next 20 results until all the data is retrieved or the correct value is found.

Cart Life Cycle - Placement

The placement phase begins with a CreateCart call to the OrderPlacement Service, and continues with ModifyCart calls as needed. If, after entering the Checkout phase, any modifications other than Tender information are made to the cart via ModifyCart, then the placement phase is re-entered and a Checkout call must be performed again before proceeding to submission.

Cart Life Cycle - Checkout

The checkout phase begins after the Placement phase and starts with a Checkout call to the OrderPlacement Service. Once the checkout phase has been started the system will automatically evaluate the cart and apply the following operations on it: Exclusivity Check, Promotion Assignment, Suborder Creation, Tax Evaluation, Transaction Creation. Once these operations have completed successfully the user will then be allowed to continue to the Submission phase with a Submit call. If any modifications other than Tender information are made to the cart via ModifyCart, then the placement phase is re-entered and a Checkout call must be performed again before proceeding to submission.

Exclusivity Check

Exclusivity check is the first operation performed on the cart once the cart has entered the checkout phase. The primary purpose of the exclusivity check is to ensure that any items added to the cart during Placement phase do not conflict with any other item within the cart or on the customer's account already. In the event that a conflict is detected, the system will use the appropriate date constraint options, either set by the user or set up in the system, to determine the date the new product should be added and the existing item should be removed. Once an overlap is identified, an exclusive overlap will be recorded and returned to indicate to the user that an exclusivity violation has occurred.

[Rev 1.04] Exclusivity is optionally checked on the children of existing packages. This functionality is enabled by checking the Include Package Children setting under the Customer Management tree in Administration Console. When an exclusive overlap is identified on a package child, the overlap record returned will indicate the parent package as the item to be returned. In the case where multiple child products have exclusive overlaps there will be multiple overlap records for the parent package. In this case the common convention is to use the earliest date from all the overlap records on the package as the effective date for returning the existing package and adding all new products.

Date Constraints

Date constraints can be used to dictate to the system how the start and end dates should be set in different situations. When a date constraint is used it will enable the system to delay the actual setting of the date until the Processing phase of the cart life cycle. Once the cart enters the Processing phase, the system will then re-evaluate the items in the cart and set the appropriate dates according to the options set on the cart item.

Duration Constraints

Duration constraints can be used to set end dates relative to start dates on cart items. When a duration constraint is used, the system will first calculate the start date of the cart item. Once the date is calculated it will then use the duration constraint values to calculate the appropriate end date. This allows users to set end dates that span a given amount of time regardless of when the product begins (e.g., always remain active for 3 months).

Promotion Assignment

Suborder Creation

Tax Evaluation

Transaction Creation

Cart Life Cycle - Submission

The submission phase begins after the Checkout phase and starts with a SubmitCart call to the OrderPlacement Service. Once a cart has been successfully submitted, the cart now becomes an order that can begin processing, so starting at that point only a limited number of properties can be changed (using the ModifyOrder operation).

Cart Life Cycle - Processing

The processing phase begins after the Submission phase and starts automatically based upon processing dates and times specified within the cart. Once a cart has been successfully submitted, the cart becomes an order that can begin processing, so starting at that point only a limited number of properties can be changed (using the ModifyOrder operation). Also during this phase, processing errors can occur on certain activities, generally due to conditions in external systems. The OrderLookup and ModifyTasks operations can be used to view and manage these situations.

Cart Life Cycle - Completion

Completion is the final phase of the cart life cycle and occurs automatically after the Processing phase as soon as all tasks for all activities within the order processing schedule have become Completed, Resolved, or Bypassed.

Communication Script Actions

  • Note: See the CommunicationScript entity in the Data Service's Core Data Service for the list of possible communication scripts. The results of performing operations with this web service may trigger certain scenarios in which Communication Scripts may be desired. These communication scripts may prompt the user to read a script or perform some other action as a result of a certain event.
    • Example: A customer service representative is on the phone with a customer and attempting to set up a recurring bank account for him/her. According to NACHA standards, the representative must inform the customer of certain information. To aid with this, there is a configurable script vailable for this action, and its text can be queried before the action is performed. The following are possible Communication Script Actions triggered by this web service:
ID Communication Script Action Trigger Description
1 Add Feature When a new feature is added to a customer or service.
2 Add Service When a new service is added to a customer or a sub-service is added to a service.
3 Reconnect Account When a customer account is reconnected.
4 Reconnect Feature When a feature is reconnected.
5 Reconnect Service When a service is reconnected.
6 Disconnect Account When a customer account is disconnected.
7 Disconnect Feature When a feature is disconnected.
8 Disconnect Service When a service is disconnected.
9 Port-In Request When a port-in request occurs.
10 Swap Plan When a service plan is swapped.
11 Before Port-In Request Triggered before the port-in request occurs.

Operations

Cancel Cart

Provides the ability to cancel a cart. A cart may be cancelled once it has been submitted from the system. [Rev 1.25]

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (CancelCart)

Provides the ability to cancel a cart. A cart may be cancelled once it has been submitted from the system. [Rev 1.25]

Responses

Cart Lookup

Provides the ability to retrieve a cart and its contents based on the cart ID.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (CartLookup)

Provides the ability to retrieve a cart and its contents based on the cart ID.

Responses

Checkout

Provides the ability to move a cart to the Checkout phase.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (Checkout)

Provides the ability to move a cart to the Checkout phase.

Responses

Create Cart

Provides the ability to create a new cart with or without associated cart items.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (CreateCart)

Provides the ability to create a new cart with or without associated cart items.

Responses

Create Quote

Provides the ability to create a new quote with or without associated contracts.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (CreateQuote)

Provides the ability to create a new quote with or without associated contracts.

Responses

Delete Cart

Provides the ability to remove a cart that has not been submitted from the system.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (DeleteCart)

Provides the ability to remove a cart that has not been submitted from the system.

Responses

Generate Pricing

Provides the ability to generate the pricing for one customer within a quote based on a list of contracts (or no contract).

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (GeneratePricing)

Provides the ability to generate the pricing for one customer within a quote based on a list of contracts (or no contract).

Responses

Generate Quote

Provides the ability to generate a printable quote for a selected contract. [Rev 1.01]

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (GenerateQuote)

Provides the ability to generate a printable quote for a selected contract. [Rev 1.01]

Responses

Modify Cart

Provides the ability to alter the properties of an existing cart. This includes adding additional items to a cart or modifying existing items within a cart.

Note

Once a cart item has been associated with an Advance Pay Price Point Definition, only RetailDiscountInformation can be modified. All other modifications to the cart item are ignored. [Rev 1.38]

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (ModifyCart)

Provides the ability to alter the properties of an existing cart. This includes adding additional items to a cart or modifying existing items within a cart.

Responses

Modify Extended Information

Provides the ability to modify the extended information that is associated with various types of objects. [Rev 1.05]

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (ModifyExtendedInformation)

Provides the ability to modify the extended information that is associated with various types of objects. [Rev 1.05]

Responses

Modify Quote

Provides the ability to modify properties of a quote and associate different contracts to the quote.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (ModifyQuote)

Provides the ability to modify properties of a quote and associate different contracts to the quote.

Responses

Modify Workflow Matrix

Provides the ability to add, update, or remove one or more workflow matrix items. [Rev 1.05]

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (ModifyWorkflowMatrix)

Provides the ability to add, update, or remove one or more workflow matrix items. [Rev 1.05]

Responses

Order Search

Provides the ability to obtain a list of information about all carts/orders that match certain criteria.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (OrderSearch)

Provides the ability to obtain a list of information about all carts/orders that match certain criteria.

Responses

Quote Lookup

Provides the ability to retrieve a quote and its contents based on the quote ID.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (QuoteLookup)

Provides the ability to retrieve a quote and its contents based on the quote ID.

Responses

Quote Search

Provides the ability to obtain a list of information about all quotes that match certain criteria.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (QuoteSearch)

Provides the ability to obtain a list of information about all quotes that match certain criteria.

Responses

Submit Cart

Performs final validation on the cart and moves the cart to the Processing phase.

header Parameters
Content-Type
required
string
Request Body schema: application/soap+xml
required
object (SubmitCart)

Performs final validation on the cart and moves the cart to the Processing phase.

Responses

Core Data Service

  • Note: The CoreDataService endpoint was added to the Order Placement service in [Rev 1.02].

Abstract

The purpose of the CoreDataService endpoint is to supply a set of search capabilities that can be used for data retrieval.

Authorization

In order to retrieve information from a data service proper authorization credentials must be included in the heading of the request. To do this, first find the Simple Web Token claim (ClaimType = "http://idibilling.com/SWT") within the Request Security Token returned to you from the 'Issue' call to the Security Token Service. Once found, the Simple Web Token must be submitted with each request in an "Authorization" header with a value in exactly the following format:

WRAP access_token="<Simple Web Token>"

where <Simple Web Token> between double quotes is replaced with the SWT claim string value between double quotes.

Available Data

The following is a list of all the possible data retrieval options offered by the core data service.

Average Quote Revenue Monthly

The average quote revenue across all contracts and all quotes that have had pricing generated for them per month.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AverageRevenue": 27.42,
  • "Month": "april",
  • "MonthID": 83468,
  • "YearID": 83468
}

Billing Order

A list of billing orders in the system. Billing orders may be the result of a cart being submitted or they may have been directly added through CostGuard, in which case the OriginatingCartID will be null. [Rev 1.06]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AttributePropertyDisplay": "my display name",
  • "AttributePropertyID": 83468,
  • "BillingOrderID": 83468,
  • "BillPaymentAmount": 27.42,
  • "CompleteDate": "2017-09-09T17:35:09.156Z",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CustomerAccountNumber": 356356,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "DepositAmount": 27.42,
  • "Description": "Billing order description",
  • "ErrorCount": 0,
  • "EstimatedCompleteDate": "2017-09-09T17:35:09.156Z",
  • "EstimatedMRC": 27.42,
  • "FinalizeDate": "2017-09-09T17:35:09.156Z",
  • "HoldDate": "2017-09-09T17:35:09.156Z",
  • "HoldReason": "my hold reason",
  • "HoldReasonID": 83468,
  • "InitiatingCallID": "my call id",
  • "InstallmentAmount": 27.42,
  • "InventoryLocation": 4,
  • "InventoryLocationDisplay": "my billing order location",
  • "InventoryLocationID": 83468,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "username",
  • "Note": "order notes",
  • "OrderState": "state of the billing order description",
  • "OrderStateID": 83468,
  • "OrderSubtotal": 27.42,
  • "OrderTotal": 27.42,
  • "OrderType": "order type name",
  • "OrderTypeID": 83468,
  • "OriginatingBillingOrderID": 83468,
  • "OriginatingCartID": 83468,
  • "ReceiptEmail": "auser@mail.com",
  • "ReceiptNumber": 523544,
  • "ReferenceNumber": 245245,
  • "ReferenceOrderDate": "2017-09-09T17:35:09.156Z",
  • "ReferenceUser": "username",
  • "Register": "my register",
  • "RegisterID": 83468,
  • "SalesEntity": "my sales entity",
  • "SalesEntityID": 83468,
  • "SavedReceiptGUID": "8d733f5f-12bc-4d67-973d-cf9c398f2081",
  • "ShipmentTrackingNumber": 246646234,
  • "SourceCode": "my source code",
  • "SourceCodeID": 83468,
  • "Status": "my billing order status",
  • "StatusID": 0,
  • "TaxAmount": 27.42,
  • "TransactionStatus": "transaction status description",
  • "TransactionStatusID": 83468,
  • "TransactionType": "transaction type description",
  • "TransactionTypeID": 83468,
  • "UserID": "my unique id"
}

Billing Order Change Overview

An overview of changes made to billing orders in the system. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 53675353,
  • "BillingOrderDetailID": 83468,
  • "BillingOrderID": 83468,
  • "ChangeType": "change type description",
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "Description": "billing order description",
  • "DetailDescription": "billing order detail description",
  • "DetailStatus": "my billing order detail",
  • "DetailStatusID": 0,
  • "ErrorCount": 4,
  • "FeatureCatalog": "feature catalog description",
  • "FeatureCatalogID": 83468,
  • "FeatureID": 83468,
  • "FeatureSKU": "JSK49929SG",
  • "FeatureStartDate": "2017-09-09T17:35:09.156Z",
  • "FromBillingOrderDetailID": 83468,
  • "FromItem": "my original feature description",
  • "HideOnSalesAndReturns": false,
  • "ObjectID": 354883,
  • "ObjectSubtype": "Wholesale",
  • "ObjectSubtypeID": 1,
  • "ObjectType": "Program",
  • "ObjectTypeDisplay": "Pricing Plan",
  • "OrderCompleteDate": "2017-09-09T17:35:09.156Z",
  • "OrderCreateDate": "2017-09-09T17:35:09.156Z",
  • "OrderState": "billing order state",
  • "OrderStateID": 83468,
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceID": 83468,
  • "ServiceNumber": "my service number",
  • "ToItem": "my billing order detail description",
  • "User": "username"
}

Billing Order Detail

A list of billing order details in the system. [Rev 1.10]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "BillingOrderDetailID": 83468,
  • "BillingOrderID": 83468,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "Description": "billing order detail description",
  • "DetailCompleteDate": "2017-09-09T17:35:09.156Z",
  • "DetailCreateDate": "2017-09-09T17:35:09.156Z",
  • "DetailState": "billing order detail state",
  • "DetailStateID": 83468,
  • "DetailStatus": "my billing order detail status",
  • "DetailStatusID": 0,
  • "ObjectID": 354883,
  • "ObjectSubtype": "Direct Invoice",
  • "ObjectSubtypeID": 1,
  • "ObjectType": "NonSerializedRetailProduct",
  • "OrderCompleteDate": "2017-09-09T17:35:09.156Z",
  • "OrderCreateDate": "2017-09-09T17:35:09.156Z",
  • "OrderState": "billing order state",
  • "OrderStateID": 83468,
  • "OrderStatus": "my billing order status",
  • "OrderStatusID": 0,
  • "OrderType": "my order type name",
  • "OrderTypeID": 83468,
  • "ParentBillingOrderDetail": "parent billing order detail description",
  • "ParentBillingOrderDetailID": 83468,
  • "SendDate": "2017-09-09T17:35:09.156Z",
  • "ServiceInformationItemID": 777,
  • "StatusMessage": "my status message",
  • "UserID": "my userID"
}

Billing Order Detail Error

A list of errors associated with billing order details. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "BillingOrdeDetailStatus": "billing order detail status",
  • "BillingOrderDescription": "billing order in error description",
  • "BillingOrderDetailCompleteDate": "2017-09-09T17:35:09.156Z",
  • "BillingOrderDetailDescription": "billing order detail in error description",
  • "BillingOrderDetailID": 83468,
  • "BillingOrderDetailStatusID": 0,
  • "BillingOrderID": 83468,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "Error": "error that occurred description",
  • "ErrorID": 83468,
  • "FeatureCatalog": "product catalog description",
  • "FeatureCatalogID": 83468,
  • "FeatureID": 35683468,
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceID": 35683468,
  • "ServiceNumber": "my service number"
}

Billing Order Detail Provisioning

A list of provisioning details for a billing order detail. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 5363753,
  • "AuxiliaryCarrier": "Carrier Name",
  • "AuxiliaryCarrierDesc": "Auxiliary carrier description",
  • "BCNDate": "2017-09-09T17:35:09.156Z",
  • "BillingOrderDetailID": 83468,
  • "BillingOrderID": 83468,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "Description": "billing order detail description",
  • "FOCDate": "2017-09-09T17:35:09.156Z",
  • "PCNDate": "2017-09-09T17:35:09.156Z",
  • "PON": 63574,
  • "PONID": 83468,
  • "PONType": "PON type description",
  • "PONTypeID": 83468,
  • "ProviderOrderNumber": 47848
}

Billing Order Detail Retail Summary

A list of billing order retail details in the system. [Rev 1.16]

Note

It is highly recommended this Odata be used with a BIllingOrderID filter

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 24634,
  • "BillingOrderDetailID": 83468,
  • "BillingOrderID": 83468,
  • "CanceledCount": 4,
  • "CompletedCount": 4,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "Description": "billing order detail description",
  • "DetailCreateDate": "2017-09-09T17:35:09.156Z",
  • "DetailStatus": "my billing order detail",
  • "DetailStatusID": 0,
  • "EffectiveCount": 4,
  • "ErrorCount": 4,
  • "ExtendedPrice": 27.42,
  • "IncompleteCount": 4,
  • "InProcessCount": 4,
  • "InventoryStatus": "Available for Sale",
  • "InventoryStatusID": 1,
  • "IsReturnable": true,
  • "ItemNumber": 4,
  • "MSL": "my service lock code",
  • "Note": " user-entered free-form text notes",
  • "ObjectType": "AdvancePayProductPricePoint",
  • "ObjectTypeDisplay": "Advance Pay Product Price Point",
  • "ParentBillingOrderDetailID": 83468,
  • "PendingFulfillment": 4,
  • "PendingReturn": 4,
  • "Purchased": 4,
  • "Quantity": 4,
  • "Reason": "my retail item disconnect reason",
  • "RetailProductID": 35683468,
  • "Returned": 4,
  • "ReturnReason": "my return reason",
  • "SerialNumber": "my serial number",
  • "ServiceCatalog": "my service type description",
  • "ServiceCatalogID": 35683468,
  • "ServiceNumber": "my service number",
  • "SKU": "JA7848SJ884",
  • "SubmittedCount": 4,
  • "UnitPrice": 27.42
}

Billing Order Detail Service Summary

A list of billing order service details in the system. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "BillingOrderDetailID": 83468,
  • "BillingOrderID": 83468,
  • "ChangeDate": "2017-09-09T17:35:09.156Z",
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "DetailStatus": "my billing order detail",
  • "DetailStatusID": 0,
  • "DetailType": "my detail type",
  • "DetailTypeID": 83468,
  • "ErrorCount": 4,
  • "HandsetAlternateSerialNumber": "my alternate serial number",
  • "HandsetSerialNumber": "my serial number",
  • "MSL": "my server lock",
  • "NewContractCatalog": "my product catalog description",
  • "NewContractCatalogID": 83468,
  • "NewContractCatalogSKU": "KJJ8367S99",
  • "NewContractID": 83468,
  • "NewHandsetCatalog": "product catalog description",
  • "NewHandsetCatalogID": 83468,
  • "NewHandsetCatalogSKU": "KJJ8367S99",
  • "NewHandsetID": 83468,
  • "NewPricingPlanCatalog": "my product catalog description",
  • "NewPricingPlanCatalogID": 83468,
  • "NewPricingPlanCatalogSKU": "KSH998SHS0F",
  • "NewPricingPlanID": 83468,
  • "OriginatingBillingOrderDetailID": 83468,
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceID": 83468,
  • "ServiceNumber": "my service number"
}

Billing Order Detail Summary

A list of billing order details in the system. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "BillingOrderDetailID": 83468,
  • "BillingOrderID": 83468,
  • "ChildBillingOrderDetailCount": 4,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "Description": "billing order detail description",
  • "DetailCompleteDate": "2017-09-09T17:35:09.156Z",
  • "DetailCreateDate": "2017-09-09T17:35:09.156Z",
  • "DetailState": "billing order detail state",
  • "DetailStateID": 83468,
  • "DetailStatus": "my billing order detail",
  • "DetailStatusID": 0,
  • "ObjectID": 354883,
  • "ObjectSubtype": "Direct Invoice",
  • "ObjectSubtypeID": 1,
  • "ObjectType": "NonSerializedRetailProduct",
  • "OrderCompleteDate": "2017-09-09T17:35:09.156Z",
  • "OrderCreateDate": "2017-09-09T17:35:09.156Z",
  • "OrderState": "billing order state",
  • "OrderStateID": 83468,
  • "OrderStatus": "my billing order status",
  • "OrderStatusID": 0,
  • "OrderType": "my order type name",
  • "OrderTypeID": 83468,
  • "ParentBillingOrderDetail": "parent billing order detail description",
  • "ParentBillingOrderDetailID": 83468,
  • "SentDate": "2017-09-09T17:35:09.156Z",
  • "StatusMessage": "my status message",
  • "UserID": "my user ID"
}

Billing Order History

A list of history records associated to a billing order and its details. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "BillingOrderDetail": "billing order detail description",
  • "BillingOrderDetailID": 83468,
  • "BillingOrderHistoryID": 83468,
  • "BillingOrderID": "my unique ID",
  • "ChangeDate": "2017-09-09T17:35:09.156Z",
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "Description": "billing order description",
  • "State": "billing order history state",
  • "StateID": 83468,
  • "Status": "status billing order history description",
  • "StatusID": 83468
}

Billing Order Provisioning

A list of provisioning details by billing order. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 3563573,
  • "AuxiliaryCarrier": "Carrier Name",
  • "AuxiliaryCarrierDesc": "Auxiliary carrier description",
  • "BCNDate": "2017-09-09T17:35:09.156Z",
  • "BillingOrderID": 83468,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "FOCDate": "2017-09-09T17:35:09.156Z",
  • "OrderLineItemDesc": "order line item(s) description",
  • "PCNDate": "2017-09-09T17:35:09.156Z",
  • "PON": 5574,
  • "PONID": 83468,
  • "PONType": "PON type description",
  • "PONTypeID": 83468,
  • "ProviderOrderNumber": 457456
}

Billing Order Status

A list of status that a billing order can be in. [Rev 1.06]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "BillingOrderStatusID": 83468,
  • "Name": "status name"
}

Billing Order Tax Summary

A summary of taxes charged on a billing order. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 363357,
  • "Amount": 27.42,
  • "BillingOrderID": 83468,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "IsUseTax": false,
  • "Tax": "my tax name",
  • "TaxID": 83468,
  • "TaxRateOrAmount": 27.42
}

Billing Order Tender

A List of tenders for a transaction. [Rev 1.16]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountHolderName": "Joe Smith",
  • "AccountNumber": 848928,
  • "Amount": 27.42,
  • "ApprovalCode": 10101,
  • "BankAccountNumberMasked": 1234,
  • "BankAccountType": "Savings",
  • "BankAccountTypeID": 83468,
  • "BillingOrderID": 83468,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreditCardType": "Visa",
  • "CreditCardTypeID": 2,
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "ExpirationDate": "2017-09-09T17:35:09.156Z",
  • "FinalizeDate": "2017-09-09T17:35:09.156Z",
  • "OriginatingTransactionID": "123456789",
  • "ReceiptNumber": 35225,
  • "ReferenceNumber": 87456,
  • "StreetAddress": "150 Main Street",
  • "TenderNumber": 133,
  • "TenderStatus": "Authorized",
  • "TenderStatusID": 888,
  • "TenderType": "tender used description",
  • "TenderTypeID": 83468,
  • "TransactionID": 83468,
  • "TransactionStatus": "transaction status description",
  • "TransactionStatusID": 83468,
  • "TransactionTenderID": 83468,
  • "ZipCode": 11114
}

Cart Item

Information about purchase/activation or return/disconnect items in orders/carts.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountCodeGroup": "account code group name",
  • "AccountCodeGroupID": 354883,
  • "ActionType": "my action type",
  • "ActionTypeID": 83468,
  • "AddOnStartDate": "2017-09-09T17:35:09.156Z",
  • "AddOnStartDateConstraintType": "UserDefined",
  • "AdvancePayPricePointCharge": 19.99,
  • "AdvancePayPricePointChargeID": 7,
  • "AdvancePayPricePointDefinition": "My Advance Pay Price Point Definition",
  • "AdvancePayPricePointDefinitionID": 42,
  • "AllowAdvancePayPricePointModifications": true,
  • "AutoRenew": false,
  • "BillingCycleType": "charge cycle of an item description",
  • "BillingCycleTypeID": 83468,
  • "CartItemID": 354883,
  • "CostOverride": 27.42,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "Description": "Cat item description",
  • "DisableCrediting": "Compute Credit Upon Disconnect",
  • "DiscountAmount": 28.42,
  • "DisplayNoteOnDirectInvoice": false,
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "EndDateConstraintType": "UserDefined",
  • "EndDateDuration": 4,
  • "EndDateDurationConstraintType": "Month",
  • "EndDateDurationDate": "2017-09-09T17:35:09.156Z",
  • "EndDateDurationRoundOption": "my rounding type",
  • "ExpireUnitsOnDisconnect": "Expire Units on Disconnect",
  • "FavoriteAdvancePayPricePointDefinition": "$29.99 Talk Text Data",
  • "FavoriteAdvancePayPricePointDefinitionID": 13,
  • "FeatureCatalog": "alternate invoice description.",
  • "FeatureCatalogID": 83468,
  • "FeatureID": 83468,
  • "FeatureWebName": "username",
  • "ForceAddOnToContractStartDate": true,
  • "ForcePriceOverride": false,
  • "ForceSwapToContractStartDate": true,
  • "IsDirectInvoice": false,
  • "IsForFulfillment": false,
  • "IsOnePriceChild": true,
  • "IsReadOnly": true,
  • "IsUpdateOnly": false,
  • "ItemCost": 27.42,
  • "ItemPrice": 27.42,
  • "ItemSubtotalType": "my subtotal bucket",
  • "ItemSubtotalTypeID": 83468,
  • "ItemWholesaleCost": 27.42,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "username",
  • "Note": "cart item notes",
  • "NumberOfDays": 4,
  • "NumberOfInstallments": 4,
  • "NumberOfUnits": 27.42,
  • "OrderDescription": "order/cart description",
  • "OrderID": 83468,
  • "OriginalCartItemID": 83468,
  • "OriginalOrderLineItemID": 83468,
  • "ParentCartItemID": 35,
  • "PriceOverride": 27.42,
  • "ProductSubtype": "Direct Invoice",
  • "ProductSubtypeID": 1,
  • "ProductType": "Retail Product",
  • "ProductTypeID": 9,
  • "Quantity": 4,
  • "QuantityDivisor": 100,
  • "QuantityFulfilled": 3,
  • "QuoteCartItemID": 83468,
  • "QuoteID": 83468,
  • "Reason": "return reason description",
  • "ReasonID": 354883,
  • "RetailInventoryStatus": "inventory status description",
  • "RetailInventoryStatusID": 83468,
  • "SalesCode": "my sales code",
  • "SalesCodeID": 354883,
  • "SerialNumber": "my serial number",
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceInformationItem": "service information item description",
  • "ServiceInformationItemID": 354883,
  • "ServiceNumber": "my service number",
  • "ShippingInformationContactID": 0,
  • "ShippingInformationItemID": 3,
  • "SKU": "SG5463HD4Y",
  • "SwapStartDate": "2017-09-09T17:35:09.156Z",
  • "SwapStartDateConstraintType": "UserDefined",
  • "TaxMode": 3,
  • "TaxObjectID": 1,
  • "TotalCost": 27.42,
  • "TotalPrice": 27.42,
  • "TotalWholesaleCost": 27.42,
  • "WholesaleCostOverride": 27.42
}

Customer Action

Information about orders/carts that perform an action on their customer account. [Rev 1.05]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 34636,
  • "ActionType": "order/cart action",
  • "ActionTypeID": 83468,
  • "ChangeDescription": "action description",
  • "CustomerID": 83468,
  • "CustomerName": "John Smith",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "ExcludeFinalBilledOneTimeCharges": true,
  • "ExpireUnitsOnDisconnect": true,
  • "IncludeFutureDisconnectedChildren": false,
  • "IsPortingOut": true,
  • "NewAccountStatus": "new account status description",
  • "NewAccountStatusID": 83468,
  • "OrderDescription": "order/cart description",
  • "OrderID": 83468,
  • "Reason": "configured change reason description",
  • "ReasonID": 354883,
  • "ReconnectFinalBilledItems": true,
  • "ReconnectMethodPrimary": "my recconnect method primary",
  • "ReconnectMethodPrimaryID": 0,
  • "ReconnectMethodSecondary": "my reconnect method secondary",
  • "ReconnectMethodSecondaryID": 0,
  • "RestartFinalBilledBillingCharges": true,
  • "SuspendDate": "2017-09-09T17:35:09.156Z"
}

Equipment Assignment History

List of handsets and SIM cards that have been assigned to a customer. [Rev 1.28]

Note

This Odata should always be used with a CustomerID filter.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "CatalogID": 83468,
  • "CustomerID": 83468,
  • "Description": "product type description",
  • "EquipmentID": 83468,
  • "EquipmentInUse": false,
  • "EquipmentType": "Handset",
  • "EquipmentTypeID": 301,
  • "HandsetSupportedSIMClass": "SIM Card",
  • "HandsetSupportedSIMClassID": 3,
  • "LastUsedDate": "2017-09-09T17:35:09.156Z",
  • "LastUsedServiceID": 83468,
  • "LastUsedServiceNumber": "my service number",
  • "SerialNumber": "my serial number",
  • "SIMClass": "SIM Card",
  • "SIMClassID": 3,
  • "SKU": "JA7848SJ884",
  • "TechnologyType": "Handset",
  • "TechnologyTypeID": 1
}

Equipment Transaction History

List of handsets and SIM cards that have been purchased by a customer. [Rev 1.28]

Note

This Odata should always be used with a CustomerID filter.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "CatalogID": 83468,
  • "CustomerID": 83468,
  • "Description": "product type description",
  • "EquipmentID": 83468,
  • "EquipmentInUse": true,
  • "EquipmentType": "Handset",
  • "EquipmentTypeID": 302,
  • "HandsetSupportedSIMClass": "SIM Card",
  • "HandsetSupportedSIMClassID": 3,
  • "RetailProductID": 83468,
  • "SerialNumber": "my serial number",
  • "SIMClass": "SIM Card",
  • "SIMClassID": 3,
  • "SKU": "JA7848SJ884",
  • "TechnologyType": "SIMCard",
  • "TechnologyTypeID": 1,
  • "TransactionDate": "2017-09-09T17:35:09.156Z",
  • "TransactionID": 83468,
  • "TransactionReceiptNumber": 463363
}

Extended Information Item

A list of additional key/value properties associated with any objects of the types shown. [Rev 1.05]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "Key": "extended property name",
  • "ObjectID": 83468,
  • "ObjectType": "BillingOrder",
  • "Value": "extended property value"
}

Extended Information Item Expanded

List of additional key/values properties associated with an object. These values will include ones that are using defaulted values from a definition and are not necessarily set explicitly. [Rev 1.15.01]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "DisplayName": "my alternate display name",
  • "Key": "my extended property name",
  • "ObjectID": 83468,
  • "ObjectType": "BillingOrder",
  • "PropertyID": 83468,
  • "Value": "my extended property value"
}

Order

Information about orders/carts.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "AttributePropertyDisplay": "my display name",
  • "AttributePropertyID": 83468,
  • "CheckoutDate": "2017-09-09T17:35:09.156Z",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "username",
  • "CustomerAction": "Disconnect",
  • "CustomerID": 8383468,
  • "CustomerName": "John Smith",
  • "CustomerSalesCode": "IDI008",
  • "CustomerSalesCodeID": 8,
  • "Description": "Order description",
  • "EstimatedCompleteDate": "2017-09-09T17:35:09.156Z",
  • "HoldDate": "2017-09-09T17:35:09.156Z",
  • "HoldReason": "my hold reason",
  • "HoldReasonID": 83468,
  • "InitiatingCallID": "my service representation call identifier",
  • "IsCustomerAddlSpecified": 1,
  • "IsPausable": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "username",
  • "LocationID": 354883,
  • "NewAccountStatus": "new account status description",
  • "NewAccountStatusID": 83468,
  • "Note": "cart/order notes",
  • "OrderID": 83468,
  • "OrderState": "order state",
  • "OrderStateID": 83468,
  • "OrderType": "my order type",
  • "OrderTypeID": 83468,
  • "PrimaryServiceInformationItemID": 7,
  • "ProcessingDate": "2017-09-09T17:35:09.156Z",
  • "ProcessingStartedDate": "2017-09-09T17:35:09.156Z",
  • "ProcessingStoppedDate": "2017-09-09T17:35:09.156Z",
  • "QuoteCustomerID": 83468,
  • "QuoteID": 83468,
  • "ReceiptNumber": 2462,
  • "SalesCode": "my sales code",
  • "SalesCodeID": 354883,
  • "SourceCode": "my source code",
  • "SourceCodeID": 354883,
  • "SourceQuoteCustomerID": 83468,
  • "SourceQuoteID": 83468,
  • "StartingAction": "New Order",
  • "StartingActionID": 1,
  • "SubmitDate": "2017-09-09T17:35:09.156Z",
  • "WorkflowRequestGUID": "my unique identifier"
}

Order Action Feature Catalog Overview

An overview per unique feature catalog entry of the feature count of currently valid feature actions that can be performed under a customer and optionally on an order. [Rev 1.07]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "CustomerID": 8383468,
  • "CustomerName": "John Smith",
  • "FeatureCatalogDescription": "product catalog description",
  • "FeatureCatalogID": 83468,
  • "FeatureDisconnectValidCount": 4,
  • "FeatureReconnectValidCount": 4,
  • "FeatureUpdateValidCount": 6,
  • "HasRequiredDisconnectProperties": false,
  • "IsProtected": false,
  • "OrderDescription": "order description",
  • "OrderTxnID": 8383468,
  • "SKU": "SHSDR4HDRHDFH"
}

Order Action Feature Overview

An overview of actions that are allowed or not allowed currently on a feature and optional cart. [Rev 1.07]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "CanDisconnectFeature": false,
  • "CanReconnectFeature": false,
  • "CanUpdateFeature": false,
  • "CustomerID": 8383468,
  • "CustomerName": "John Smith",
  • "FeatureCatalogDescription": "product catalog description",
  • "FeatureCatalogID": 83468,
  • "FeatureID": 354883,
  • "HasRequiredDisconnectProperties": false,
  • "IsReadOnly": true,
  • "IsProtected": false,
  • "OrderDescription": "order description",
  • "OrderTxnID": 8383468,
  • "OrderTxnItemID": 354883,
  • "ServiceID": 354883,
  • "ServiceInformationItemID": 354883,
  • "ServiceNumber": "my service number",
  • "SKU": "JA7848SJ884"
}

Order Action Service Catalog Overview

An overview per unique service catalog entry of the service count of currently valid service / feature level actions that can be performed under a customer and optionally on an order. [Rev 1.07]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "CustomerID": 8383468,
  • "CustomerName": "John Smith",
  • "FeatureDisconnectValidCount": 4,
  • "FeatureReconnectValidCount": 4,
  • "FeatureUpdateValidCount": 6,
  • "OrderDescription": "order description",
  • "OrderTxnID": 8383468,
  • "ServiceAddFeatureValidCount": 4,
  • "ServiceAddSubserviceValidCount": 4,
  • "ServiceCatalogDescription": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceChangeServiceNumberValidCount": 4,
  • "ServiceDisconnectValidCount": 4,
  • "ServiceDuplicateValidCount": 4,
  • "ServiceHotlineValidCount": 4,
  • "ServiceMoveValidCount": 4,
  • "ServiceReconnectValidCount": 4,
  • "ServiceRedirectValidCount": 4,
  • "ServiceRefreshValidCount": 4,
  • "ServiceRestoreValidCount": 4,
  • "ServiceSuspendValidCount": 4,
  • "SKU": "JA7848SJ884"
}

Order Action Service Overview

An overview of actions that are allowed or not allowed currently on a service and optional cart. The result from this Odata will also include records for customer account to indicate available actions on account-level features. [Rev 1.07

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "CanAddFeature": true,
  • "CanAddSubservice": true,
  • "CanChangeServiceNumber": true,
  • "CanDisconnectService": true,
  • "CanDuplicateService": true,
  • "CanHotlineService": true,
  • "CanMoveService": true,
  • "CanReconnectService": true,
  • "CanRedirectService": true,
  • "CanRefreshService": true,
  • "CanRestoreService": true,
  • "CanSuspendService": true,
  • "CustomerID": 8383468,
  • "CustomerName": "John Smith",
  • "FeatureDisconnectCount": 4,
  • "FeatureReconnectCount": 4,
  • "FeatureUpdateCount": 6,
  • "IsReadOnly": true,
  • "OrderDescription": "order description",
  • "OrderTxnID": 8383468,
  • "ParentServiceCatalogDescription": "product catalog description",
  • "ParentServiceCatalogID": 83468,
  • "ParentServiceID": 354883,
  • "ParentServiceInformationItemID": 354883,
  • "ParentServiceNumber": "my service number",
  • "ServiceCatalogDescription": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceID": 354883,
  • "ServiceInformationItemID": 354883,
  • "ServiceNumber": "my service number",
  • "SKU": "JA7848SJ884"
}

Order Action Summary

A list of the total number of actions of each type being performed on services and features in each cart/order. [Rev 1.05]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "Action": "Add",
  • "FulfillmentItemsCompleted": 2,
  • "FulfillmentItemsTotal": 3,
  • "InstallmentAgreementsCompleted": 0,
  • "InstallmentAgreementsTotal": 2,
  • "ObjectType": "Service",
  • "OrderID": 83468,
  • "ReplicateQuantityTotal": 4,
  • "ServiceAgreementsCompleted": 1,
  • "ServiceAgreementsTotal": 3,
  • "Total": 4
}

Order Grouping Detail

A list of unique service items in orders (plus the account if there are account-level features) and their groupings. [Rev 1.31]

query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "ActionType": "Add",
  • "ActionTypeID": 0,
  • "OrderID": 83468,
  • "ProcessingAction": "Update",
  • "ProcessingActionID": 11,
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceCatalogSKU": "JA7848SJ884",
  • "ServiceKey": 354883,
  • "ServiceInformationItemID": 354883
}

Order Grouping Overview

An overview of the total service count and sub service count per unique grouping on an order. [Rev 1.24]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "GroupingID": 1,
  • "GroupingType": "my grouping type",
  • "GroupingTypeID": 1,
  • "Name": 1,
  • "OrderID": 83468,
  • "ServiceCount": 4,
  • "SubServiceCount": 4
}

Order State

A list of all the possible order states in the system. [Rev 1.04]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "Name": "order state name",
  • "OrderStateID": 83468
}

Order Summary

Summary information about orders/carts. [Rev 1.05]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "AttributePropertyDisplay": "my display name",
  • "AttributePropertyID": 83468,
  • "CartItemCount": 4,
  • "CheckoutDate": "2017-09-09T17:35:09.156Z",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "username",
  • "CreditCheckRequiredProviderID": 2,
  • "CreditReportID": 24,
  • "CustomerAction": "Disconnect",
  • "CustomerID": 8383468,
  • "CustomerName": "John Smith",
  • "Description": "Order description",
  • "EstimatedCompleteDate": "2017-09-09T17:35:09.156Z",
  • "EstimatedMRC": 27.42,
  • "EstimatedNRC": 27.42,
  • "HoldDate": "2017-09-09T17:35:09.156Z",
  • "HoldReason": "my hold reason",
  • "HoldReasonID": 83468,
  • "IsAccountLevelReadOnly": true,
  • "IsCustomerAddlSpecified": 1,
  • "IsPausable": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "username",
  • "LocationID": 354883,
  • "NewAccountStatus": "new account status description",
  • "NewAccountStatusID": 83468,
  • "Note": "cart/order notes",
  • "OrderID": 83468,
  • "OrderState": "order state",
  • "OrderStateID": 83468,
  • "OrderTransactionType": "Order",
  • "OrderTransactionTypeID": 3,
  • "OrderType": "my order type",
  • "OrderTypeID": 83468,
  • "PrimaryServiceInformationItemID": 7,
  • "ProcessingDate": "2017-09-09T17:35:09.156Z",
  • "ProcessingStartedDate": "2017-09-09T17:35:09.156Z",
  • "ProcessingStoppedDate": "2017-09-09T17:35:09.156Z",
  • "QuoteCustomerID": 83468,
  • "QuoteID": 83468,
  • "ReceiptNumber": 45753,
  • "RegisterID": 3,
  • "SalesCode": "my sales code",
  • "SalesCodeID": 354883,
  • "SourceCode": "my source code",
  • "SourceCodeID": 354883,
  • "SourceQuoteCustomerID": 83468,
  • "SourceQuoteID": 83468,
  • "StartingAction": "New Order",
  • "StartingActionID": 6,
  • "StartingBlock": "New Order",
  • "StartingBlockID": 1,
  • "SubmitDate": "2017-09-09T17:35:09.156Z",
  • "Subtotal": 27.42,
  • "TaxSubtotal": 27.42,
  • "WorkflowRequestGUID": 353653
}

Payment Information Item

A list of payment information item records in the system. [Rev 1.08]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "Amount": 27.42,
  • "CustomerID": 8383468,
  • "CustomerName": "John Smith",
  • "Description": "payment information item description",
  • "InstallmentPlanFeatureID": 83468,
  • "InvoiceNumber": 4,
  • "OrderID": 83468,
  • "OrderState": "order state",
  • "OrderStateID": 83468,
  • "OrderSubmitDate": "2017-09-09T17:35:09.156Z",
  • "PaymentDate": "2017-09-09T17:35:09.156Z",
  • "PaymentInformationItemID": 83468,
  • "PaymentStatus": "Open",
  • "PaymentStatusID": 83468,
  • "PaymentType": "type of payment description",
  • "PaymentTypeID": 83468
}

Private Line Tax Allocations

Information about private line tax allocations on CartItems. [Rev. 1.24]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "CartItemID": 354883,
  • "ExemptCity": false,
  • "ExemptCounty": false,
  • "ExemptFederal": false,
  • "ExemptRegional": false,
  • "ExemptState": false,
  • "TaxAllocationItemID": 354883,
  • "TaxCity": "Georgia",
  • "TaxCountry": "associated country name",
  • "TaxCountryID": 354883,
  • "TaxCounty": "Monroe",
  • "TaxFraction": 27.42,
  • "TaxJurisdictionID": 354883,
  • "TaxState": "New Jersey",
  • "TaxZipCode": 14643
}

Product Browse Category Match

A list of features and related information that match browse tag categories for assignment templates on a service. [Rev 1.06]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "CatalogDescription": "feature description",
  • "CatalogID": 354883,
  • "MatchingCount": 4,
  • "OrderTxnDescription": "order description",
  • "OrderTxnID": 354883,
  • "ProductCatalogBrowseTagCategory": "browse tag category rule name",
  • "ProductCatalogBrowseTagCategoryID": 354838,
  • "ServiceDescription": "service description",
  • "ServiceID": 354883,
  • "ServiceInformationItemDescription": "service information item description",
  • "ServiceInformationItemID": 354883
}

Quote

Information about quotes in the system and their status information.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AcceptedContract": "contract accepted name",
  • "AcceptedContractCatalogID": 35683468,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "username",
  • "EstimatedMRC": 27.42,
  • "EstimatedNRC": 27.42,
  • "ForecastedContract": "quote contract name",
  • "ForecastedContractCatalogID": 83468,
  • "ForecastedPercentage": 5,
  • "HasConversionStarted": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "username",
  • "LastStatusModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastStatusModifiedUser": "username",
  • "OtherReasonDescription": "reason for status description",
  • "QuoteDeclinedReason": "reason this quote was declined name",
  • "QuoteDeclinedReasonID": 35683468,
  • "QuoteID": 35683468,
  • "QuoteName": "quote name",
  • "QuoteStatus": "status the quote is in name",
  • "QuoteStatusID": 35683468,
  • "SalesCode": "my sales code",
  • "SalesEntity": 354838,
  • "SalesFirstName": "John",
  • "SalesLastName": "Smith"
}

Quote Activity

Provides the counts per quote status of all the contracts that were entered within the current year.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "MonthToDate": 7,
  • "QuarterToDate": 7,
  • "QuoteStatus": "quote status name",
  • "QuoteStatusID": 354883,
  • "YearToDate": 7
}

Quote Conversion

A quote-level summary of the progress of conversion to carts/orders, including quantities of items both required and converted.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "ConvertedCartQuantity": 4,
  • "CustomerQuantity": 4,
  • "CustomerQuantityConverted": 4,
  • "CustomerQuantityMissingCPNI": 4,
  • "CustomerQuantityRequiringCPNI": 4,
  • "FeatureQuantityConverted": 4,
  • "FeatureQuantityRequired": 4,
  • "HasConversionStarted": true,
  • "QuantityAddlSpecified": 4,
  • "QuantityCustomerAddlSpecified": 4,
  • "QuoteID": 35683468,
  • "ServiceQuantityConverted": 4,
  • "ServiceQuantityRequired": 4
}

Quote Conversion Customers

Information about quotes and their associated customer accounts, including quantities of items both required and converted into carts/orders.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountReceivableGroup": "accounts receivable group name",
  • "AccountReceivableGroupID": 35683468,
  • "AccountStatus": "account status name",
  • "AccountStatusID": 35683468,
  • "BalanceAgingGroup": "my balance aging group name",
  • "BalanceAgingGroupID": 35683468,
  • "BillCycle": "bill cycle name",
  • "BillCycleID": 35683468,
  • "ConvertedCartQuantity": 4,
  • "CountCustomerLevelContracts": 4,
  • "CountServiceLevelContracts": 4,
  • "CustomerID": 35683468,
  • "CustomerName": "John Smith",
  • "FeatureQuantityConverted": 4,
  • "FeatureQuantityRequired": 4,
  • "FinanceGroup": "finance group name",
  • "FinanceGroupID": 35683468,
  • "HasCPNI": 4,
  • "IsCustomerAddlSpecified": 1,
  • "IsCustomerConverted": 4,
  • "Market": "market name",
  • "MarketID": 35683468,
  • "QuantityAddlSpecified": 4,
  • "QuoteCustomerID": 35683468,
  • "QuoteID": 35683468,
  • "RequiresCPNI": 4,
  • "ServiceQuantityConverted": 4,
  • "ServiceQuantityRequired": 4
}

Quote Conversion Features

Information about features in a quote and their associated customer account, including the quantity required and the quantity converted to a cart.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "CartItemID": 35683468,
  • "CustomerID": 35683468,
  • "CustomerName": "John Smith",
  • "FeatureCatalog": "product catalog description ",
  • "FeatureCatalogID": 83468,
  • "FeatureQuantityConverted": 4,
  • "FeatureQuantityRequired": 4,
  • "QuoteID": 35683468,
  • "ServiceInformationItemID": 35683468
}

Quote Conversion Services

Information about services in a quote and their associated customer account, including the quantity required and the quantity converted to a cart, and the quantity of child features required and their quantity converted to a cart.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 35635,
  • "CustomerID": 35683468,
  • "CustomerName": "John Smith",
  • "FeatureQuantityConverted": 4,
  • "FeatureQuantityRequired": 4,
  • "QuoteID": 35683468,
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceInformationItemID": 35683468,
  • "ServiceQuantityConverted": 4,
  • "ServiceQuantityRequired": 4
}

Quote Price Override

Information about quote price overrides.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "Contract": "My Contract",
  • "ContractCatalogID": 35683468,
  • "Feature": "My Feature Type",
  • "FeatureCatalogID": 35683468,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "username",
  • "PriceOverride": 27.42,
  • "Quote": "quote this override applies to name",
  • "QuoteCustomer": "My Customer",
  • "QuoteCustomerID": 35683468,
  • "QuoteID": 35683468,
  • "QuotePricingOverrideID": 35683468,
  • "QuotePricingOverrideType": "My Quote Pricing Override Type",
  • "QuotePricingOverrideTypeID": 35683468,
  • "Service": "My Service Type",
  • "ServiceCatalogID": 35683468,
  • "Zone": "My Zone",
  • "ZoneID": 35683468
}

Quote Revenue Forecast

The sum of revenue by forecast percent of all of the quotes currently submitted to customer.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "EstimatedAnnualRevenue": 27.42,
  • "EstimatedLifetimeRevenue": 27.42,
  • "EstimatedMonthlyRevenue": 27.42,
  • "ForecastedPercentage": 5,
  • "TotalEstimatedMRC": 27.42,
  • "TotalEstimatedNRC": 27.42
}

Quote Revenue Per Status Monthly

The sum of quote revenue across all contracts and all quotes that have had pricing generated for them per month per status.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "EstimatedAnnualRevenue": 27.42,
  • "EstimatedLifetimeRevenue": 27.42,
  • "EstimatedMonthlyRevenue": 27.42,
  • "Month": "april",
  • "MonthID": 83468,
  • "QuoteStatus": "quote status name",
  • "QuoteStatusID": 354883,
  • "TotalEstimatedMRC": 27.42,
  • "TotalEstimatedNRC": 27.42,
  • "YearID": 83468
}

Quote Status Aging

Information about quotes and the number of days each quote was in each of the quote statuses.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "DaysInAbandoned": 5,
  • "DaysInAccepted": 5,
  • "DaysInAssembling": 5,
  • "DaysInDeclined": 5,
  • "DaysInSubmitted": 5,
  • "EstimatedMRC": 27.42,
  • "EstimatedNRC": 27.42,
  • "QuoteID": 35683468,
  • "QuoteName": "My Quote Name",
  • "SalesEntity": "My Sales Entity'",
  • "SalesEntityID": 35683468
}

Retail Installment Plan

An instance of a retail installment plan. [Rev 1.17]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "CartItemID": 83468,
  • "DownPaymentAmount": 27.42,
  • "DownPaymentPercentage": 4,
  • "FirstInstallmentAmount": 27.42,
  • "FirstInstallmentIncluded": false,
  • "InstallmentAgreementID": 83468,
  • "InstallmentPlanProfile": "my retail installment plan profile",
  • "InstallmentPlanProfileID": 83468,
  • "NumberOfInstallments": 4,
  • "ProfilePolicyOverrideUser": "username",
  • "TotalAmountDue": 27.42,
  • "TotalAmountRemaining": 27.42
}

Revenue By Sales Associate

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "Contract": "My Contract",
  • "ContractCatalogID": 83468,
  • "EstimatedMRC": 27.42,
  • "EstimatedNRC": 27.42,
  • "QuoteCreated": "My Quote",
  • "QuoteID": 83468,
  • "QuoteName": "quote name",
  • "QuoteStatus": "quote status name",
  • "QuoteStatusID": 354883,
  • "SalesEntity": 363563,
  • "SalesEntityID": 35683468
}

Service Distribution Of Active Quotes

A count of the number of services per zone per service catalog id across all active quotes.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "Quantity": 4,
  • "Service": "Service Type",
  • "ServiceCatalogID": 35683468,
  • "Zone": "My Zone",
  • "ZoneID": 35683468
}

Service Information Item

Information about services in orders/carts.

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "ActionType": "my action type",
  • "ActionTypeID": 0,
  • "AlternateServiceNumber": "My alternate service number",
  • "AssignmentTemplateID": 83468,
  • "CallerName": "my caller name",
  • "ChangeDescription": "ActionType description",
  • "CopyAttributes": true,
  • "CopyServiceContacts": true,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "Description": "Service Item description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "ExchangeServiceID": 354882,
  • "ExchangeServiceNumber": "5855551212",
  • "ExcludeFinalBilledOneTimeCharges": true,
  • "ExpireUnitsOnDisconnect": true,
  • "Group": "my group",
  • "HandsetAlternateSerialNumber": "my alternate serial number",
  • "HandsetCatalog": "product catalog description",
  • "HandsetCatalogID": 83468,
  • "HandsetSerialNumber": "my serial number",
  • "IncludeFutureDisconnectedChildren": true,
  • "IncludeInstallmentPlansInMove": true,
  • "IsPortingOut": true,
  • "IsReadOnly": true,
  • "IsSimplePortIn": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "username",
  • "MoveToAccountNumber": 35635,
  • "MoveToCustomerID": 8383468,
  • "MoveToCustomerName": "John Smith",
  • "Name": "service name",
  • "NewAlternateServiceNumber": "My alternate service number",
  • "NewHandsetAlternateSerialNumber": "my alternate serial number",
  • "NewHandsetCatalog": "product catalog description",
  • "NewHandsetCatalogID": 83468,
  • "NewHandsetSerialNumber": "my serial number",
  • "NewServiceNumber": "my service number",
  • "NewSIMCardSerialNumber": "my serial number",
  • "NewTechnologyType": "my equipment technology",
  • "NewTechnologyTypeID": 83468,
  • "OrderDescription": "order/cart description",
  • "OrderID": 83468,
  • "ParentServiceInformationItemID": 83468,
  • "ParentServiceNumber": "my service number",
  • "PIN": 8542,
  • "ProcessingAction": "processing action name",
  • "ProcessingActionID": 83468,
  • "ProcessingDate": "2017-09-09T17:35:09.156Z",
  • "QuoteID": 83468,
  • "QuoteServiceInformationItemID": 83468,
  • "Reason": "configured change reason description",
  • "ReasonID": 354883,
  • "ReconnectFinalBilledItems": true,
  • "ReconnectMethodPrimary": "my recconnect method primary",
  • "ReconnectMethodPrimaryID": 0,
  • "ReconnectMethodSecondary": "my reconnect method secondary",
  • "ReconnectMethodSecondaryID": 0,
  • "ReplicateQuantity": 4,
  • "RestartFinalBilledBillingCharges": true,
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceID": 354883,
  • "ServiceInformationItemID": 354883,
  • "ServiceNumber": "my service number",
  • "ServiceNumberOwner": "My Carrier",
  • "ServiceNumberOwnerID": 83468,
  • "SIMCardSerialNumber": "my serial number",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "SuspendDate": "2017-09-09T17:35:09.156Z",
  • "TaxAccountType": "my tax account type",
  • "TaxAccountTypeID": 0,
  • "TechnologyType": "my technology type",
  • "TechnologyTypeID": 83468,
  • "UsageNotificationSendToOption": "Both (Service and Primary Service)",
  • "UsageNotificationSendToOptionID": 1,
  • "Zone": "zone description",
  • "ZoneID": 354883
}

Service Information Item Summary

A list of summaries of service information item records in the system. [Rev 1.08]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "ActionType": "my action type",
  • "ActionTypeID": 0,
  • "AlternateServiceNumber": "My alternate service number",
  • "AssignmentTemplateID": 83468,
  • "CallerName": "my caller name",
  • "CartItemCount": 4,
  • "ChangeDescription": "change description",
  • "CopyAttributes": true,
  • "CopyServiceContacts": true,
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "Description": "service item description",
  • "EndDate": "2017-09-09T17:35:09.156Z",
  • "ExchangeServiceID": 354882,
  • "ExchangeServiceNumber": "5855551212",
  • "ExpireUnitsOnDisconnect": true,
  • "Group": "my group",
  • "HandsetAlternateSerialNumber": "my alternate serial number",
  • "HandsetCatalog": "product catalog description",
  • "HandsetCatalogID": 83468,
  • "HandsetSerialNumber": "my serial number",
  • "IncludeFutureDisconnectedChildren": true,
  • "IsPortingOut": true,
  • "IsReadOnly": true,
  • "IsSimplePortIn": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "username",
  • "MoveToAccountNumber": 35635,
  • "MoveToCustomerID": 8383468,
  • "MoveToCustomerName": "John Smith",
  • "Name": "service name",
  • "NewAlternateServiceNumber": "My alternate service number",
  • "NewHandsetAlternateSerialNumber": "my alternate serial number",
  • "NewHandsetCatalog": "product catalog description",
  • "NewHandsetCatalogID": 83468,
  • "NewHandsetSerialNumber": "my serial number",
  • "NewServiceNumber": "my service number",
  • "NewSIMCardSerialNumber": "my serial number",
  • "NewTechnologyType": "my equipment technology",
  • "NewTechnologyTypeID": 1,
  • "OrderDescription": "order/cart description",
  • "OrderID": 83468,
  • "ParentServiceInformationItemID": 83468,
  • "ParentServiceNumber": "my service number",
  • "PIN": 8542,
  • "ProcessingAction": "processing action name",
  • "ProcessingActionID": 83468,
  • "ProcessingDate": "2017-09-09T17:35:09.156Z",
  • "QuoteID": 83468,
  • "QuoteServiceInformationItemID": 83468,
  • "Reason": "configured change reason description",
  • "ReasonID": 354883,
  • "ReconnectFinalBilledItems": true,
  • "ReconnectMethodPrimary": "my recconnect method primary",
  • "ReconnectMethodPrimaryID": 0,
  • "ReconnectMethodSecondary": "my reconnect method secondary",
  • "ReconnectMethodSecondaryID": 0,
  • "ReplicateQuantity": 4,
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 83468,
  • "ServiceID": 354883,
  • "ServiceInformationItemID": 354883,
  • "ServiceNumber": "my service number",
  • "ServiceNumberOwner": "My Carrier",
  • "ServiceNumberOwnerID": 83468,
  • "SIMCardSerialNumber": "my serial number",
  • "StartDate": "2017-09-09T17:35:09.156Z",
  • "SubserviceCount": 4,
  • "SuspendDate": "2017-09-09T17:35:09.156Z",
  • "TaxAccountType": "my tax account type",
  • "TaxAccountTypeID": 0,
  • "TechnologyType": "my technology type",
  • "TechnologyTypeID": 1,
  • "UsageNotificationSendToOption": "Both (Service and Primary Service)",
  • "UsageNotificationSendToOptionID": 1,
  • "Zone": "zone description",
  • "ZoneID": 354883
}

Starting Action

List of starting actions available to create an order with. [REV 1.32]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "Name": "Disconnect Service",
  • "StartingActionID": 2
}

Workflow Matrix Item

An object that defines the relationship between a Workflow Definition and an Order, as well as who is responsible for coordinating the workflow. [Rev 1.05]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "Coordinator": "username",
  • "ExternalWorkflowID": 83468,
  • "MatchAnyOrderTypeID": true,
  • "MatchAnyServiceCatalogID": true,
  • "Name": "my configuration name",
  • "Rank": 4,
  • "SetCoordinatorFromOrderTxn": false,
  • "WorkflowMatrixItemID": 83468,
  • "WorkflowMatrixItemOrderTypeCount": 4,
  • "WorkflowMatrixItemServiceCatalogCount": 4
}

Workflow Matrix Item Allowed Order Type

A container object for an Order Type associated with a WorkflowMatrixItem. [Rev 1.05]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "OrderType": "my order type",
  • "OrderTypeID": 354883,
  • "WorkflowMatrixItem": "my workflow matrix",
  • "WorkflowMatrixItemAllowedOrderTypeID": 83468,
  • "WorkflowMatrixItemID": 83468
}

Workflow Matrix Item Allowed Service Catalog

A container object for a Service Catalog associated with a WorkflowMatrixItem. [Rev 1.05]

Authorizations:
SWT
query Parameters
$count
integer
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
integer
Example: $skip=10
  • Number of search results to skip.
$skiptoken
string
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
integer
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.
header Parameters
Accept
string
Example: application/json;odata=verbose

Responses

Response samples

Content type
application/json
{
  • "ServiceCatalog": "product catalog description",
  • "ServiceCatalogID": 354883,
  • "WorkflowMatrixItem": "my workflow matrix item",
  • "WorkflowMatrixItemAllowedServiceCatalogID": 83468,
  • "WorkflowMatrixItemID": 83468
}

Release Notes

Latest WSDL

Release Notes 2.51

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.50

  • WSDL
  • Added FavoriteAdvancePayPricePointDefinitionID to AdditionalPurchaseItemInformation and AdditionalModifyCartItemInformation in Create Cart and Modify Cart.
  • Added FavoriteAdvancePayPricePointDefinitionID to response (CartItemDetail) of Create Cart, Modify Cart and Cart Lookup.
  • Added AdvancePayPricePointCharge, AdvancePayPricePointChargeID, AllowAdvancePayPricePointModifications, FavoriteAdvancePayPricePointDefinition and FavoriteAdvancePayPricePointDefinitionID to Cart Item (Core Data Service).

Release Notes 2.49

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.48

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.47

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.46

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.45

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.44

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.43

Release Notes 2.42

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.41

Release Notes 2.40

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.39

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.38

Release Notes 2.37

Release Notes 2.36

Release Notes 2.35

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.34

Release Notes 2.33

Release Notes 2.32

  • WSDL
  • Added StartingBlockID to AdditionalCartInformation in Create Cart Request
  • Added StartingBlockID to CartDetails in Create Cart Response

Release Notes 2.31

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.30

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.29

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.28

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.27

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.26

Release Notes 2.25

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.24

Release Notes 2.23

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.22

Release Notes 2.21

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.20

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.19

Release Notes 2.18

Release Notes 2.17

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.16

Release Notes 2.15

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.14

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.13

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.12

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.11

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.10

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.09

Release Notes 2.08

Release Notes 2.07

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.06

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

Release Notes 2.04

  • WSDL
  • Added ability to add protection plan through orders. ProtectionPlanInformation was added to the following operations
    • Create Cart
      • Added ProtectionPlanInformation to AdditionalPurchaseItemInformation on PurchaseItems
      • Added ProtectionPlanInformation to CartItemDetail on Responses
    • Modify Cart
      • Added ProtectionPlanInformation to AdditionalModifyCartItemInformation on ModifyCartItems
      • Added ProtectionPlanInformation to CartItemDetail on Responses

Release Notes 2.03

Release Notes 2.02

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • WSDL
  • Note: Major version change was for internal changes only and not a breaking change.
  • Added ParentPuchaseItemID to PurchaseItem in Create Cart and Modify Cart

Release Notes 1.58

  • WSDL
  • Added ParentCartItemID and IsOnePriceChild to CartItem (Core Data Service)
  • Added ClearAccountCodeGroupID, ClearApplyToSvcTypeID, ClearCostOverride, ClearNumberOfInstallments, ClearPriceOverride, ClearWholesaleCostOverride to AdditionalModifyCartItemInformation in Modify Cart
  • Added EnabledExperimentalFeatures to Requestor for all operations.
    • EnablePackageChildren is currently an experimental feature that will add all children of a package to the order when the package is added.

Release Notes 1.57

Release Notes 1.56

Release Notes 1.55

  • WSDL
  • Added AccountHolderName, ApprovalCode, BankAccountNumberMasked, BankAccountType, BankAccountTypeID, CreateDate, CreditCardType, CreditCardTypeID, ExpirationDate, ReferenceNumber, StreetAddress, TenderNumber, TenderStatus, TenderStatusID, ZipCode to Billing Order Tender
  • Added InventoryStatus and InventoryStatusID to BillingOrderDetailRetailSummary (Core Data Service)

Release Notes 1.54

Release Notes 1.53

Release Notes 1.52

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.51

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.50

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.49

  • WSDL
  • Added IsReadOnly to TenderDetail

Release Notes 1.48

  • WSDL
  • Added CustomerSalesCode and CustomerSalesCodeID to Order

Release Notes 1.47

Release Notes 1.46

Release Notes 1.45

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.44

Release Notes 1.43

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.42

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.41

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.40

Release Notes 1.39

Release Notes 1.38

  • WSDL
  • Added AdvancePayPricePointDefinition and AdvancePayPricePointDefinitionID to Cart Item (Core Data Service)
  • Added AdvancePayPricePointDefinitionID to Modify Cart response (CartItem)
  • Added EPayAccountID to TenderInformationItemCreditCard and TenderDetail

Release Notes 1.37

Release Notes 1.36

Release Notes 1.35

Release Notes 1.34

Release Notes 1.33

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.32

  • WSDL
  • Added Starting Action functionality.
  • Added ReturnPolicyOverrideOption and ReturnPolicyOverrideUser to AdditionalModifyCartItemInformation in Modify Cart

Release Notes 1.31

Release Notes 1.30

Release Notes 1.29

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.27

  • WSDL
  • Added ReturnPolicyOverrideOption, ReturnPolicyOverrideUser to AdditionalReturnItemInformation
  • Added logging message 500404 to Modify Workflow Matrix
  • Added validation to ensure WorkflowMatrixItem Name is unique in Modify Workflow Matrix
  • Added IncludeInstallmentPlansInMove to ServiceDetail, Service Information Item (OData), and ServiceInformationItemForMoveService
  • Added enum ReturnPolicyOverrideOption

Release Notes 1.26

  • WSDL
  • Added 3 - Action to the list of group types coming back to Order Grouping Overview
  • Added None option to ReconnectMethodSecondary

Release Notes 1.25

Release Notes 1.24

  • WSDL
  • Added Order Grouping Overview and Private Line Tax Allocations
  • Added 500605 to Modify Cart
  • Added Group to ReplicateService, ServiceDetail, ServiceInformationItem, ServiceInformationItemForChangeNumber, ServiceInformationItemForDisconnect, ServiceInformationItemForHotline, ServiceInformationItemForMoveService, ServiceInformationItemForReconnect, ServiceInformationItemForRedirect, ServiceInformationItemForRefresh, ServiceInformationItemForRestore, ServiceInformationItemForSuspend, ServiceInformationItemForSwapEquipment, ServiceInformationItemRoamingAgreementPMN, ServiceInformationItemRoamingAgreementSID in Create Cart and Modify Cart
  • Added Group, IsReadOnly to Service Information Item and Service Information Item Summary
  • Updated TaxAllocationItem so that TaxCountryID is now required when TaxJurisdictionID is set to 0; deprecated TaxState

Release Notes 1.23

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.22

Release Notes 1.21

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.20

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.19

  • WSDL
  • Added InitiatingCallID to AdditionalCartInformation and CartDetails of Create Cart and Modify Cart
  • Added InitiatingCallID to Billing Order and Order
  • Added FeatureSKU, ObjectSubtype, ObjectSubtypeID, ServiceCatalog, ServiceCatalogID to Billing Order Change Overview
  • Added ObjectSubtype, ObjectSubtypeID to Billing Order Detail and Billing Order Detail Summary
  • Added ProductSubtype, ProductSubtypeID to Cart Item
  • Deprecated: The order placement service will no longer support the ability to create or modify service addresses. Please use the Customer Service to perform these operations. The ability to link to existing service addresses can still be done using ServiceAddressID.

Release Notes 1.18

  • WSDL 1.18.03

  • Note: Internal changes were applied to this release. There were no external API changes.

  • WSDL 1.18.02

  • Note: Internal changes were applied to this release. There were no external API changes.

  • WSDL 1.18.01

  • Note: Internal changes were applied to this release. There were no external API changes.

  • WSDL 1.18.00

  • Added Latitude and Longitude to Contact in Create Cart and Modify Cart

  • Added GenerateInstallmentAgreements to ModifyCartReq

  • Added InstallmentAgreementGUIDs to ModifyCartResult

Release Notes 1.17

  • WSDL
  • Added RetailInstallmentPlan to AdditionalModifyCartItemInformation, AdditionalPurchaseItemInformation, and CartItemDetail
  • Updated Month to always return a value in Average Quote Revenue Monthly
  • Updated CustomerID, FeatureDisconnectValidCount, FeatureReconnectValidCount to always return a value in Order Action Feature Catalog Overview
  • Updated CanDisconnectFeature, CanReconnectFeature, CustomerID to always return a value in Order Action Feature Overview
  • Updated CustomerID, ServiceAddSubserviceValidCount, ServiceChangeServiceNumberValidCount, ServiceDuplicateValidCount, ServiceDisconnectValidCount, ServiceRedirectValidCount, ServiceHotlineValidCount, ServiceSuspendValidCount, ServiceMoveValidCount, ServiceRestoreValidCount, ServiceReconnectValidCount, ServiceAddFeatureValidCount, FeatureDisconnectValidCount, FeatureReconnectValidCount fields to always return a value in Order Action Service Catalog Overview.
  • Updated CustomerID, CanAddSubservice, CanChangeServiceNumber, CanDisconnectService, CanDuplicateService, CanRedirectService, CanHotlineService, CanSuspendService, CanMoveService, CanRestoreService, CanReconnectService, CanAddFeature, FeatureDisconnectCount, FeatureReconnectCount fields to always return a value in Order Action Service Overview.
  • Updated OrderState to always return a value in Order Summary.
  • Updated MatchingCount to always return a value in Product Browse Category Match.
  • Updated MonthToDate, QuarterToDate and YearToDate to always return a value in Quote Activity.
  • Updated Month to always return a value in Quote Revenue Per Status Monthly.

Release Notes 1.16

  • WSDL
  • Added TenderLogs
  • Added ShipProvisionType
  • Added AttributePropertyDisplay, AttributePropertyID, BillPaymentAmount, DepositAmount, EstimatedCompleteDate, EstimatedMRC, FinalizeDate, HoldDate, HoldReason, HoldReasonID, InstallmentAmount, InventoryLocation, InventoryLocationID, LastModifedUser, LastModifiedDate, Note, OrderState, OrderStateID, OrderSubtotal, OrderTotal, OriginatingBillingOrderID, ReceiptEmail, ReceiptNumber, ReferenceNumber, ReferenceOrderDate, ReferenceUser, Register, RegisterID, SalesEntity, SalesEntityID,SavedReceiptGUID, ShippingTrackingNumber, SourceCode, SourceID, TaxAmount, TransactionStatus, TransactionStatusID, TransactionType, TransactionTypeID
  • Added ParentBillingOrderDetail, ParentBillingOrderDetailID,SendDate StatusMessage
  • Added BillingOrderChangeOverview, BillingOrderDetailError, BillingOrderDetailProvisioning, BillingOrderHistory, BillingOrderDetailRetailSummary, BillingOrderDetailServiceSummary, BillingOrderDetailSummary, BillingOrderProvisioning, BillingOrderTaxSummary, BillingOrderTender
  • Added SalesRequest
  • Added ProductFamilyMaxChildrenOverrideUser, ProductFamilyOrphanChildrenOverrideUser
  • Added FulfillmentMethod, PaymentProviderLogResponseCode, ShipProvisionType, TenderLogRequestCode
  • Added Billing order to the list of defined types
  • Added PaymentProviderLog, SalesRequest, TenderLog
  • StreetName and StreetNumber are no longer required
  • BillCompanyName, BillFirstName, BillLastName, StreetName, and StreetNumber are no longer required

Release Notes 1.15

Release Notes 1.14

  • WSDL
  • Deprecated CartID, CustomerID and OriginalCartID from Cart
  • Deprecated ServiceAgreementID from CartItemDetail
  • Deprecated CustomerID and OriginalCartID from CreateCartReq
  • Deprecated CartID from CartLookupReq, CartSummary, CheckoutReq, DeleteCartReq, DeleteCartResult, and SubmitCartReq
  • Deprecated CartID and CustomerID from ModifyCartReq
  • Deprecated CustomerID and OrderID from OrderSearchResultItem
  • Deprecated QuoteID from GeneratePricingReq, GenerateQuoteReq, ModifyQuoteReq, Quote, QuoteLookupReq, QuoteSearchResultItem, and QuoteSummary
  • Deprecated OrderID from OrderSummary
  • Deprecated CustomerID from QuoteCustomer
  • Deprecated DocumentID from QuoteLevelContractSummary
  • Deprecated MoveToCustomerID from ServiceDetail and ServiceInformationItemForMoveService

Release Notes 1.13

Release Notes 1.12

  • WSDL
  • Note: Internal reference updates.

Release Notes 1.11

  • WSDL
  • Added BusinessChecking, BusinessSavings to BankAccountType
  • Added TenderContact to TenderDetail and TenderInformationItem

Release Notes 1.10

  • Version Numbers were changed during this release to bring them in line with other conventions.

  • Note: Updated how large TaxID fields are fetched.

  • Release Notes 1.09

  • Note: Updated handling of retail taxes.

  • Note: Updated how large TaxID fields are fetched. [Rev 1.09.01]

  • Release Notes 1.08

  • Note: Updated how large TaxID fields are fetched. [Rev 1.08.01]

  • Added assignment templates from customer's market and account type to AssignmentFilter

  • Added IsAccountLevel to AssignmentFilter

  • Added Payment Information Item and Service Information Item Summary

  • Added CopyService to MessageItemType

  • Added CopyServices to ModifyCartReq

  • Added ServiceDuplicateValidCount to Order Action Service Catalog Overview

  • Added CanDuplicateService to Order Action Service Overview

  • Added PaymentDate, InstallmentPlanFeatureID to PaymentDetail

  • Added ApplyPaymentDateTimeZone, InstallmentPlanFeatureID, PaymentDate, PaymentDateTolerance to PaymentInformationItem

  • Added Remove to PortTimeZoneType

  • Added IsSimplePortIn to ServiceDetail, ServiceInformationItem, and ServiceInformationItemForChangeNumber

  • Release Notes 1.07

  • Note: Internal processing updates. [Rev 1.07.01]

  • Note: Updated how large TaxID fields are fetched. [Rev 1.07.02]

  • Added ReservationID

  • Added ReturnRequest

  • Added BulkActionCount, OriginalOrderLineItemID

  • Added FeatureWebName, ForceAddOnToContractStartDate, ForceSwapToContractStartDate, OriginalOrderLineItemID

  • Added ForceAddOnToContractStartDate, ForceSwapToContractStartDate

  • Added OrderActionFeatureCatalogOverview, OrderActionFeatureOverview, OrderActionServiceCatalogOverview, OrderActionServiceOverview

  • Added ReturnRequest

  • Added OriginalOrderLineItemID

  • Added AddressValidationInformation, TaxJurisdictionIDs

  • Added MoveToAccountNumber, MoveToCustomerID, MoveToCustomerName

  • Release Notes 1.06

  • Updated TaxJurisdictionIDs

  • Added BillingOrder, BillingOrderStatus, ProductBrowseCategoryMatch

Release Notes 1.05

  • Note: Updated internally logged information in this release for issues while submitting carts.
  • Note: Updated internal logging version compatibility information in this release.
  • Added AssignmentTemplateIDs
  • Added AddOnStartDate, AddOnStartDateConstraintType, EndDate, EndDateConstraintType, EndDateDuration, EndDateDurationConstraintType, EndDateDurationDate, EndDateDurationRoundOption, SwapStartDate, SwapStartDateConstraintType
  • Added Note
  • Added ExtendedInformationItem, CustomerAction, OrderActionSummary, OrderSummary.
  • Added ObjectType
  • Added ExclusivePurchaseItemDescription
  • Added BulkService, ModifyExtendedInformationReq, ModifyExtendedInformationResult, ModifyWorkflowMatrixReq, ModifyWorkflowMatrixResult
  • Added ModifyExtendedInformation, ModifyWorkflowMatrix
  • Added CustomerAction, NewAccountStatus, NewAccountStatusID, SourceCode, SourceCodeID, WorkflowRequestGUID
  • Added IsCustomerAction
  • Added ReferenceNumber

Release Notes 1.04

  • Added ReplicateServices
  • Updated 'Exclusivity Check' section
  • Added ServiceNumber
  • Added OrderState
  • Updated ExclusiveReturnFeatureDescription, ExclusiveReturnFeatureID
  • Added ReplicateService, ReplicateServiceBase, ReplicateServiceBulk
  • Added AttributePropertyDisplay, AttributePropertyID, Note, SalesCode, SalesCodeID
  • Added ReplicateQuantity
  • Added AssignmentTemplateID, ParentServiceNumber, ReplicateQuantity

Release Notes 1.03

  • Added QuoteCustomerID, QuoteID

  • Release Notes 1.02

  • Note: Implemented new Single Sign-On Security in this release

  • Added Desciption, QuoteCustomerID

  • Added QuoteCartItmeID

  • Added note to City, CompanyName, Country, County, FirstName, MiddleInitial, LastName, State, Street1, Street1, Street3

  • Added to Order Placement Service

  • Added note to Email about all capitalization

  • Added OverrideType,

  • Added QuotePricingOverride

  • Added HasConversionStarted, QuotePricingOverrides

  • Added Value (Description)

  • Added Description

  • Added HasConversionStarted

  • Added Value (HasConversionStarted)

  • Added Value (Abandoned)

  • Added ForecastedContractCatalogID, ForecastedPercentage

  • Added QuoteServiceInformationItemID

Release Notes 1.01

  • Added SalesCode
  • Added BillingCycleType, ProductType, SalesCode
  • Added ResponseGroups, StatusInformation
  • Added SalesCode, StatusDetail
  • Updated CatalogID to include 'No Contract' case
  • Added BillingCycleType, ProductType
  • Added DocumentCreateDate, DoucmentID, Description of QuoteContact
  • Added Quote, QuoteFeaturePrices, QuoteStatusDetail, QuoteSummary
  • Added QuoteCustomerPrices, QuoteSummary
  • Added to Order Placement Service
  • Added QuoteStatus to data returned in every result.
  • Added QuoteStatuses
  • Added QuoteStatus
  • Added Zone