NRTC Mobile Solutions

Ecommerce Services

Authentication

Create a Cart and Order

Check for Coverage

List Products

Bring Your Own Device

Get Contract Information

Trade In Rate List

List Primary Plans for Product and Contract

List Secondary Plans for Product, Contract, and Primary Plan

List Required Secondary Plans

List Accessories for Product

Get Account

Validate Address

List Shipping Methods

Validate Promo Code

Codeless Promos

List Available Trade Ins

Get Cart Quote

Place Order

Update Order Shipping Address

Can Order Be Cancelled

Get Order

Get Order by Marketplace Order ID

Order Can Cancel

Cancel Order

Cancel Order Item

Device Upgrade or Replacement

Get Device Only Quote

Place Device Only Order

Accessory Only Purchase

Get Accessory Quote

Place Accessory Order

RMAs

List RMAs

List Lines Eligible for RMA

Get RMA Quote

Submit RMA

Inventory and Line Information

Get Line

Inventory Details

Get ETF Amount

Apply ETF

Storefronts & Products

Storefront List

Get Storefront

Storefront List Custom Fields

Product Storefront Toggle Mapping

Product Handset Accessory Mapping

Customer

List Orders

Get Payment History List

Get Payment Detail

Update Email

Update Home Address

Update Shipping Address

Update Payment Information

Update Phone Number

EcommServices

Ecomm Services

Production

<p class="slate-p " ><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >General Flow</h2><p class="slate-p " ><p class="slate-p " >Here is the general flow of how to use our APIs to create an order.</p><p class="slate-p " ><em class="slate-italic">Note: Please ensure you include a User-Agent header in your API calls to prevent our web application firewall from banning you.</em></p><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Coverage</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >Make sure the end user has coverage:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65e8" target="">Check for Coverage</a></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Products</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >List available phones:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65dc" target="">List Products</a></p><p class="slate-p " >Allow the customer to alternately provide their own device:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65f2" target="">Bring Your Own Device</a></p></p></p><p class="slate-p slate-indent-1" style="24px"></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Contracts / Plan Terms</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >After the phone/product is selected, list the contract ids returned in the previous call.  Use this for more contract information:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65d4" target="">Get Contract Information</a></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Plans</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >After the contract is chosen, list the primary plans available:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65d6" target="">List Primary Plans for Product and Contract</a></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >5</h6><h3 class="slate-h3 " >Features</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >After the phone, contract, and primary plans are chosen - list the secondary packages and follow the requirements per usage type:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65d8" target="">List Secondary Plans for Product, Contract, and Primary Plan</a></p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65da" target="">List Required Secondary Plans</a></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >6</h6><h3 class="slate-h3 " >Accessories</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >Anywhere in the above flow after the phone is chosen, you may list accessories:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65de" target="">List Accessories for Product</a></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >7</h6><h3 class="slate-h3 " >Address &amp; Shipping</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >Ensure the billing/shipping address being provided is valid:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65ea" target="">Validate Address</a></p><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >Use this to list the available shipping methods:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65d2" target="">List Shipping Methods</a></p></p></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >8</h6><h3 class="slate-h3 " >Account Information</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >Gather any custom field information from the customer:</p><p class="slate-p slate-indent-1" style="24px"><a href="6585be8cd2c789c1955d1619/6585bf92d2c789c1955d1c3f" target="">List Custom Fields</a></p></p></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >9</h6><h3 class="slate-h3 " >Promotions</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >Use this to validate any promotions codes the end user provides:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65f0" target="">Validate Promo Code</a></p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/66199d82c7b063cfad9dd398" target="">Codeless Promos</a></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >10</h6><h3 class="slate-h3 " >Quote</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >To retrieve a detailed quote for the cart:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65f4" target="">Get Cart Quote</a></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >11</h6><h3 class="slate-h3 " >Place Order</h3><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >To place the order:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec65f6" target="">Place Order</a></p><p class="slate-p slate-indent-1" style="24px"><a href="https://developer.wirelessprovisioning.com/mdn/customer/management/update-customer-s-custom-information" target="_blank">Add Custom Field Information</a></p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/661ead61c7b063cfad0b55f6" target="">Update Order Shipping Address</a></p></p></p><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >12</h6><h3 class="slate-h3 " >Track Order</h3><p class="slate-p " >To detect when the order is fulfilled, shipped, and delivered:</p><p class="slate-p slate-indent-1" style="24px"><a href="643575c3dee26af75df10888/64355f75dee26af75dec6628" target="">Get Order</a></p><p class="slate-p " ></p></div></div></div></p></p>

