api/v1/orders/cpe
Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/cpe?testMode={testMode}
Summary
Create a CPE order
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
testMode | boolean |
Default value is False |
Body Parameters
This model contains all of the information required to create a router
CreateCPEOrderModelName | Description | Type | Additional information |
---|---|---|---|
SKU | string |
None. |
|
TariffId | globally unique identifier |
None. |
|
CustomerId | globally unique identifier |
None. |
|
DeliveryAddress |
Specify the order's delivery address details. |
DeliveryAddress |
None. |
SipOverlayContactAddress |
For SIP Overlay orders, specify the contact address details associated the service's telephone number. |
NumberContactAddress |
None. |
DeliveryNotes | string |
None. |
|
RequestedDeliveryDate |
Specify the requested date of order delivery. If not provided, the default is 1 day after dispatch is complete. |
date |
None. |
SIMDefaultEmail | string |
None. |
|
SIMTags | string |
None. |
|
CustomerReference | string |
None. |
|
NumberAreaId |
For SIP Overlay orders, please specify the identifier of the area for the service's telephone number. Use GET endpoint api/v1/orders/numberareas to retrieve Number Area details. |
string |
None. |
PartnerEmailAddress |
For SIP Overlay orders, this is the email address used for receiving partner specific order progress updates. |
string |
None. |
UseDeliveryAddressForNumberContact |
For SIP Overlay orders, this flag indicates whether to re-use the Delivery Address details as the SIP Overlay Contact Address. |
boolean |
None. |
Reason | string |
None. |
Request Formats
application/json, text/json
{ "SKU": "sample string 1", "TariffId": "47b03b6a-de4b-49e3-ad79-798717c027b4", "CustomerId": "3cb85921-8228-4e44-83f3-d09d779b0687", "DeliveryAddress": { "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "ContactPhoneNumber": "sample string 4", "ContactEmail": "sample string 5", "CompanyName": "sample string 6", "PremisesName": "sample string 7", "PremisesNumber": "sample string 8", "PremisesStreet": "sample string 9", "AddressLine2": "sample string 10", "AddressLine3": "sample string 11", "TownCity": "sample string 12", "RegionOrState": "sample string 13", "Country": "sample string 14", "PostCode": "sample string 15" }, "SipOverlayContactAddress": { "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "CompanyName": "sample string 4", "PremisesName": "sample string 5", "PremisesStreet": "sample string 6", "AddressLine2": "sample string 7", "TownCity": "sample string 8", "Country": "sample string 9", "PostCode": "sample string 10", "RegionOrState": "sample string 11" }, "DeliveryNotes": "sample string 3", "RequestedDeliveryDate": "2024-11-14T20:52:09.6146401+00:00", "SIMDefaultEmail": "sample string 5", "SIMTags": "sample string 6", "CustomerReference": "sample string 7", "NumberAreaId": "sample string 8", "PartnerEmailAddress": "sample string 9", "UseDeliveryAddressForNumberContact": true, "Reason": "sample string 11" }
application/xml, text/xml
<CreateCPEOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders"> <Reason>sample string 11</Reason> <CustomerId>3cb85921-8228-4e44-83f3-d09d779b0687</CustomerId> <CustomerReference>sample string 7</CustomerReference> <DeliveryAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/JolaSimPortal.Shared.Models.Orders.OrderDataModels"> <d2p1:AddressLine2>sample string 10</d2p1:AddressLine2> <d2p1:AddressLine3>sample string 11</d2p1:AddressLine3> <d2p1:CompanyName>sample string 6</d2p1:CompanyName> <d2p1:ContactEmail>sample string 5</d2p1:ContactEmail> <d2p1:ContactPhoneNumber>sample string 4</d2p1:ContactPhoneNumber> <d2p1:Country>sample string 14</d2p1:Country> <d2p1:FirstName>sample string 2</d2p1:FirstName> <d2p1:LastName>sample string 3</d2p1:LastName> <d2p1:PostCode>sample string 15</d2p1:PostCode> <d2p1:PremisesName>sample string 7</d2p1:PremisesName> <d2p1:PremisesNumber>sample string 8</d2p1:PremisesNumber> <d2p1:PremisesStreet>sample string 9</d2p1:PremisesStreet> <d2p1:RegionOrState>sample string 13</d2p1:RegionOrState> <d2p1:Title>sample string 1</d2p1:Title> <d2p1:TownCity>sample string 12</d2p1:TownCity> </DeliveryAddress> <DeliveryNotes>sample string 3</DeliveryNotes> <NumberAreaId>sample string 8</NumberAreaId> <PartnerEmailAddress>sample string 9</PartnerEmailAddress> <RequestedDeliveryDate>2024-11-14T20:52:09.6146401+00:00</RequestedDeliveryDate> <SIMDefaultEmail>sample string 5</SIMDefaultEmail> <SIMTags>sample string 6</SIMTags> <SKU>sample string 1</SKU> <SipOverlayContactAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/JolaSimPortal.Shared.Models.Orders.OrderDataModels"> <d2p1:AddressLine2>sample string 7</d2p1:AddressLine2> <d2p1:CompanyName>sample string 4</d2p1:CompanyName> <d2p1:Country>sample string 9</d2p1:Country> <d2p1:FirstName>sample string 2</d2p1:FirstName> <d2p1:LastName>sample string 3</d2p1:LastName> <d2p1:PostCode>sample string 10</d2p1:PostCode> <d2p1:PremisesName>sample string 5</d2p1:PremisesName> <d2p1:PremisesStreet>sample string 6</d2p1:PremisesStreet> <d2p1:RegionOrState>sample string 11</d2p1:RegionOrState> <d2p1:Title>sample string 1</d2p1:Title> <d2p1:TownCity>sample string 8</d2p1:TownCity> </SipOverlayContactAddress> <TariffId>47b03b6a-de4b-49e3-ad79-798717c027b4</TariffId> <UseDeliveryAddressForNumberContact>true</UseDeliveryAddressForNumberContact> </CreateCPEOrderModel>
application/x-www-form-urlencoded
SKU=samplestring&TariffId=value&CustomerId=a1234567-gu1d-3x4m-pl31-e1f2g12345678&DeliveryAddress=value&SipOverlayContactAddress=value&DeliveryNotes=samplestring&RequestedDeliveryDate=11/11/2024 2:00:22 PM&SIMDefaultEmail=samplestring&SIMTags=samplestring&CustomerReference=samplestring&NumberAreaId=samplestring&PartnerEmailAddress=samplestring&UseDeliveryAddressForNumberContact=value&Reason=samplestring
Response Information
Resource Description
OrderResponseModelName | Description | Type | Additional information |
---|---|---|---|
OrderId | globally unique identifier |
None. |
|
Created | date |
None. |
|
State | OrderState |
None. |
Response Formats
application/json, text/json
{ "OrderId": "5eb1a76c-fd04-4a5c-b045-0486d06d62a4", "Created": "2024-11-14T20:52:09.7126468+00:00", "State": 0 }
application/xml, text/xml
<OrderResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders" />