<h1 class="slate-h1">Changing Your Password</h1><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">This web service is used to reset a password for an API user as passwords expire every 90 days. Telispire suggests a routine process be developed on your side to call this API and update the password on your side and have all processes that call APIs be set to dynamically get the new password each time it has been updated by this API:</p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(124, 132, 142);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(124, 132, 142);font-size:14px" class="slate-backgroundColor"></span></span></p><h3 class="slate-h3"><a href="https://developer.wirelessprovisioning.com/membership/changing-your-password" target="_blank">Change Password API Documentation</a></h3><p class="slate-p" placeholder="Type / for widgets"><a href="http://wirelessprovisioning.com/desktopmodules/telispire.webservices/membership.asmx?op=ChangePassword" target="_blank">http://wirelessprovisioning.com/desktopmodules/telispire.webservices/membership.asmx?op=ChangePassword</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">The password requirements are:</p><p class="slate-p" placeholder="Type / for widgets"></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Must be at least eight characters long.</div></li><li class="slate-li"><div style="position:relative">Must contain at least one upper case letter.</div></li><li class="slate-li"><div style="position:relative">Must contain at least one lower case letter.</div></li><li class="slate-li"><div style="position:relative">Must contain at least one number.</div></li><li class="slate-li"><div style="position:relative">Must contain at least one special character such as #,!,?,etc.</div></li><li class="slate-li"><div style="position:relative">Cannot contain the User Id.</div></li><li class="slate-li"><div style="position:relative">Cannot be the same as any of the last four passwords for the user.</div></li><li class="slate-li"><div style="position:relative">Cannot use the <strong style="font-size:14px" class="slate-bold">&amp;</strong> ampersand character</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">


</p><p class="slate-p" placeholder="Type / for widgets"></p>

This web service is used to reset a password for an API user as passwords expire every 90 days. Telispire suggests a routine process be developed on your side to call this API and update the password on your side and have all processes that call APIs be set to dynamically get the new password each time it has been updated by this API:

<p class="slate-p " ><p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=CoverageCheck_Verizon" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=CoverageCheck_Verizon</a></p><p class="slate-p " >
</p><p class="slate-p " >This is to be used to see if the end user’s primary area they will be using their phone has coverage based on a five digit zip code. Verizon simply lets us know with a true or false!</p></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

_declaration

Envelope

SOAPAction

<p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Product_List" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Product_List</a></p><p class="slate-p " ><p class="slate-p " ></p><p class="slate-p " >Lists all the enabled and mapped product ids for a specific storefront. Includes all necessary information to display the product list on an ecommerce site in one API call.</p><p class="slate-p " ></p><p class="slate-p " >Attributes, Contracts, and Images <em class="slate-italic">(see below)</em> object samples:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">XML</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">            <Attributes>
              <AttributeList>
                <Name>string</Name>
                <Value>string</Value>
              </AttributeList>
              <AttributeList>
                <Name>string</Name>
                <Value>string</Value>
              </AttributeList>
            <Contracts>
              <ProductContractPrice>
                <Id>int</Id>
                <ProductId>int</ProductId>
                <ContractId>int</ContractId>
                <ContractName>string</ContractName>
                <IsEnabled>true</IsEnabled>
                <ProductPrice>decimal</ProductPrice>
                <DisplayName>string</DisplayName>
                <ETF>decimal</ETF>
                <ETFProrationAmount>decimal</ETFProrationAmount>
                <AllowDeviceFinancing>boolean</AllowDeviceFinancing>
                <ContractType>Prepaid or Postpaid</ContractType>
              </ProductContractPrice>
              <ProductContractPrice>
                <Id>int</Id>
                <ProductId>int</ProductId>
                <ContractId>int</ContractId>
                <ContractName>string</ContractName>
                <IsEnabled>true</IsEnabled>
                <ProductPrice>decimal</ProductPrice>
                <DisplayName>string</DisplayName>
                <ETF>decimal</ETF>
                <ETFProrationAmount>decimal</ETFProrationAmount>
                <AllowDeviceFinancing>boolean</AllowDeviceFinancing>
                <ContractType>Prepaid or Postpaid</ContractType>
              </ProductContractPrice>
            </Contracts>
            <Images>
              <ProductImage>
                <Id>int</Id>
                <ProductId>int</ProductId>
                <ImageURL>string</ImageURL>
                <IsPrimary>boolean</IsPrimary>
              </ProductImage>
              <ProductImage>
                <Id>int</Id>
                <ProductId>int</ProductId>
                <ImageURL>string</ImageURL>
                <IsPrimary>boolean</IsPrimary>
              </ProductImage>
            </Images> </textarea><code class="language-xml keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><h3 class="slate-h3 " >For the Product Images:</h3><p class="slate-p " >Small Thumbnail:
<a href="https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/{{product" target="_self">https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/{{product</a> id}}/Thumbs/{{ImageURL}}
example: <a href="https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/6565/Thumbs/1%20SamsungS22_Phantom%20Black.png" target="_self">https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/6565/Thumbs/1%20SamsungS22_Phantom%20Black.png</a> </p><p class="slate-p " >Large Thumbnail:
<a href="https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/{{product" target="_self">https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/{{product</a> id}}/LargeSettingImages/{{ImageURL}}
example: <a href="https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/6565/LargeSettingImages/1%20SamsungS22_Phantom%20Black.png" target="_self">https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/6565/LargeSettingImages/1%20SamsungS22_Phantom%20Black.png</a> </p><p class="slate-p " >Full Size:
<a href="https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/{{product" target="_self">https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/{{product</a> id}}/{{ImageURL}}
example: <a href="https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/6565/1%20SamsungS22_Phantom%20Black.png" target="_self">https://wirelessprovisioning.com/Ecomm.ProductImageDirectory/6565/1%20SamsungS22_Phantom%20Black.png</a>

</p></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p" placeholder="Type / for widgets"><p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=ByodCheck_Verizon" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=ByodCheck_Verizon</a></p><p class="slate-p" placeholder="Type / for widgets">
</p><p class="slate-p" placeholder="Type / for widgets">Checks the provided IMEI to see if it is approved for use.  If the&lt;ByodCheckResponseType&gt; response value is “OK” then it is valid for use.  This returns a contract id (<em class="slate-italic">WhitelistItem-&gt;Contracts-&gt;ProductContractPrice-&gt;ContractId)</em>and product id (<em class="slate-italic">WhitelistItem-&gt;Contracts-&gt;ProductContractPrice-&gt;ProductId)</em><a href="https://app.theneo.io/nrtc-mobile-solutions/ecommerce/create-a-cart-and-order/list-primary-plans-for-product-and-contract" target="_self"> to use for the primary plan listing API</a>.</p><p class="slate-p" placeholder="Type / for widgets">This will at times also return a VerizonDiscount integer which needs to be provided in the Order_Submit API&apos;s <em class="slate-italic">cart-&gt;CartItems-&gt;VerizonDiscount </em>request parameter.</p><p class="slate-p" placeholder="Type / for widgets">Also, if the <em class="slate-italic">WhitelistItem-&gt;ICCRequired </em>parameter returns &apos;true&apos; then this means the device requires a physical sim.  You will need to provide a previously communicated product id in the Order_Submit API&apos;s <em class="slate-italic">cart-&gt;CartItems-&gt;Accessories-&gt;CartAccessory-&gt;ProductId</em> with a Quantity of 1 ( <em class="slate-italic">cart-&gt;CartItems-&gt;Accessories-&gt;CartAccessory-&gt;Quantity </em>)</p></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Contract_Get" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=</a><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Contract_Get" target="_self">Contract_Get</a>
</p><p class="slate-p" placeholder="Type / for widgets">Pull the contract term, length, and details by contract id.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Pull the contract term, length, and details by contract id.

Content-Type

<p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=TradeInRate_List" target="_blank">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=TradeInRate_List</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">List all trade ins accepted along with their credit value

</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

List all trade ins accepted along with their credit value



<p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Plans_ListPrimary" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Plans_ListPrimary</a><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68)" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68)" class="slate-backgroundColor"></span></span></p><p class="slate-p" placeholder="Type / for widgets"><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68)" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68)" class="slate-backgroundColor"></span></span></p><p class="slate-p" placeholder="Type / for widgets"><p class="slate-p" placeholder="Type / for widgets">Lists all the mapped primary plans tied to a specific product id and storefront. Includes plan information. Once the primary plan is known/chosen, then proceed with <a href="https://app.theneo.io/nrtc-mobile-solutions/ecommerce/create-a-cart-and-order/list-secondary-plans-for-product-contract-and-primary-plan" target="_self">listing the secondary plans mapped</a> to this product, contract, and plan and determine <a href="https://app.theneo.io/nrtc-mobile-solutions/ecommerce/create-a-cart-and-order/list-required-secondary-plans" target="_self">which secondary plans are required</a> versus optional.</p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14px" class="slate-backgroundColor"></span></span></p></p></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p " ><p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Plans_ListSecondary" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Plans_ListSecondary</a></p><p class="slate-p " >
Lists all the mapped secondary plans tied to a specific product id, storefront, and primary plan id. Includes plan information.  Be sure and determine <a href="643575c3dee26af75df10888/64355f75dee26af75dec65da" target="">which secondary plans are required</a> versus optional so that you know which secondary plans must be passed to ensure proper provisioning and to also drive your UI to group by Usage Type and mark each group as required or not.  We suggest using either radio buttons or a dropdown for usage types that are required and have more than one secondary plan in the usage type.  Otherwise if the usage type is required and there is only one in the type, you can list it and not allow editing, or even hide it fully from the UI - particularly if there is no cost tied to the secondary plan.  As for optional secondary plans, if there is only one within a usage type group we recommend using a checkbox.  If there is more than one optional secondary plan within a usage type, you can use radio buttons or a dropdown but include a ‘none’ type option in the list.</p></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Plans_ListRequiredUsageTypes" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Plans_ListRequiredUsageTypes</a></p><p class="slate-p " ></p></p><p class="slate-p " >Provides the requirements of the secondary plans by usage type that are tied to a specific product id, storefront, and primary plan id. Please see additional details for the accompanying<a href="https://app.theneo.io/nrtc-mobile-solutions/ecommerce/create-a-cart-and-order/list-secondary-plans-for-product-contract-and-primary-plan" target="_self"> secondary plans list API.</a>

</p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Provides the requirements of the secondary plans by usage type that are tied to a specific product id, storefront, and primary plan id. Please see additional details for the accompanying

<p class="slate-p " ><p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Accessories_List" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Accessories_List</a></p><p class="slate-p " >
</p><p class="slate-p " >Lists all accessories tied to a specific product id and storefront. Includes all accessory product detail.</p></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Account_Get" target="_blank">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Account_Get</a></p><p class="slate-p" placeholder="Type / for widgets">This will list the lines and include the phone number, username, device and sim information, and some other information.  If the account has less than 100 lines it will also include usage information along with primary and secondary plan information.  When you have an account with more than 100 lines and require the usage and/or plan information, please use the <a href="https://app.theneo.io/nrtc-mobile-solutions/ecommerce/inventory-and-line-information/get-line" target="_self">Get Line</a> API.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This will list the lines and include the phone number, username, device and sim information, and some other information.  If the account has less than 100 lines it will also include usage information along with primary and secondary plan information.  When you have an account with more than 100 lines and require the usage and/or plan information, please use the 

<p class="slate-p " ><p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=ValidateAddress" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=ValidateAddress</a></p><p class="slate-p " >
</p><p class="slate-p " >Determines if coverage is available for the given zip code.  We utilized USPS, UPS, and FedEx based on the preference you choose.  This is a setting we manage on your behalf.</p></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p" placeholder="Type / for widgets"><p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=ShipMethod_List" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=ShipMethod_List</a></p><p class="slate-p" placeholder="Type / for widgets">
</p><p class="slate-p" placeholder="Type / for widgets">Lists all shipping options and information for the provided storefront id.</p><p class="slate-p" placeholder="Type / for widgets"></p></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p " ><p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=ValidatePromo" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=ValidatePromo</a></p><p class="slate-p " >
Determines if the promotion code is valid for the storefront id provided.  The promo code will show as invalid if you call the API after the promotion code's expiration date is in the past.</p></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p" placeholder="Type / for widgets"><p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Promotion_FindCodelessPromos" target="_blank">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Promotion_FindCodelessPromos</a></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">
This will list any promotions that are applied based on cart eligibility without a code needing to be entered.  Any promotion codes retrieved by this API will need to be passed back into the *_GetAmount and *_Submit APIs.</p></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p " >You can use this to show the highest credit amount as returned in the GradeACredit response parameter.  We suggest the UI/UX involve displaying a Make dropdown.  Once the Make is chosen, display a Model dropdown.  Once the Model is chosen, display a list of Storage Amounts by GB in ascending order for the Make and Model chosen along with the highest Credit available for each.  Ensure a disclaimer is provided that the Credit is dependent on the condition of the device(s) being returned and the value may change by the time the trade in is received and processed.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

You can use this to show the highest credit amount as returned in the GradeACredit response parameter.  We suggest the UI/UX involve displaying a Make dropdown.  Once the Make is chosen, display a Model dropdown.  Once the Model is chosen, display a list of Storage Amounts by GB in ascending order for the Make and Model chosen along with the highest Credit available for each.  Ensure a disclaimer is provided that the Credit is dependent on the condition of the device(s) being returned and the value may change by the time the trade in is received and processed.

<p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=Order_GetAmount" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=Order_GetAmount</a></p><p class="slate-p " >
</p><p class="slate-p " >Used to calculate taxes and proration, and return a detailed breakdown of the cost of a shopping cart.</p><p class="slate-p " >In order to use the &lt;DeviceFinancing*&gt; parameters to finance products, you must pass in an account number in the &lt;AccountNumber&gt; parameter <em class="slate-italic">(and forgo the &lt;AccountInfo&gt; object)</em> that has been approved for financing using the <a href="https://app.theneo.io/nrtc-mobile-solutions/mdn/createcustomer_withcreditcheck" target="_self">CreateCustomer_WithCreditCheck</a> API.

The <a href="https://app.theneo.io/nrtc-mobile-solutions/mdn/createcustomer_withcreditcheck" target="_self">CreateCustomer_WithCreditCheck</a> API will respond with the account&apos;s total approved spending limit.  

When presenting financing options to the customer ensure you handle when the product&apos;s cost is higher than the approved spending limit.   As a reminder, you&apos;ll get the product price by contract from the <a href="https://app.theneo.io/nrtc-mobile-solutions/ecommerce/create-a-cart-and-order/list-products" target="_self">Product_List</a> API.
Also, ensure that when multiple products are financed that the total is limited to the approved spending limit.

Per cart item, pass the amount being financed in the &lt;DeviceFinancingAmount&gt; request parameter.  Typically the &lt;DeviceFinancingTerms&gt; should be statically set to 36 months and the &lt;DeviceFinancingFirstPaymentAmount&gt; set to 0 to reduce the subscriber&apos;s initial payment.

Lastly, have the user esign the terms of the device financing agreement by typing in their name.  Take their name and pass it in each cart item&apos;s &lt;DeviceFinancingSignature&gt; parameter.</p><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Cart Items:</strong></p><p class="slate-p " >Expand the below Body Parameters section for full details under:</p><p class="slate-p " ><em class="slate-italic">Envelope &gt; Body &gt; Order_GetAmount &gt; cart &gt; CartItems &gt; CartItem</em></p><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Used to calculate taxes and proration, and return a detailed breakdown of the cost of a shopping cart.

In order to use the <DeviceFinancing*> parameters to finance products, you must pass in an account number in the <AccountNumber> parameter 

 that has been approved for financing using the 

 API will respond with the account's total approved spending limit.  

When presenting financing options to the customer ensure you handle when the product's cost is higher than the approved spending limit.   As a reminder, you'll get the product price by contract from the 

 API.
Also, ensure that when multiple products are financed that the total is limited to the approved spending limit.

Per cart item, pass the amount being financed in the <DeviceFinancingAmount> request parameter.  Typically the <DeviceFinancingTerms> should be statically set to 36 months and the <DeviceFinancingFirstPaymentAmount> set to 0 to reduce the subscriber's initial payment.

Lastly, have the user esign the terms of the device financing agreement by typing in their name.  Take their name and pass it in each cart item's <DeviceFinancingSignature> parameter.

Expand the below Body Parameters section for full details under:

Envelope > Body > Order_GetAmount > cart > CartItems > CartItem

<p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=Order_Submit" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=Order_Submit</a></p><p class="slate-p " >
Used to create a new Ecomm Order.  If no account number is passed in, then one will be created using what was provided in the &lt;AccountInfo&gt; object.</p><p class="slate-p " >When testing, please set &lt;UseTestMode&gt; to true to prevent the card from being charged and also set &lt;SendToFulfillment&gt; to false to have our system automatically cancel the order so that it is not actually fulfilled.
</p><p class="slate-p " >Here is the logic flow for this API:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Cart contents validated</div></li><li class="slate-li " ><div style="position:relative">Account created or updated as needed</div></li><li class="slate-li " ><div style="position:relative">Cart totals and taxes calculated</div></li><li class="slate-li " ><div style="position:relative">Credit card charged</div></li><li class="slate-li " ><div style="position:relative">Order Created</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><em class="slate-italic">The line item number is set based on the order in which the items are in the request</em></div></li></ul></li></ul><p class="slate-p " >To help with PCI compliance, you can tokenize the card information on the client side using <a href="https://developer.authorize.net/api/reference/features/acceptjs.html#Using_Your_Own_Payment_Form" target="_self">Accept.JS</a>, then in this API only pass &lt;CIMCustomerProfileId&gt; and &lt;CIMPaymentProfileId&gt; within the &lt;PaymentInfo&gt; object.</p><p class="slate-p " >For the &lt;PortInfo&gt; object, please pass only &lt;BusinessName&gt; or &lt;FirstName&gt; and &lt;LastName&gt;, also only pass two characters for the state.</p><p class="slate-p " >The &lt;NpaNxx&gt; item is optional and can be used to request the new number being activated (not ported) to have a spcific area code (npa) and prefix (nxx) instead of being based on the &lt;CoverageZip&gt;. </p><p class="slate-p " ></p><h3 class="slate-h3 " >Testing</h3><p class="slate-p " >When testing please pass <em class="slate-italic">&lt;UseTestMode&gt;true&lt;/UseTestMode&gt;</em> to prevent charging the card and pass <em class="slate-italic">&lt;SendToFulfillment&gt;false&lt;/SendToFulfillment&gt;</em> to prevent the order from getting fulfilled (this immediatley marks the order as Cancelled).</p><p class="slate-p " ></p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">API Max Order Velocity</strong></h3><p class="slate-p " >We can optionally enable our &quot;API Max Order Velocity&quot; setting to prevent accidental duplicates.  If you&apos;d like this enabled, let us know how many seconds this duplicate order detection time window should be set to. The API order will be blocked if an order has been placed from same IP and email with the same handset products in the cart within the Max Order Velocity.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>


Used to create a new Ecomm Order.  If no account number is passed in, then one will be created using what was provided in the <AccountInfo> object.

When testing, please set <UseTestMode> to true to prevent the card from being charged and also set <SendToFulfillment> to false to have our system automatically cancel the order so that it is not actually fulfilled.


To help with PCI compliance, you can tokenize the card information on the client side using 

, then in this API only pass <CIMCustomerProfileId> and <CIMPaymentProfileId> within the <PaymentInfo> object.

For the <PortInfo> object, please pass only <BusinessName> or <FirstName> and <LastName>, also only pass two characters for the state.

The <NpaNxx> item is optional and can be used to request the new number being activated (not ported) to have a spcific area code (npa) and prefix (nxx) instead of being based on the <CoverageZip>. 

<SendToFulfillment>false</SendToFulfillment>

 to prevent the order from getting fulfilled (this immediatley marks the order as Cancelled).

We can optionally enable our "API Max Order Velocity" setting to prevent accidental duplicates.  If you'd like this enabled, let us know how many seconds this duplicate order detection time window should be set to. The API order will be blocked if an order has been placed from same IP and email with the same handset products in the cart within the Max Order Velocity.

<p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_UpdateShipAddress" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_UpdateShipAddress</a></p><p class="slate-p " >
The shipping address is automatically set to match what is on the existing account or what is passed into the &lt;AccountInfo&gt; object.  If you need the shipping address to be different then you can subsequently call this API.</p><p class="slate-p " >If an order has not yet been shipped or submitted to a 3PL you will be able to update the shipping address of the order.</p><p class="slate-p " >The new Name, Email, and Contact Number fields are optional. You can leave them null/empty and it will leave the values currently on the order as is.

</p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>


The shipping address is automatically set to match what is on the existing account or what is passed into the <AccountInfo> object.  If you need the shipping address to be different then you can subsequently call this API.

If an order has not yet been shipped or submitted to a 3PL you will be able to update the shipping address of the order.

The new Name, Email, and Contact Number fields are optional. You can leave them null/empty and it will leave the values currently on the order as is.



<p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_Get" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_Get</a></p><p class="slate-p " >
Use this to obtain the Order&apos;s status.  Once fulfilled you can retrieve itemized detail on the products contained the order along with any wireless lines tied to them.  Once shipped you can then retrieve the tracking number and shipping carrier and shipping ETA and status while en route in the &lt;Shipments&gt; object.</p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>


Use this to obtain the Order's status.  Once fulfilled you can retrieve itemized detail on the products contained the order along with any wireless lines tied to them.  Once shipped you can then retrieve the tracking number and shipping carrier and shipping ETA and status while en route in the <Shipments> object.

<p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_GetByVendorOrderNumber" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_GetByVendorOrderNumber</a></p><p class="slate-p " ></p><p class="slate-p " >Using the marketplace order ID, this API retrieves itemized detail on the products contained the order along with any wireless lines tied to them and the tracking number and shipping carrier once the item has been shipped.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Using the marketplace order ID, this API retrieves itemized detail on the products contained the order along with any wireless lines tied to them and the tracking number and shipping carrier once the item has been shipped.

<p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_CanCancel" target="_blank">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_CanCancel</a></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14.6667px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14.6667px" class="slate-backgroundColor"></span></span></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14.6667px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14.6667px" class="slate-backgroundColor"></span></span></p><p class="slate-p" placeholder="Type / for widgets">Checks to see if an order can be cancelled to see if the UI should support the end user being able to cancel an order.  Here is the logic behind the API of when orders cannot be cancelled:If the order status is in (Cancelled, Rejected) - it&apos;s already been cancelled.If any of the items have a tracking number - items have already been shipped.If the order has a third party vendor ID tied to it - it&apos;s already been pushed to a third party 3PL.If the order has been checked out for fulfillment in the fulfillment queue - the order is already being processed.
</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Checks to see if an order can be cancelled to see if the UI should support the end user being able to cancel an order.  Here is the logic behind the API of when orders cannot be cancelled:If the order status is in (Cancelled, Rejected) - it's already been cancelled.If any of the items have a tracking number - items have already been shipped.If the order has a third party vendor ID tied to it - it's already been pushed to a third party 3PL.If the order has been checked out for fulfillment in the fulfillment queue - the order is already being processed.


<p class="slate-p " ><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=Order_Cancel" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/EcommServices.asmx?op=Order_Cancel</a></p><p class="slate-p " >
</p><p class="slate-p " >Used to cancel an existing Ecomm Order based on the ID returned in the Order_Submit API’s Order_SubmitResult - &gt; OrderSummary -&gt; OrderNumber response parameter.</p><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Used to cancel an existing Ecomm Order based on the ID returned in the Order_Submit API’s Order_SubmitResult - > OrderSummary -> OrderNumber response parameter.

<p class="slate-p" placeholder="Type / for widgets"><a href="https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_CancelItem" target="_self">https://wirelessprovisioning.com/desktopmodules/telispire.webservices/ecommservices.asmx?op=Order_CancelItem</a></p><p class="slate-p" placeholder="Type / for widgets">
</p><p class="slate-p" placeholder="Type / for widgets">Allows you to cancel an individual item on an order.  This will automatically trigger the &quot;EcommCancelItem&quot; alert type to the customer and add the appropriate credit amount for postpaid customers.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Allows you to cancel an individual item on an order.  This will automatically trigger the "EcommCancelItem" alert type to the customer and add the appropriate credit amount for postpaid customers.

Sections